DtSimComponentList Class Reference

Class Description: DtSimComponentList.

Instances of DtSimComponentList build and manage a hashlist of DtSimComponents, hashed by name. It can also provide the list of components in sequential form (thanks to a little help from the base sim component itself...)

Inheritance diagram for DtSimComponentList:

Public Types
typedef std::vector < DtSimComponent * >	ComponentListType
typedef ComponentListType::iterator	iterator
typedef ComponentListType::const_iterator	const_iterator

Public Member Functions
	DtSimComponentList (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)
virtual	~DtSimComponentList ()
virtual void	tick (bool hostEntityDestroyed)
virtual DtSimComponent *	lookupComponent (const DtString &name)
virtual std::list < DtSimComponent * >	lookupComponentsByType (const DtString &typeString)
template<typename T_ComponentType >
std::list< DtSimComponent * >	lookupComponentsByDynamicCast () const
virtual void	addComponent (DtSimComponent *component)
virtual void	removeComponent (DtSimComponent *component)
virtual iterator	begin ()
virtual iterator	end ()
virtual size_t	count () const

Protected Types
typedef std::map< DtString, DtSimComponent * >	DtSimComponentMap

Protected Member Functions
	DtSimComponentList ()
virtual void	emptyList ()

Protected Attributes
ComponentListType	myComponentList
DtSimComponentMap	myIndex

Member Typedef Documentation

typedef std::vector<DtSimComponent*> DtSimComponentList::ComponentListType

typedef ComponentListType::iterator DtSimComponentList::iterator

typedef ComponentListType::const_iterator DtSimComponentList::const_iterator

typedef std::map<DtString, DtSimComponent*> DtSimComponentList::DtSimComponentMap

protected

Constructor & Destructor Documentation

DtSimComponentList::DtSimComponentList	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = 0
	)

constructor

virtual DtSimComponentList::~DtSimComponentList ( )

virtual

destructor

DtSimComponentList::DtSimComponentList ( )

protected

default constructor

Member Function Documentation

virtual void DtSimComponentList::tick ( bool  hostEntityDestroyed )

virtual

Ticks each component on the list. If the host entity is destroyed, only components with tickWhileDestroyed() returning true are ticked.

virtual DtSimComponent* DtSimComponentList::lookupComponent ( const DtString &  name )

virtual

virtual std::list<DtSimComponent*> DtSimComponentList::lookupComponentsByType ( const DtString &  typeString )

virtual

template<typename T_ComponentType >

std::list<DtSimComponent*> DtSimComponentList::lookupComponentsByDynamicCast ( ) const

inline

Returns a list of DtSimComponents that can cast to the particular component type.

virtual void DtSimComponentList::addComponent ( DtSimComponent *  component )

virtual

virtual void DtSimComponentList::removeComponent ( DtSimComponent *  component )

virtual

virtual iterator DtSimComponentList::begin ( )

virtual

virtual iterator DtSimComponentList::end ( )

virtual

virtual size_t DtSimComponentList::count ( ) const

virtual

virtual void DtSimComponentList::emptyList ( )

protectedvirtual

Used by the destructor. It removes and DELETES all components on the component list.

Member Data Documentation

ComponentListType DtSimComponentList::myComponentList

protected

DtSimComponentMap DtSimComponentList::myIndex

protected

---

The documentation for this class was generated from the following file:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjcore/simComponentList.h