DtSimCommandDistributor Class Reference

Contains the DtSimCommandDistributor class declaration.

DtSimCommandDistributor manages callbacks on sim commands. Sim commands are usually processed once by a registered DtSimCommandExecutor, but the DtSimCommandDistributor allows sim components to do their own processing based on sim commands as well.

Public Types
typedef DtCallbackList< const DtSimCommand & >	DtSimCommandCallbackList
typedef DtSimCommandCallbackList::DtCallbackFunctionType	DtSimCommandCallbackFcn
typedef std::map < DtSimCommandMessageType, DtSimCommandCallbackList >	DtSimCallbackListMap

Public Member Functions
	DtSimCommandDistributor ()
virtual	~DtSimCommandDistributor ()
void	addCallback (DtSimCommandMessageType cmdType, DtSimCommandCallbackFcn fcn, void *usrData)
void	removeCallback (DtSimCommandMessageType cmdType, DtSimCommandCallbackFcn fcn, void *usrData)
void	invokeCallbacks (const DtSimCommand &simCmd)

Protected Member Functions
	DtSimCommandDistributor (const DtSimCommandDistributor &orig)
DtSimCommandDistributor &	operator= (const DtSimCommandDistributor &orig)

Protected Attributes
tbb::spin_rw_mutex	mySimCommandCallbacksMutex
DtSimCallbackListMap	mySimCommandCallbacks

Member Typedef Documentation

typedef DtCallbackList<const DtSimCommand&> DtSimCommandDistributor::DtSimCommandCallbackList

typedef DtSimCommandCallbackList::DtCallbackFunctionType DtSimCommandDistributor::DtSimCommandCallbackFcn

typedef std::map<DtSimCommandMessageType, DtSimCommandCallbackList> DtSimCommandDistributor::DtSimCallbackListMap

Constructor & Destructor Documentation

DtSimCommandDistributor::DtSimCommandDistributor

(

)

default constructor

virtual DtSimCommandDistributor::~DtSimCommandDistributor ( )

virtual

destructor

DtSimCommandDistributor::DtSimCommandDistributor ( const DtSimCommandDistributor &  orig )

protected

copy constructor not implemented

Member Function Documentation

void DtSimCommandDistributor::addCallback	(	DtSimCommandMessageType	cmdType,
		DtSimCommandCallbackFcn	fcn,
		void *	usrData
	)

Adds a new callback for the specified command type.

void DtSimCommandDistributor::removeCallback	(	DtSimCommandMessageType	cmdType,
		DtSimCommandCallbackFcn	fcn,
		void *	usrData
	)

Removes the specified callback for the given command type.

void DtSimCommandDistributor::invokeCallbacks

(

const DtSimCommand &

simCmd

)

Invokes all the callbacks registered for the command type of the given sim command.

DtSimCommandDistributor& DtSimCommandDistributor::operator= ( const DtSimCommandDistributor &  orig )

protected

assignment operator not implemented

Member Data Documentation

tbb::spin_rw_mutex DtSimCommandDistributor::mySimCommandCallbacksMutex

protected

DtSimCallbackListMap DtSimCommandDistributor::mySimCommandCallbacks

protected

---

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

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