DtCompatibilityRadio Class Reference

DtCompatibilityRadio. More...

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
template<typename messageType >
void	addCommandRadioMessageCallback (const messageType &mType, DtMessageCallbackFcn fcn, void *usr)
template<typename messageType >
void	removeCommandRadioMessageCallback (const messageType &mType, DtMessageCallbackFcn fcn, void *usr)
virtual void	addRadioMessageCallback (const DtAdminContentMessageType &type, DtMessageCallbackFcn fcn, void *usr)
virtual void	removeRadioMessageCallback (const DtAdminContentMessageType &type, DtMessageCallbackFcn fcn, void *usr)
virtual void	addRadioMessageCallback (const DtSimReportMessageType &type, DtMessageCallbackFcn fcn, void *usr)
virtual void	removeRadioMessageCallback (const DtSimReportMessageType &type, DtMessageCallbackFcn fcn, void *usr)
virtual void	addRadioMessageCallback (const DtSimTaskMessageType &type, DtMessageCallbackFcn fcn, void *usr)
virtual void	removeRadioMessageCallback (const DtSimTaskMessageType &type, DtMessageCallbackFcn fcn, void *usr)
virtual void	addRadioMessageCallback (const DtSetMessageType &type, DtMessageCallbackFcn fcn, void *usr)
virtual void	removeRadioMessageCallback (const DtSetMessageType &type, DtMessageCallbackFcn fcn, void *usr)
virtual void	sendToNet (DtVrfObjectMessage *msg)
	Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()
virtual void	sendToCommandNet (DtVrfObjectMessage *msg)
	Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()
virtual void	sendToAllNets (DtVrfObjectMessage *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.
template<typename messageType >
void	addMessageCallback (const messageType &mType, DtMessageCallbackFcn fcn, void *usr)
	//! Add/remove corresponding callbacks with the DtVrfObjectCommunicationInterface.
template<typename messageType >
void	removeMessageCallback (const messageType &mType, DtMessageCallbackFcn fcn, void *usr)
	//! 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.
Public Member Functions inherited from DtSimRadio
	DtSimRadio ()
	default constructor
	DtSimRadio (DtVrfObject *vrfObject)
	constructor
virtual	~DtSimRadio ()
	destructor

Static Public Member Functions
static DtSimRadio *	create (DtVrfObject *vrfObject, DtVrfObjectManager *objManager)
static DtCompatibilityRadio *	isCommandChannelRadio (DtSimRadio *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
Protected Attributes inherited from DtSimRadio
DtVrfObject *	myVrfObject

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 DtSimRadio.

virtual bool DtCompatibilityRadio::isCommand ( ) const

virtual

Returns

True. For old API compatibility only.

Implements DtSimRadio.

virtual void DtCompatibilityRadio::sendToNet ( DtVrfObjectMessage *  msg )

virtual

Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()

Implements DtSimRadio.

virtual void DtCompatibilityRadio::sendToCommandNet ( DtVrfObjectMessage *  msg )

virtual

Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()

virtual void DtCompatibilityRadio::sendToAllNets ( DtVrfObjectMessage *  msg )

virtual

Calls DtVrfObjectCommunicationInterface::sendInternalSimMessage()

virtual void DtCompatibilityRadio::setCommandChannel ( int  v )

inlinevirtual

Does nothing. Provided for compile compatibility only.

virtual int DtCompatibilityRadio::commandChannel ( ) const

inlinevirtual

Does nothing. Provided for compile compatibility only.

virtual bool DtCompatibilityRadio::isLocal ( ) const

virtual

Returns

True.

Implements DtSimRadio.

virtual DtString DtCompatibilityRadio::type ( ) const

virtual

Returns

DtCompatibilityRadioType

Implements DtSimRadio.

template<typename messageType >

void DtCompatibilityRadio::addMessageCallback ( const messageType &  mType, DtMessageCallbackFcn  fcn, void *  usr  )

inline

//! Add/remove corresponding callbacks with the DtVrfObjectCommunicationInterface.

//

template<typename messageType >

void DtCompatibilityRadio::removeMessageCallback ( const messageType &  mType, DtMessageCallbackFcn  fcn, void *  usr  )

inline

//! Add/remove corresponding callbacks with the DtVrfObjectCommunicationInterface.

//

template<typename messageType >

void DtCompatibilityRadio::addCommandRadioMessageCallback ( const messageType &  mType, DtMessageCallbackFcn  fcn, void *  usr  )

inline

template<typename messageType >

void DtCompatibilityRadio::removeCommandRadioMessageCallback ( const messageType &  mType, DtMessageCallbackFcn  fcn, void *  usr  )

inline

virtual void DtCompatibilityRadio::addRadioMessageCallback ( const DtAdminContentMessageType &  type, DtMessageCallbackFcn  fcn, void *  usr  )

virtual

Implements DtSimRadio.

virtual void DtCompatibilityRadio::removeRadioMessageCallback ( const DtAdminContentMessageType &  type, DtMessageCallbackFcn  fcn, void *  usr  )

virtual

Implements DtSimRadio.

virtual void DtCompatibilityRadio::addRadioMessageCallback ( const DtSimReportMessageType &  type, DtMessageCallbackFcn  fcn, void *  usr  )

virtual

Implements DtSimRadio.

virtual void DtCompatibilityRadio::removeRadioMessageCallback ( const DtSimReportMessageType &  type, DtMessageCallbackFcn  fcn, void *  usr  )

virtual

Implements DtSimRadio.

virtual void DtCompatibilityRadio::addRadioMessageCallback ( const DtSimTaskMessageType &  type, DtMessageCallbackFcn  fcn, void *  usr  )

virtual

Implements DtSimRadio.

virtual void DtCompatibilityRadio::removeRadioMessageCallback ( const DtSimTaskMessageType &  type, DtMessageCallbackFcn  fcn, void *  usr  )

virtual

Implements DtSimRadio.

virtual void DtCompatibilityRadio::addRadioMessageCallback ( const DtSetMessageType &  type, DtMessageCallbackFcn  fcn, void *  usr  )

virtual

Implements DtSimRadio.

virtual void DtCompatibilityRadio::removeRadioMessageCallback ( const DtSetMessageType &  type, DtMessageCallbackFcn  fcn, void *  usr  )

virtual

Implements DtSimRadio.

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

virtual

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

Implements DtSimRadio.

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

virtual

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

Implements DtSimRadio.

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

virtual

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

Implements DtSimRadio.

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

virtual

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

Implements DtSimRadio.

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

virtual

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

Implements DtSimRadio.

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

virtual

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

Implements DtSimRadio.

static DtSimRadio* DtCompatibilityRadio::create ( DtVrfObject *  vrfObject, DtVrfObjectManager *  objManager  )

static

static DtCompatibilityRadio* DtCompatibilityRadio::isCommandChannelRadio ( DtSimRadio *  radio )

static

Returns

The radio dynamic_casted to the DtCompatibilityRadio.

static void DtCompatibilityRadio::oldStyleConverterCallback ( const DtVrfObjectMessage *  msg, void *  usr  )

staticprotected

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

virtual DtOldStyleCallbackInfo* DtCompatibilityRadio::addOldStyleCallbackInfo ( DtMessageCallbackFcn  fcn, void *  usr  )

protectedvirtual

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  )

protectedvirtual

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

virtual void DtCompatibilityRadio::removeAndDeleteOldStyleCallbackInfo ( DtOldStyleCallbackInfo *  cbInfo )

protectedvirtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/compatibilityRadio.h