VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
DtSendRadioMessageController Class Reference

Developer Description: DtSendRadioMessageController controller registers for and carries out the DtSendTextTask task and the DtSendTaskMessageTask. More...

Inheritance diagram for DtSendRadioMessageController:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSendRadioMessageController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=NULL, DtReaderWriterRegistry *parentRegistry=0)
 constructor
virtual ~DtSendRadioMessageController ()
 destructor
virtual DtString type () const
virtual bool init ()
 Overridden from the base class to call createPSR().
virtual void tick ()
 This gives the thread of control to the component.

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *parentRegistry)
 This is called by the factory.

Protected Member Functions

virtual void registerTaskMsgCallbacks ()
virtual DtVrfRadioradioToUse ()
virtual void executeSendTextTask (const DtSendTextTask *task)
 Sends the text specified in the task using the default radio.
virtual void executeSendTaskMessageTask (const DtSendTaskMessageTask *task)
 Sends the task message specified inside task using the default radio.
virtual void executeSendSetMessageTask (const DtSendSetMessageTask *task)
 Sends the set request specified inside the task using the default radio.

Private Member Functions

 DtSendRadioMessageController (const DtSendRadioMessageController &orig)
DtSendRadioMessageControlleroperator= (const DtSendRadioMessageController &orig)
virtual void processSendTextTask (DtSimMessage *msg)
 Processes the "send text message" task.
static void sendTextTaskCallback (DtSimMessage *msg, void *usr)
 Processes the "send text message" task.
virtual void processSendTaskMessageTask (DtSimMessage *msg)
 Processes the "send task message" task.
static void sendTaskMessageTaskCallback (DtSimMessage *msg, void *usr)
 Processes the "send task message" task.
virtual void processSendSetMessageTask (DtSimMessage *msg)
 Processes the "send set message" task.
static void sendSetMessageTaskCallback (DtSimMessage *msg, void *usr)
 Processes the "send set message" task.
virtual void processTextReport (const DtVrfObjectMessage *msg)
 For debugging only.
static void textReportCallback (const DtVrfObjectMessage *msg, void *usr)
 For debugging only.

Detailed Description

Developer Description: DtSendRadioMessageController controller registers for and carries out the DtSendTextTask task and the DtSendTaskMessageTask.

Uses Descriptor Type: DtComponentDescriptor


Constructor & Destructor Documentation

DtSendRadioMessageController::DtSendRadioMessageController ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = NULL,
DtReaderWriterRegistry parentRegistry = 0 
)

constructor

destructor


Member Function Documentation

DtSendRadioMessageController& DtSendRadioMessageController::operator= ( const DtSendRadioMessageController orig) [private]
virtual DtString DtSendRadioMessageController::type ( ) const [virtual]
Returns:
DtSendRadioMessageControllerType

Implements DtTaskControllerComponent.

Overridden from the base class to call createPSR().

Reimplemented from DtControllerComponent.

virtual void DtSendRadioMessageController::tick ( ) [virtual]

This gives the thread of control to the component.

The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

static DtSimComponent* DtSendRadioMessageController::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc,
DtReaderWriterRegistry parentRegistry 
) [static]

This is called by the factory.

virtual void DtSendRadioMessageController::registerTaskMsgCallbacks ( ) [protected, virtual]

Reimplemented from DtTaskControllerComponent.

virtual DtVrfRadio* DtSendRadioMessageController::radioToUse ( ) [protected, virtual]
Returns:
The radio that will be used to send any messages from this controller. This implementation returns the default radio of the entity.
static void DtSendRadioMessageController::sendTextTaskCallback ( DtSimMessage msg,
void *  usr 
) [static, protected]

Processes the "send text message" task.

virtual void DtSendRadioMessageController::processSendTextTask ( DtSimMessage msg) [protected, virtual]

Processes the "send text message" task.

static void DtSendRadioMessageController::sendTaskMessageTaskCallback ( DtSimMessage msg,
void *  usr 
) [static, protected]

Processes the "send task message" task.

virtual void DtSendRadioMessageController::processSendTaskMessageTask ( DtSimMessage msg) [protected, virtual]

Processes the "send task message" task.

static void DtSendRadioMessageController::sendSetMessageTaskCallback ( DtSimMessage msg,
void *  usr 
) [static, protected]

Processes the "send set message" task.

virtual void DtSendRadioMessageController::processSendSetMessageTask ( DtSimMessage msg) [protected, virtual]

Processes the "send set message" task.

static void DtSendRadioMessageController::textReportCallback ( const DtVrfObjectMessage msg,
void *  usr 
) [static, protected]

For debugging only.

Processes text messages received by this entity and prints out a message.

virtual void DtSendRadioMessageController::processTextReport ( const DtVrfObjectMessage msg) [protected, virtual]

For debugging only.

Processes text messages received by this entity and prints out a message.

virtual void DtSendRadioMessageController::executeSendTextTask ( const DtSendTextTask task) [protected, virtual]

Sends the text specified in the task using the default radio.

virtual void DtSendRadioMessageController::executeSendTaskMessageTask ( const DtSendTaskMessageTask task) [protected, virtual]

Sends the task message specified inside task using the default radio.

virtual void DtSendRadioMessageController::executeSendSetMessageTask ( const DtSendSetMessageTask task) [protected, virtual]

Sends the set request specified inside the task using the default radio.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)