DtStringMessageExecutive Class Reference

Inheritance diagram for DtStringMessageExecutive:

Public Types
typedef std::map< DtString, DtMessageCallbackList >	DtStringCallbackMap

Public Member Functions
	DtStringMessageExecutive ()
	default constructor More...
virtual	~DtStringMessageExecutive ()
	destructor More...
virtual void	addMessageCallback (DtString type, DtMessageCallbackFcn fcn, void *usrData)
	Add/Remove a function to be called when a particular message type is received. More...
virtual void	removeMessageCallback (DtString type, DtMessageCallbackFcn fcn, void *usrData)
virtual void	processMessage (const DtSimMessage &msg) const
	Call the callbacks registered for the Radio message's type. More...
virtual int	numCallbacks (DtString type) const
	Get the number of callbacks registered for a radio message type. More...
virtual DtString	messageType (const DtSimMessage &message) const =0
	Returns the string to be used as index onto the message exec list. More...
Public Member Functions inherited from DtMessageExecutive
	DtMessageExecutive ()
	default constructor More...
virtual	~DtMessageExecutive ()
	destructor More...
virtual void	addSimMessageCallback (DtMessageCallbackFcn fcn, void *usrData)
	Add/Remove DtSimMessage callback functions. More...
virtual void	removeSimMessageCallback (DtMessageCallbackFcn fcn, void *usrData)
virtual int	numSimCallbacks () const
	Get the number of sim message callbacks registered. More...

Protected Member Functions
	DtStringMessageExecutive (const DtStringMessageExecutive &orig)
	copy constructor More...
DtStringMessageExecutive &	operator= (const DtStringMessageExecutive &orig)
	assignment operator More...
Protected Member Functions inherited from DtMessageExecutive
	DtMessageExecutive (const DtMessageExecutive &orig)
	copy constructor not implemented More...
DtMessageExecutive &	operator= (const DtMessageExecutive &orig)
	assignment operator not implemented More...

Protected Attributes
DtStringCallbackMap	myStringCallbackMap
Protected Attributes inherited from DtMessageExecutive
std::vector < DtMessageCallbackInfo >	mySimMessageCallbackList

Additional Inherited Members
Static Public Member Functions inherited from DtMessageExecutive
static unsigned	generateMessageId ()
	advances theSplitId and returns the value More...
static unsigned	maximumSignalDataSize ()
	returns the maximum number of bytes that can be sent in a signal interaction's data field. More...
static DtTime	timeoutCheckInterval ()
static void	setTimeoutCheckInterval (DtTime nSecs)
static DtTime	timeoutDuration ()
static void	setTimeoutDuration (DtTime nSecs)
static int	maximumContentSize ()
	returns the maximum number of bytes that can be added to a data interaction, and not overrun the maximum packet buffer size in VR-Link. More...
static void	setMaximumContentSize (int sz)
Static Protected Attributes inherited from DtMessageExecutive
static int	theMaximumContentSize
static unsigned	theMaxSignalDataSize
static unsigned	theSplitId
static DtTime	theTimeoutCheckInterval
static DtTime	theTimeoutDuration

Member Typedef Documentation

typedef std::map<DtString, DtMessageCallbackList > DtStringMessageExecutive::DtStringCallbackMap

Constructor & Destructor Documentation

DtStringMessageExecutive::DtStringMessageExecutive

(

)

default constructor

virtual DtStringMessageExecutive::~DtStringMessageExecutive ( )

virtual

destructor

DtStringMessageExecutive::DtStringMessageExecutive ( const DtStringMessageExecutive &  orig )

protected

copy constructor

Member Function Documentation

virtual void DtStringMessageExecutive::addMessageCallback ( DtString  type, DtMessageCallbackFcn  fcn, void *  usrData  )

virtual

Add/Remove a function to be called when a particular message type is received.

virtual void DtStringMessageExecutive::removeMessageCallback ( DtString  type, DtMessageCallbackFcn  fcn, void *  usrData  )

virtual

virtual void DtStringMessageExecutive::processMessage ( const DtSimMessage &  msg ) const

virtual

Call the callbacks registered for the Radio message's type.

Reimplemented from DtMessageExecutive.

virtual int DtStringMessageExecutive::numCallbacks ( DtString  type ) const

virtual

Get the number of callbacks registered for a radio message type.

virtual DtString DtStringMessageExecutive::messageType ( const DtSimMessage &  message ) const

pure virtual

Returns the string to be used as index onto the message exec list.

For example, to create a TaskMessageExecutive, this function could upcast the simMsg to a task msg, and then return the task()->type().

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

protected

assignment operator

Member Data Documentation

DtStringCallbackMap DtStringMessageExecutive::myStringCallbackMap

protected

---

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

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