DtMessageExecutive Class Reference

class DtMessageExecutive: More...

Inheritance diagram for DtMessageExecutive:

Public Member Functions
	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 void	processMessage (const DtSimMessage &msg) const
	Call the callbacks registered for the Radio message's type. More...
virtual int	numSimCallbacks () const
	Get the number of sim message callbacks registered. More...

Static Public Member Functions
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)

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

Protected Attributes
std::vector < DtMessageCallbackInfo >	mySimMessageCallbackList

Static Protected Attributes
static int	theMaximumContentSize
static unsigned	theMaxSignalDataSize
static unsigned	theSplitId
static DtTime	theTimeoutCheckInterval
static DtTime	theTimeoutDuration

Detailed Description

class DtMessageExecutive:

DtMessageExecutive is an abstract base class. Derived classes are used to manage callbacks on particular message types. For example, as task message executive would have a list of callback lists indexed ty task type. All indices are ints, and are provided to the executive by overriding the pure virtual function indexType().

Constructor & Destructor Documentation

DtMessageExecutive::DtMessageExecutive

(

)

default constructor

virtual DtMessageExecutive::~DtMessageExecutive ( )

virtual

destructor

DtMessageExecutive::DtMessageExecutive ( const DtMessageExecutive &  orig )

protected

copy constructor not implemented

Member Function Documentation

virtual void DtMessageExecutive::addSimMessageCallback ( DtMessageCallbackFcn  fcn, void *  usrData  )

virtual

Add/Remove DtSimMessage callback functions.

virtual void DtMessageExecutive::removeSimMessageCallback ( DtMessageCallbackFcn  fcn, void *  usrData  )

virtual

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

virtual

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

Reimplemented in DtStringMessageExecutive, and DtIntMessageExecutive.

virtual int DtMessageExecutive::numSimCallbacks ( ) const

virtual

Get the number of sim message callbacks registered.

static unsigned DtMessageExecutive::generateMessageId ( )

static

advances theSplitId and returns the value

static int DtMessageExecutive::maximumContentSize ( )

static

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.

static void DtMessageExecutive::setMaximumContentSize ( int  sz )

static

static unsigned DtMessageExecutive::maximumSignalDataSize ( )

static

returns the maximum number of bytes that can be sent in a signal interaction's data field.

static DtTime DtMessageExecutive::timeoutCheckInterval ( )

static

static void DtMessageExecutive::setTimeoutCheckInterval ( DtTime  nSecs )

static

static DtTime DtMessageExecutive::timeoutDuration ( )

static

static void DtMessageExecutive::setTimeoutDuration ( DtTime  nSecs )

static

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

protected

assignment operator not implemented

Member Data Documentation

std::vector<DtMessageCallbackInfo> DtMessageExecutive::mySimMessageCallbackList

protected

int DtMessageExecutive::theMaximumContentSize

staticprotected

unsigned DtMessageExecutive::theMaxSignalDataSize

staticprotected

unsigned DtMessageExecutive::theSplitId

staticprotected

DtTime DtMessageExecutive::theTimeoutCheckInterval

staticprotected

DtTime DtMessageExecutive::theTimeoutDuration

staticprotected

---

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

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