makVrv::DtSimData Class Reference

The DtSimData is the repository for simulation specific, read only data. More...

Public Types
typedef boost::unordered_map < DtUniqueID, DtSimEntry * >	SimEntryMap
	Map of unique id's to DtSimEntry's. More...
typedef void(*	SignalerAccessorFunction )(DtSimData &)
	The Signaler access function. More...

Public Member Functions
	DtSimData (DtDe &de)
	CTOR. More...
	~DtSimData ()
	DTOR. More...
void	addEntry (DtUniqueID id)
	Create and add a new DtSimObjectEntry to the map. More...
void	removeEntry (DtUniqueID id)
	Remove and a delete a DtSimObjectEntry from the map. More...
bool	addStateToSimEntry (DtUniqueID id, DtSimState *state)
	Add state the DtSimEntry. More...
bool	removeStateFromSimEntry (DtUniqueID id, DtSimState *state)
	Remove state from the DtSimEntry. More...
const DtSimEntry *	findSimEntry (DtUniqueID id) const
	Find DtSimEntry by id. More...
DtSimEntry *	findSimEntry (DtUniqueID id)
	Non-const find for member functions. More...
const SimEntryMap &	simEntryMap ()
	Accessor for the SimEntryMap. More...
void	addStateToSimEvent (DtSimState *state)
	Add state the myEventEntry. More...
void	signalEvent ()
	Emits signal_simEventTriggered with myEventEntry. More...
void	addEventSignaler (SignalerAccessorFunction accessor, DtVirtualBaseClass *instance)
	Add an event signaler, using an accessor function. More...
DtVirtualBaseClass *	findEventSignaler (SignalerAccessorFunction accessor)
	Find an event signaler, using an accessor function. More...

Public Attributes
boost::signal< void(DtSimObjectEntry &)>	signal_simObjectEntryAdded
	Signal emitted when a DtSimObjectEntry is added. More...
boost::signal< void(DtSimObjectEntry &)>	signal_simObjectEntryToBeRemoved
	Signal emitted when a DtSimObjectEntry is about to be removed. More...
boost::signal< void(DtSimObjectEntry &, DtSimState &)>	signal_simStateAdded
	Signal emitted when a DtSimState is added to a DtSimEntry. More...
boost::signal< void(DtSimObjectEntry &, DtSimState &)>	signal_simStateToBeRemoved
	Signal emitted when a DtSimEntry is about to be removed from a DtSimObjectEntry. More...
boost::signal< void(DtSimEventEntry &)>	signal_simEventTriggered
	Signal emitted when a simulation event occurs. More...

Protected Types
typedef boost::unordered_map < SignalerAccessorFunction, DtVirtualBaseClass * >	SignalerMap

Protected Member Functions
DtSimEventEntry &	entry ()
	Get the sim event entry. More...

Protected Attributes
DtDe &	myDe
SimEntryMap	mySimEntryMap
DtSimEventEntry *	myEventEntry
SignalerMap	myEventSignalers

Detailed Description

The DtSimData is the repository for simulation specific, read only data.

The DtSimData has a map of DtSimEntry's indexed by unique id. The DtSimData will also signal when objects have been created/ destroyed or when events happen.

Member Typedef Documentation

typedef boost::unordered_map<DtUniqueID, DtSimEntry*> makVrv::DtSimData::SimEntryMap

Map of unique id's to DtSimEntry's.

typedef void(* makVrv::DtSimData::SignalerAccessorFunction)(DtSimData &)

The Signaler access function.

typedef boost::unordered_map<SignalerAccessorFunction, DtVirtualBaseClass*> makVrv::DtSimData::SignalerMap

protected

Constructor & Destructor Documentation

makVrv::DtSimData::DtSimData

(

DtDe &

de

)

CTOR.

makVrv::DtSimData::~DtSimData

(

)

DTOR.

Member Function Documentation

void makVrv::DtSimData::addEntry

(

DtUniqueID

id

)

Create and add a new DtSimObjectEntry to the map.

