csad::ContainerComponents Class Reference

ContainerComponents - the container class components. More...

Inheritance diagram for csad::ContainerComponents:

Public Member Functions
template<typename T >
_FORCEINLINE T *	addComponent ()
	Adds the component of the specified type in the container if this component already exists, returns available.
_FORCEINLINE Component *	addComponent (char *name)
_FORCEINLINE Component *	addComponent (const char *name)
_FORCEINLINE iterator	begin ()
	The first element of the list of components.
template<typename T >
_FORCEINLINE void	deleteComponent ()
	Detaches the component from the container and remove the component.
_FORCEINLINE iterator	end ()
	The final element of the list component.
_FORCEINLINE void	freeComponents ()
	detaches and removes components
template<typename T >
_FORCEINLINE T *	getComponent ()
	Returns the component of the given type, if it is not in a container returns 0.
_FORCEINLINE Component *	getComponent (void *t)
	Returns the component of the given type, if it is not in a container returns 0.
_FORCEINLINE Component *	getComponent (char *name)
_FORCEINLINE Component *	getComponent (const char *name)
_FORCEINLINE ComponentsMap &	list ()
	Returns list of Components.
virtual CSAD_API void	quit ()
	Transfers control to the nested components quit calling each of them.
template<typename T >
_FORCEINLINE void	removeComponent ()
	Detaches the component from a container.
CSAD_API void *	set (unsigned _int32, void *)
	used for any interface commands.
CSAD_API void *	setComponents (unsigned int id, void *param)
virtual CSAD_API void	start ()
	Transfers control to the nested components start calling each of them.
virtual CSAD_API void	update ()
	Transfers control to the nested components causing update each of them.
Public Member Functions inherited from csad::BaseObject
_FORCEINLINE bool	isContainer ()
	returns true if the object is a container.
_FORCEINLINE ParametersList *	read (ParametersList *data)
	read attributes object.
_FORCEINLINE void *	type ()
	the output pointer to the typeid() of the class.
_FORCEINLINE void	write (ParametersList *data)
	record attributes of the object.

Static Public Member Functions
static CSAD_API int	regClass (const char *name, const void *info, tfSTDCALL_p_FUNC_p fun)

Additional Inherited Members
Public Types inherited from csad::BaseObject
enum	BASE {   ANY = 0x00000000, EVENT = 0x00000001, TYPE = 0x00000002, CONTAINER = 0x00000003,   MANAGER_COUNT = 0x00000004, MANAGER = 0x00000005, WRITE = 0x00000006, READ = 0x00000007,   SELECT = 0x00000008, RUN = 0x00000009, LIST = 0x0000000A, LIST_COUNT = 0x0000000B,   NAME = 0x0000000C, CHILD_NAME = 0x0000000D }
	the basic format of the interface More...

Detailed Description

ContainerComponents - the container class components.

The container has a map of pointers to objects components.

See Also

csad: core

Member Function Documentation

_FORCEINLINE Component* csad::ContainerComponents::addComponent ( char *  name)

inline

Create a component class name and adds it to the container.

Parameters

name	- the name of the component class.

Returns

a new component, or available in the container

_FORCEINLINE Component* csad::ContainerComponents::addComponent ( const char *  name)

inline

Creates a component class name and add it to the container, if the component is already contained in the container is returned to the available component

Parameters

name	- the name of the component class.

Returns

a new component, or available in the container

_FORCEINLINE Component* csad::ContainerComponents::getComponent ( char *  name)

inline

Returns the component of the specified class.

Parameters

name	- the name of the component class.

Returns

the component is available in a container, or null if it is not.

_FORCEINLINE Component* csad::ContainerComponents::getComponent ( const char *  name)

inline

Returns the component of the specified class.

Parameters

name	- the name of the component class.

Returns

the component is available in a container, or null if it is not.

static CSAD_API int csad::ContainerComponents::regClass ( const char *  name, const void *  info, tfSTDCALL_p_FUNC_p  fun  )

static

Registers the component class

Parameters

name	- the class name of the component
info	- the class identifier
fun	- the class identifier

CSAD_API void* csad::ContainerComponents::setComponents	(	unsigned int	id,
		void *	param
	)

Passes the components parameters from the BaseObject::set.

Parameters

id	- id BaseObject::Base
param	- a pointer to a structure parameters.

Returns

depends on id.