makVrv::DtSimObjectEntryCollection< T > Class Template Reference

A DtSimObjectEntryCollection is a collection of DtSimObjectEntry's that have a specific state. More...

Public Types
typedef std::map< DtUniqueID, DtSimObjectEntry * >	SimObjectEntryMap
	Map of unique id's to DtSimObjectEntry's.

Public Member Functions
	DtSimObjectEntryCollection (DtDe &de)
	CTOR.
virtual	~DtSimObjectEntryCollection ()
	DTOR.
size_t	size () const
	Return the number of the objects in the container.
const SimObjectEntryMap &	simObjectEntryMap () const
	Return the map of DtSimObjectEntry's in this collection.
const DtSimObjectEntry *	findSimObjectEntry (DtUniqueID id) const
	Find DtSimEntry by id.

Public Attributes
boost::signal< void(DtSimObjectEntry &)>	signal_simObjectEntryAdded
	Signal emitted when a DtSimObjectEntry is added.
boost::signal< void(DtSimObjectEntry &)>	signal_simObjectEntryAboutToBeRemoved
	Signal emitted when a DtSimObjectEntry is about to be removed.

Protected Member Functions
void	onSimObjectEntryAdded (DtSimObjectEntry &entry)
	Called when a DtSimObjectEntry is added.
void	onSimObjectEntryAboutToBeRemoved (DtSimObjectEntry &entry)
	Called when a DtSimObjectEntry is about to be removed.
void	onSimObjectStateEntryAdded (DtSimObjectEntry &entry, DtSimState &)
	Called when a DtSimState is added to a DtSimObjectEntry.
void	onSimObjectStateEntryAboutToBeRemoved (DtSimObjectEntry &entry, DtSimState &)
	Called when a DtSimState is about to be removed from a DtSimObjectEntry.
bool	isCompatible (DtSimObjectEntry &entry)
	Returns true if the DtSimEntry contains a state of type T.
bool	isCompatible (DtSimState &entry)
	Returns true if the DtSimState is of type T.
void	populateFromExistingEntries ()
	Go through existing DtSimEntry's and populate this container.

Protected Attributes
DtDe &	myDe
SimObjectEntryMap	mySimObjectEntryMap

Private Member Functions
	DtSimObjectEntryCollection ()
	Protected CTOR.
	DtSimObjectEntryCollection (const DtSimObjectEntryCollection &)
DtSimObjectEntryCollection &	operator= (const DtSimObjectEntryCollection &)

Detailed Description

template<class T>
class makVrv::DtSimObjectEntryCollection< T >

A DtSimObjectEntryCollection is a collection of DtSimObjectEntry's that have a specific state.

Member Typedef Documentation

template<class T >

typedef std::map<DtUniqueID, DtSimObjectEntry*> makVrv::DtSimObjectEntryCollection< T >::SimObjectEntryMap

Map of unique id's to DtSimObjectEntry's.

Constructor & Destructor Documentation

template<class T >

makVrv::DtSimObjectEntryCollection< T >::DtSimObjectEntryCollection

(

DtDe &

de

)

CTOR.

Connects to DtSimData for signals about DtSimObjectEntry and DtSimState changes.

References makVrv::bind(), makVrv::DtDe::dataBank(), makVrv::DtSimObjectEntryCollection< T >::myDe, makVrv::DtSimObjectEntryCollection< T >::populateFromExistingEntries(), makVrv::DtSimData::signal_simObjectEntryAdded, makVrv::DtSimData::signal_simObjectEntryToBeRemoved, makVrv::DtSimData::signal_simStateAdded, makVrv::DtSimData::signal_simStateToBeRemoved, and makVrv::DtDataBank::simData().

template<class T >

makVrv::DtSimObjectEntryCollection< T >::~DtSimObjectEntryCollection ( )

virtual

DTOR.

References makVrv::bind(), makVrv::DtSimData::signal_simObjectEntryAdded, makVrv::DtSimData::signal_simObjectEntryToBeRemoved, makVrv::DtSimData::signal_simStateAdded, and makVrv::DtSimData::signal_simStateToBeRemoved.

