Inheritance diagram for DtCompatibilityRadio:

Public Member Functions
	DtCompatibilityRadio (DtVrfObject *vrfObject)
	constructor
virtual	~DtCompatibilityRadio ()
	destructor
virtual bool	init ()
	This calls createUnitReceiverTransmitter().
virtual bool	isCommand () const
virtual bool	isLocal () const
virtual DtString	type () const
virtual void	addCommandRadioMessageCallback (int type, DtMessageCallbackFcn fcn, void *usrData)
	Calls addRadioMessageCallback().
virtual void	removeCommandRadioMessageCallback (int type, DtMessageCallbackFcn fcn, void *usrData)
	Calls removeRadioMessageCallback().

virtual void	sendToNet (DtSimRadioMessage *msg)
	Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()
virtual void	sendToCommandNet (DtSimRadioMessage *msg)
	Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()
virtual void	sendToAllNets (DtSimRadioMessage *msg)
	Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()

virtual void	setCommandChannel (int v)
	Does nothing. Provided for compile compatibility only.
virtual int	commandChannel () const
	Does nothing. Provided for compile compatibility only.

virtual void	addRadioMessageCallback (int type, DtMessageCallbackFcn fcn, void *usrData)
	Add/remove corresponding callbacks with the DtVrfObjectCommunicationInterface.
virtual void	removeRadioMessageCallback (int type, DtMessageCallbackFcn fcn, void *usrData)
	Add/remove corresponding callbacks with the DtVrfObjectCommunicationInterface.

virtual void	addTaskMessageCallback (DtMessageCallbackFcn fcn, void *usrData)
	Callback which is called for every task message received by this entity.
virtual void	removeTaskMessageCallback (DtMessageCallbackFcn fcn, void *usrData)
	Callback which is called for every task message received by this entity.

virtual void	addSetDataMessageCallback (DtMessageCallbackFcn fcn, void *usrData)
	Callback which is called for every set data message received by this entity.
virtual void	removeSetDataMessageCallback (DtMessageCallbackFcn fcn, void *usrData)
	Callback which is called for every set data message received by this entity.

virtual void	addReportMessageCallback (DtMessageCallbackFcn fcn, void *usrData)
	Callback which is called for every report message received by this entity.
virtual void	removeReportMessageCallback (DtMessageCallbackFcn fcn, void *usrData)
	Callback which is called for every report message received by this entity.
Static Public Member Functions
static DtSimBaseRadio *	create (DtVrfObject vrfObject, DtVrfObjectManager objManager)
static DtCompatibilityRadio *	isCommandChannelRadio (DtSimBaseRadio *radio)
Protected Types
typedef std::pair < DtMessageCallbackFcn, void * >	DtOldStyleCallbackInfo
typedef std::list < DtOldStyleCallbackInfo * >	DtOldStyleCallbackInfoList
Protected Member Functions
virtual DtOldStyleCallbackInfo *	addOldStyleCallbackInfo (DtMessageCallbackFcn fcn, void *usr)
	Creates a new DtOldStyleCallbackInfo structure and adds it to the list.
virtual DtOldStyleCallbackInfo *	findOldStyleCallbackInfo (DtMessageCallbackFcn fcn, void *usr)
	Finds the DtOldStyleCallbackInfo on the list that contains this data and returns a pointer to it.
virtual void	removeAndDeleteOldStyleCallbackInfo (DtOldStyleCallbackInfo *cbInfo)
	Removes the specified callback info structure from the list and deletes the structure.
Static Protected Member Functions
static void	oldStyleConverterCallback (const DtVrfObjectMessage msg, void usr)
	This is the callback for converting new-style callbacks to the old-style DtSimMessage callbacks.
Protected Attributes
DtVrfObjectCommunicationInterface *	myCommInterface
DtOldStyleCallbackInfoList	myOldStyleCallbackInfoList
Private Member Functions
	DtCompatibilityRadio ()
	Not implemented.
	DtCompatibilityRadio (const DtCompatibilityRadio &orig)
	copy constructor not implemented.
DtCompatibilityRadio &	operator= (const DtCompatibilityRadio &orig)
	assignment operator not implemented.

Detailed Description

DtCompatibilityRadio.

A radio subclass that provides a compatibility layer with the old VRF 3.10 radio system and adapts it to the newer DtVrfObjectCommunicationInterface. All calls into this radio result in calls to the DtVrfObjectCommunicationInterface. New code should call the DtVrfObjectCommunicationInterface directly instead of relying on this radio class. Many of the calls to this have no result, but are in place to provide compatibility with code that was previously using the DtChannelRadio or DtCommandChannelRadio.

Deprecated:: To be removed after VR-Forces version 3.11

Member Typedef Documentation

typedef std::pair<DtMessageCallbackFcn, void*> DtCompatibilityRadio::DtOldStyleCallbackInfo [protected]

typedef std::list<DtOldStyleCallbackInfo*> DtCompatibilityRadio::DtOldStyleCallbackInfoList [protected]

Constructor & Destructor Documentation

DtCompatibilityRadio::DtCompatibilityRadio ( DtVrfObject * vrfObject )

constructor

virtual DtCompatibilityRadio::~DtCompatibilityRadio ( ) [virtual]

destructor

DtCompatibilityRadio::DtCompatibilityRadio ( ) [private]

Not implemented.

DtCompatibilityRadio::DtCompatibilityRadio ( const DtCompatibilityRadio & orig ) [private]

copy constructor not implemented.

