VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
DtSimRadio Class Reference

class DtSimRadio: More...

Inheritance diagram for DtSimRadio:
Inheritance graph
[legend]

Public Member Functions

 DtSimRadio ()
 default constructor
 DtSimRadio (DtVrfObject *vrfObject)
 constructor
virtual ~DtSimRadio ()
 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

 DtSimRadio (const DtSimRadio &orig)
 copy constructor not implemented.
DtSimRadio & operator= (const DtSimRadio &orig)
 assignment operator not implemented.

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, DtCompatibilityRadio, and DtCompatibilityRadio.

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

Implemented in DtCompatibilityRadio, DtCompatibilityRadio, and DtCompatibilityRadio.

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

Implemented in DtCompatibilityRadio, DtCompatibilityRadio, and DtCompatibilityRadio.

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

Implemented in DtCompatibilityRadio, DtCompatibilityRadio, and 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, DtCompatibilityRadio, and DtCompatibilityRadio.

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

Implemented in DtCompatibilityRadio, DtCompatibilityRadio, and 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

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

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

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

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

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

Implemented in DtCompatibilityRadio.

Member Data Documentation

DtVrfObject* DtSimRadio::myVrfObject
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)