DtRadioMessageExecutive Class Reference

File: radioMsgExec.h. More...

Inheritance diagram for DtRadioMessageExecutive:

List of all members.

Public Member Functions
	DtRadioMessageExecutive ()
	default constructor
virtual	~DtRadioMessageExecutive ()
	destructor
	DtRadioMessageExecutive (const DtRadioMessageExecutive &orig)
	copy constructor
DtRadioMessageExecutive &	operator= (const DtRadioMessageExecutive &orig)
	assignment operator
virtual int	indexType (const DtSimMessage &message) const
	Returns the int to be used as index onto the message exec list.
virtual void	processMessage (const DtSimMessage &msg) const
	Overridden from base class to invoke task/set request/report callbacks.
virtual void	addTaskMessageCallback (DtMessageCallbackFcn fcn, void *usr)
	Add/remove callback for any task radio message processed by this message executive.
virtual void	removeTaskMessageCallback (DtMessageCallbackFcn fcn, void *usr)
	Add/remove callback for any task radio message processed by this message executive.
virtual void	addSetDataMessageCallback (DtMessageCallbackFcn fcn, void *usr)
	Add/remove callback for any set data request radio message processed by this message executive.
virtual void	removeSetDataMessageCallback (DtMessageCallbackFcn fcn, void *usr)
	Add/remove callback for any set data request radio message processed by this message executive.
virtual void	addReportMessageCallback (DtMessageCallbackFcn fcn, void *usr)
	Add/remove callback for any report radio message processed by this message executive.
virtual void	removeReportMessageCallback (DtMessageCallbackFcn fcn, void *usr)
	Add/remove callback for any report radio message processed by this message executive.
Protected Types
typedef std::pair < DtMessageCallbackFcn, void * >	DtRadioMessageCallbackInfo
typedef std::list < DtRadioMessageCallbackInfo >	DtRadioMessageCallbackList
Protected Member Functions
virtual void	invokeTaskCallbacks (const DtSimMessage *msg) const
	Invokes all the registered task message callbacks.
virtual void	invokeSetDataCallbacks (const DtSimMessage *msg) const
	Invokes all the registered set data message callbacks.
virtual void	invokeReportCallbacks (const DtSimMessage *msg) const
	Invokes all the registered report message callbacks.
Protected Attributes
DtRadioMessageCallbackList	myTaskCallbackList
DtRadioMessageCallbackList	mySetDataCallbackList
DtRadioMessageCallbackList	myReportCallbackList

---

Detailed Description

File: radioMsgExec.h.

Class: DtRadioMessageExecutive class DtRadioMessageExecutive:

DtRadioMessageExecutive is a message executive that manages callbacks on radio messages: tasks, set data requests, or reports. VR-Forces comes with a built-in ability to simulate radio communication. This should be sufficient for most normal purposes, but if you need to implement your own radio network simulation, you would need to use DtRadioMessageExecutive directly.

---

Member Typedef Documentation

typedef std::pair<DtMessageCallbackFcn, void*> DtRadioMessageExecutive::DtRadioMessageCallbackInfo [protected]

typedef std::list<DtRadioMessageCallbackInfo> DtRadioMessageExecutive::DtRadioMessageCallbackList [protected]

---

Constructor & Destructor Documentation

DtRadioMessageExecutive::DtRadioMessageExecutive

(

)

default constructor

virtual DtRadioMessageExecutive::~DtRadioMessageExecutive

(

)

[virtual]

destructor

DtRadioMessageExecutive::DtRadioMessageExecutive

(

const DtRadioMessageExecutive &

orig

)

copy constructor

---

Member Function Documentation

DtRadioMessageExecutive& DtRadioMessageExecutive::operator=

(

const DtRadioMessageExecutive &

orig

)

assignment operator

virtual int DtRadioMessageExecutive::indexType

(

const DtSimMessage &

message

)

const [virtual]

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

This one returns the task type from a task msg.

Implements DtMessageExecutive.

virtual void DtRadioMessageExecutive::processMessage

(

const DtSimMessage &

msg

)

const [virtual]

Overridden from base class to invoke task/set request/report callbacks.

These callbacks are invoked after and callbacks registered on specific message types with the base DtMessageExecutive.

Reimplemented from DtMessageExecutive.

virtual void DtRadioMessageExecutive::addTaskMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Add/remove callback for any task radio message processed by this message executive.

virtual void DtRadioMessageExecutive::removeTaskMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Add/remove callback for any task radio message processed by this message executive.

virtual void DtRadioMessageExecutive::addSetDataMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Add/remove callback for any set data request radio message processed by this message executive.

virtual void DtRadioMessageExecutive::removeSetDataMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Add/remove callback for any set data request radio message processed by this message executive.

virtual void DtRadioMessageExecutive::addReportMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Add/remove callback for any report radio message processed by this message executive.

virtual void DtRadioMessageExecutive::removeReportMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usr
	)		[virtual]

Add/remove callback for any report radio message processed by this message executive.

virtual void DtRadioMessageExecutive::invokeTaskCallbacks

(

const DtSimMessage *

msg

)

const [protected, virtual]

Invokes all the registered task message callbacks.

virtual void DtRadioMessageExecutive::invokeSetDataCallbacks

(

const DtSimMessage *

msg

)

const [protected, virtual]

Invokes all the registered set data message callbacks.

virtual void DtRadioMessageExecutive::invokeReportCallbacks

(

const DtSimMessage *

msg

)

const [protected, virtual]

Invokes all the registered report message callbacks.

---

Member Data Documentation

DtRadioMessageCallbackList DtRadioMessageExecutive::myTaskCallbackList [protected]

DtRadioMessageCallbackList DtRadioMessageExecutive::mySetDataCallbackList [protected]

DtRadioMessageCallbackList DtRadioMessageExecutive::myReportCallbackList [protected]

---

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

• include/vrfmsgs/radioMsgExec.h