DtSimRadio Class Reference

class DtSimRadio: More...

Inheritance diagram for DtSimRadio:

Public Member Functions
	DtSimRadio ()
	default constructor More...
	DtSimRadio (DtVrfObject *vrfObject)
	constructor More...
virtual	~DtSimRadio ()
	destructor More...
virtual bool	init ()
	This calls createUnitReceiverTransmitter(). More...
virtual bool	isCommand () const =0
virtual void	sendToNet (DtVrfObjectMessage *msg)=0
	Call this to put a message on the net. More...
virtual bool	isLocal () const =0
	Radio net calls this to deliver a message to this radio. More...
virtual DtString	type () const =0
	Returns the type of radio object. More...
virtual void	addRadioMessageCallback (const DtAdminContentMessageType &type, DtMessageCallbackFcn fcn, void *usr)=0
virtual void	removeRadioMessageCallback (const DtAdminContentMessageType &type, DtMessageCallbackFcn fcn, void *usr)=0
virtual void	addRadioMessageCallback (const DtSimReportMessageType &type, DtMessageCallbackFcn fcn, void *usr)=0
virtual void	removeRadioMessageCallback (const DtSimReportMessageType &type, DtMessageCallbackFcn fcn, void *usr)=0
virtual void	addRadioMessageCallback (const DtSimTaskMessageType &type, DtMessageCallbackFcn fcn, void *usr)=0
virtual void	removeRadioMessageCallback (const DtSimTaskMessageType &type, DtMessageCallbackFcn fcn, void *usr)=0
virtual void	addRadioMessageCallback (const DtSetMessageType &type, DtMessageCallbackFcn fcn, void *usr)=0
virtual void	removeRadioMessageCallback (const DtSetMessageType &type, DtMessageCallbackFcn fcn, void *usr)=0
virtual void	addTaskMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0
	Callback which is called for every task message received by this entity. More...
virtual void	removeTaskMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0
virtual void	addSetDataMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0
	Callback which is called for every set data message received by this entity. More...
virtual void	removeSetDataMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0
virtual void	addReportMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0
	Callback which is called for every report message received by this entity. More...
virtual void	removeReportMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0

Protected Attributes
DtVrfObject *	myVrfObject

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

Detailed Description

class DtSimRadio:

DtSimRadio is used to send messages to and receive messages from a DtSimRadioNet. This is an abstract base class. Deriving classes must provide an implementation for createUnitReceiverTransmitter() as all radios have at least one of these. (Command radios have an additional command receiver/transmitter).

Constructor & Destructor Documentation

DtSimRadio::DtSimRadio

(

)

default constructor

DtSimRadio::DtSimRadio

(

DtVrfObject *

vrfObject

)

constructor

virtual DtSimRadio::~DtSimRadio ( )

virtual

destructor

DtSimRadio::DtSimRadio ( const DtSimRadio &  orig )

private

copy constructor not implemented.

Member Function Documentation

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

private

assignment operator not implemented.

virtual bool DtSimRadio::init ( )

virtual

This calls createUnitReceiverTransmitter().

Reimplemented in DtCompatibilityRadio.

virtual bool DtSimRadio::isCommand ( ) const

pure virtual

Implemented in DtCompatibilityRadio.

virtual void DtSimRadio::sendToNet ( DtVrfObjectMessage *  msg )

pure virtual

Call this to put a message on the net.

Implemented in DtCompatibilityRadio.

virtual bool DtSimRadio::isLocal ( ) const

pure virtual

Radio net calls this to deliver a message to this radio.

Implemented in DtCompatibilityRadio.

virtual DtString DtSimRadio::type ( ) const

pure virtual

Returns the type of radio object.

Strings are defined in simRadioTypes.h.

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

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

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

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

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

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

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

Member Data Documentation

DtVrfObject* DtSimRadio::myVrfObject

protected

---

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

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