Member Function Documentation

DtCompatibilityRadio& DtCompatibilityRadio::operator= ( const DtCompatibilityRadio & orig ) [private]

assignment operator not implemented.

virtual bool DtCompatibilityRadio::init ( ) [virtual]

This calls createUnitReceiverTransmitter().

Reimplemented from DtSimBaseRadio.

virtual bool DtCompatibilityRadio::isCommand ( ) const [virtual]

Returns:: True. For old API compatibility only.

Implements DtSimBaseRadio.

virtual void DtCompatibilityRadio::sendToNet ( DtSimRadioMessage * msg ) [virtual]

Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()

Implements DtSimBaseRadio.

virtual void DtCompatibilityRadio::sendToCommandNet ( DtSimRadioMessage * msg ) [virtual]

Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()

virtual void DtCompatibilityRadio::sendToAllNets ( DtSimRadioMessage * msg ) [virtual]

Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()

virtual void DtCompatibilityRadio::setCommandChannel ( int v ) [inline, virtual]

Does nothing. Provided for compile compatibility only.

virtual int DtCompatibilityRadio::commandChannel ( ) const [inline, virtual]

Does nothing. Provided for compile compatibility only.

virtual bool DtCompatibilityRadio::isLocal ( ) const [virtual]

Returns:: True.

Implements DtSimBaseRadio.

virtual DtString DtCompatibilityRadio::type ( ) const [virtual]

Returns:: DtCompatibilityRadioType

Implements DtSimBaseRadio.

virtual void DtCompatibilityRadio::addRadioMessageCallback	(	int	type,
		DtMessageCallbackFcn	fcn,
		void *	usrData
	)		`[virtual]`

Add/remove corresponding callbacks with the DtVrfObjectCommunicationInterface.

Implements DtSimBaseRadio.

virtual void DtCompatibilityRadio::removeRadioMessageCallback	(	int	type,
		DtMessageCallbackFcn	fcn,
		void *	usrData
	)		`[virtual]`

Add/remove corresponding callbacks with the DtVrfObjectCommunicationInterface.

Implements DtSimBaseRadio.

virtual void DtCompatibilityRadio::addCommandRadioMessageCallback	(	int	type,
		DtMessageCallbackFcn	fcn,
		void *	usrData
	)		`[virtual]`

Calls addRadioMessageCallback().

virtual void DtCompatibilityRadio::removeCommandRadioMessageCallback	(	int	type,
		DtMessageCallbackFcn	fcn,
		void *	usrData
	)		`[virtual]`

Calls removeRadioMessageCallback().

virtual void DtCompatibilityRadio::addTaskMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usrData
	)		`[virtual]`

Callback which is called for every task message received by this entity.

Implements DtSimBaseRadio.

virtual void DtCompatibilityRadio::removeTaskMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usrData
	)		`[virtual]`

Callback which is called for every task message received by this entity.

Implements DtSimBaseRadio.

virtual void DtCompatibilityRadio::addSetDataMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usrData
	)		`[virtual]`

Callback which is called for every set data message received by this entity.

Implements DtSimBaseRadio.

virtual void DtCompatibilityRadio::removeSetDataMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usrData
	)		`[virtual]`

Callback which is called for every set data message received by this entity.

Implements DtSimBaseRadio.

virtual void DtCompatibilityRadio::addReportMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usrData
	)		`[virtual]`

Callback which is called for every report message received by this entity.

Implements DtSimBaseRadio.

virtual void DtCompatibilityRadio::removeReportMessageCallback	(	DtMessageCallbackFcn	fcn,
		void *	usrData
	)		`[virtual]`

Callback which is called for every report message received by this entity.

Implements DtSimBaseRadio.

static DtSimBaseRadio* DtCompatibilityRadio::create	(	DtVrfObject *	vrfObject,
		DtVrfObjectManager *	objManager
	)		`[static]`

static DtCompatibilityRadio* DtCompatibilityRadio::isCommandChannelRadio ( DtSimBaseRadio * radio ) [static]

Returns:: The radio dynamic_casted to the DtCompatibilityRadio.

static void DtCompatibilityRadio::oldStyleConverterCallback	(	const DtVrfObjectMessage *	msg,
		void *	usr
	)		`[static, protected]`

This is the callback for converting new-style callbacks to the old-style DtSimMessage callbacks.

virtual DtOldStyleCallbackInfo* DtCompatibilityRadio::addOldStyleCallbackInfo	(	DtMessageCallbackFcn	fcn,
		void *	usr
	)		`[protected, virtual]`

Creates a new DtOldStyleCallbackInfo structure and adds it to the list.

Returns:: A pointer to the newly created structure.

virtual DtOldStyleCallbackInfo* DtCompatibilityRadio::findOldStyleCallbackInfo	(	DtMessageCallbackFcn	fcn,
		void *	usr
	)		`[protected, virtual]`

Finds the DtOldStyleCallbackInfo on the list that contains this data and returns a pointer to it.

virtual void DtCompatibilityRadio::removeAndDeleteOldStyleCallbackInfo ( DtOldStyleCallbackInfo * cbInfo ) [protected, virtual]

Removes the specified callback info structure from the list and deletes the structure.

Member Data Documentation

DtVrfObjectCommunicationInterface* DtCompatibilityRadio::myCommInterface [protected]

DtOldStyleCallbackInfoList DtCompatibilityRadio::myOldStyleCallbackInfoList [protected]

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

include/vrfobjcore/compatibilityRadio.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation