DtSimComponentList Class Reference

Class Description: DtSimComponentList. More...

Inheritance diagram for DtSimComponentList:

List of all members.

Public Member Functions
	DtSimComponentList (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)
	constructor
virtual	~DtSimComponentList ()
	destructor
virtual void	tick (bool hostEntityDestroyed)
	Ticks each component on the list.
virtual DtSimComponent *	lookupComponent (const DtString &name)
virtual void	addComponent (DtSimComponent *component)
virtual void	removeComponent (DtSimComponent *component)
virtual DtSimComponent *	firstComponent ()
virtual DtSimComponent *	lastComponent ()
Protected Types
typedef std::map< DtString, DtSimComponent * >	DtSimComponentMap
Protected Member Functions
	DtSimComponentList ()
	default constructor
virtual void	emptyList ()
	Used by the destructor.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Constructs a component, and then reads relevant data from the stream.
Protected Attributes
DtSimComponentMap	myIndex

---

Detailed Description

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...)

---

Member Typedef Documentation

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 void DtSimComponentList::addComponent

(

DtSimComponent *

component

)

[virtual]

virtual void DtSimComponentList::removeComponent

(

DtSimComponent *

component

)

[virtual]

virtual DtSimComponent* DtSimComponentList::firstComponent

(

)

[virtual]

virtual DtSimComponent* DtSimComponentList::lastComponent

(

)

[virtual]

virtual void DtSimComponentList::emptyList

(

)

[protected, virtual]

Used by the destructor.

It removes and DELETES all components on the component list.

virtual DtlObjPtr DtSimComponentList::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[protected, virtual]

Constructs a component, and then reads relevant data from the stream.

Implements DtRwList.

---

Member Data Documentation

DtSimComponentMap DtSimComponentList::myIndex [protected]

---

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

• include/vrfobjcore/cmpntList.h