DtSimBaseRadio Class Reference

class DtSimBaseRadio: More...

Inheritance diagram for DtSimBaseRadio:

Public Member Functions
	DtSimBaseRadio ()
	default constructor
	DtSimBaseRadio (DtVrfObject *vrfObject)
	constructor
virtual	~DtSimBaseRadio ()
	destructor
virtual bool	init ()
	This calls createUnitReceiverTransmitter().
virtual bool	isCommand () const =0
virtual void	sendToNet (DtVrfObjectMessage *msg)=0
	Call this to put a message on the net.
virtual bool	isLocal () const =0
	Radio net calls this to deliver a message to this radio.
virtual DtString	type () const =0
	Returns the type of radio object.
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.
virtual void	removeTaskMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0
	Callback which is called for every task message received by this entity.
virtual void	addSetDataMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0
	Callback which is called for every set data message received by this entity.
virtual void	removeSetDataMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0
	Callback which is called for every set data message received by this entity.
virtual void	addReportMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0
	Callback which is called for every report message received by this entity.
virtual void	removeReportMessageCallback (DtMessageCallbackFcn fcn, void *usrData)=0
	Callback which is called for every report message received by this entity.

Protected Attributes
DtVrfObject *	myVrfObject

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

Detailed Description

class DtSimBaseRadio:

DtSimBaseRadio 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

DtSimBaseRadio::DtSimBaseRadio

(

)

default constructor

DtSimBaseRadio::DtSimBaseRadio

(

DtVrfObject *

vrfObject

)

constructor

virtual DtSimBaseRadio::~DtSimBaseRadio ( )

virtual

destructor

DtSimBaseRadio::DtSimBaseRadio ( const DtSimBaseRadio &  orig )

private

copy constructor not implemented.

Member Function Documentation

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

private

assignment operator not implemented.

virtual bool DtSimBaseRadio::init ( )

virtual

This calls createUnitReceiverTransmitter().

Reimplemented in DtCompatibilityRadio.

virtual bool DtSimBaseRadio::isCommand ( ) const

pure virtual

Implemented in DtCompatibilityRadio.

virtual void DtSimBaseRadio::sendToNet ( DtVrfObjectMessage *  msg )

pure virtual

Call this to put a message on the net.

Implemented in DtCompatibilityRadio.

virtual bool DtSimBaseRadio::isLocal ( ) const

pure virtual

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

Implemented in DtCompatibilityRadio.

virtual DtString DtSimBaseRadio::type ( ) const

pure virtual

Returns the type of radio object.

Strings are defined in simRadioTypes.h.

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio, DtCompatibilityRadio, and DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio, DtCompatibilityRadio, and DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio, DtCompatibilityRadio, and DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio, DtCompatibilityRadio, and DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio, DtCompatibilityRadio, and DtCompatibilityRadio.

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

pure virtual

Implemented in DtCompatibilityRadio, DtCompatibilityRadio, and DtCompatibilityRadio.

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

pure virtual

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

Implemented in DtCompatibilityRadio.

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

pure virtual

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

Implemented in DtCompatibilityRadio.

virtual void DtSimBaseRadio::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 DtSimBaseRadio::removeSetDataMessageCallback ( DtMessageCallbackFcn  fcn, void *  usrData  )

pure virtual

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

Implemented in DtCompatibilityRadio.

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

pure virtual

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

Implemented in DtCompatibilityRadio.

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

pure virtual

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

Implemented in DtCompatibilityRadio.

Member Data Documentation

DtVrfObject* DtSimBaseRadio::myVrfObject

protected

---

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

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