template<class T >

makVrv::DtSimObjectEntryCollection< T >::DtSimObjectEntryCollection ( )

private

Protected CTOR.

template<class T >

makVrv::DtSimObjectEntryCollection< T >::DtSimObjectEntryCollection ( const DtSimObjectEntryCollection< T > &  )

private

Member Function Documentation

template<class T >

size_t makVrv::DtSimObjectEntryCollection< T >::size

(

)

const

Return the number of the objects in the container.

template<class T >

const DtSimObjectEntryCollection< T >::SimObjectEntryMap & makVrv::DtSimObjectEntryCollection< T >::simObjectEntryMap

(

)

const

Return the map of DtSimObjectEntry's in this collection.

template<class T >

const DtSimObjectEntry * makVrv::DtSimObjectEntryCollection< T >::findSimObjectEntry

(

DtUniqueID

id

)

const

Find DtSimEntry by id.

template<class T >

void makVrv::DtSimObjectEntryCollection< T >::onSimObjectEntryAdded ( DtSimObjectEntry &  entry )

protected

Called when a DtSimObjectEntry is added.

References makVrv::DtSimEntry::id().

template<class T >

void makVrv::DtSimObjectEntryCollection< T >::onSimObjectEntryAboutToBeRemoved ( DtSimObjectEntry &  entry )

protected

Called when a DtSimObjectEntry is about to be removed.

References makVrv::DtSimEntry::id().

template<class T >

void makVrv::DtSimObjectEntryCollection< T >::onSimObjectStateEntryAdded ( DtSimObjectEntry &  entry, DtSimState &  state  )

protected

Called when a DtSimState is added to a DtSimObjectEntry.

References makVrv::DtSimEntry::id().

template<class T >

void makVrv::DtSimObjectEntryCollection< T >::onSimObjectStateEntryAboutToBeRemoved ( DtSimObjectEntry &  entry, DtSimState &  state  )

protected

Called when a DtSimState is about to be removed from a DtSimObjectEntry.

References makVrv::DtSimEntry::id().

template<class T >

bool makVrv::DtSimObjectEntryCollection< T >::isCompatible ( DtSimObjectEntry &  entry )

protected

Returns true if the DtSimEntry contains a state of type T.

References makVrv::DtStateView< StateType >::isCompatible().

template<class T >

bool makVrv::DtSimObjectEntryCollection< T >::isCompatible ( DtSimState &  entry )

protected

Returns true if the DtSimState is of type T.

References makVrv::DtStateView< StateType >::isCompatible().

template<class T >

void makVrv::DtSimObjectEntryCollection< T >::populateFromExistingEntries ( )

protected

Go through existing DtSimEntry's and populate this container.

Referenced by makVrv::DtSimObjectEntryCollection< T >::DtSimObjectEntryCollection().

template<class T >

DtSimObjectEntryCollection& makVrv::DtSimObjectEntryCollection< T >::operator= ( const DtSimObjectEntryCollection< T > &  )

private

Member Data Documentation

template<class T >

boost::signal<void (DtSimObjectEntry&)> makVrv::DtSimObjectEntryCollection< T >::signal_simObjectEntryAdded

Signal emitted when a DtSimObjectEntry is added.

template<class T >

boost::signal<void (DtSimObjectEntry&)> makVrv::DtSimObjectEntryCollection< T >::signal_simObjectEntryAboutToBeRemoved

Signal emitted when a DtSimObjectEntry is about to be removed.

template<class T >

DtDe& makVrv::DtSimObjectEntryCollection< T >::myDe

protected

Referenced by makVrv::DtSimObjectEntryCollection< T >::DtSimObjectEntryCollection().

template<class T >

SimObjectEntryMap makVrv::DtSimObjectEntryCollection< T >::mySimObjectEntryMap

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvCore/DtSimObjectEntryCollection.h