void makVrv::DtSimData::removeEntry

(

DtUniqueID

id

)

Remove and a delete a DtSimObjectEntry from the map.

bool makVrv::DtSimData::addStateToSimEntry	(	DtUniqueID	id,
		DtSimState *	state
	)

Add state the DtSimEntry.

The memory is still owned by the DtSimStateObject.

bool makVrv::DtSimData::removeStateFromSimEntry	(	DtUniqueID	id,
		DtSimState *	state
	)

Remove state from the DtSimEntry.

The memory is still owned by the DtSimStateObject.

const DtSimEntry* makVrv::DtSimData::findSimEntry

(

DtUniqueID

id

)

const

Find DtSimEntry by id.

DtSimEntry* makVrv::DtSimData::findSimEntry

(

DtUniqueID

id

)

Non-const find for member functions.

const SimEntryMap& makVrv::DtSimData::simEntryMap

(

)

Accessor for the SimEntryMap.

void makVrv::DtSimData::addStateToSimEvent

(

DtSimState *

state

)

Add state the myEventEntry.

The memory is still owned by the DtSimStateObject.

void makVrv::DtSimData::signalEvent

(

)

Emits signal_simEventTriggered with myEventEntry.

Call after state has been added to it. Clears myEventEntry after the signal has been emitted.

void makVrv::DtSimData::addEventSignaler	(	SignalerAccessorFunction	accessor,
		DtVirtualBaseClass *	instance
	)

Add an event signaler, using an accessor function.

DtVirtualBaseClass* makVrv::DtSimData::findEventSignaler

(

SignalerAccessorFunction

accessor

)

Find an event signaler, using an accessor function.

DtSimEventEntry& makVrv::DtSimData::entry ( )

protected

Get the sim event entry.

Member Data Documentation

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

Signal emitted when a DtSimObjectEntry is added.

Referenced by makVrv::DtSimObjectEntryCollection< T >::DtSimObjectEntryCollection(), makVrv::DtStateViewCollection< T >::DtStateViewCollection(), and makVrv::DtSimObjectEntryCollection< T >::~DtSimObjectEntryCollection().

boost::signal<void (DtSimObjectEntry&)> makVrv::DtSimData::signal_simObjectEntryToBeRemoved

Signal emitted when a DtSimObjectEntry is about to be removed.

Referenced by makVrv::DtSimObjectEntryCollection< T >::DtSimObjectEntryCollection(), makVrv::DtStateViewCollection< T >::DtStateViewCollection(), and makVrv::DtSimObjectEntryCollection< T >::~DtSimObjectEntryCollection().

boost::signal<void (DtSimObjectEntry&, DtSimState&)> makVrv::DtSimData::signal_simStateAdded

Signal emitted when a DtSimState is added to a DtSimEntry.

Referenced by makVrv::DtSimObjectEntryCollection< T >::DtSimObjectEntryCollection(), makVrv::DtStateViewCollection< T >::DtStateViewCollection(), and makVrv::DtSimObjectEntryCollection< T >::~DtSimObjectEntryCollection().

boost::signal<void (DtSimObjectEntry&, DtSimState&)> makVrv::DtSimData::signal_simStateToBeRemoved

Signal emitted when a DtSimEntry is about to be removed from a DtSimObjectEntry.

Referenced by makVrv::DtSimObjectEntryCollection< T >::DtSimObjectEntryCollection(), makVrv::DtStateViewCollection< T >::DtStateViewCollection(), and makVrv::DtSimObjectEntryCollection< T >::~DtSimObjectEntryCollection().

boost::signal<void (DtSimEventEntry&)> makVrv::DtSimData::signal_simEventTriggered

Signal emitted when a simulation event occurs.

DtDe& makVrv::DtSimData::myDe

protected

SimEntryMap makVrv::DtSimData::mySimEntryMap

protected

DtSimEventEntry* makVrv::DtSimData::myEventEntry

protected

SignalerMap makVrv::DtSimData::myEventSignalers

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtSimData.h