![]() |
VR-Forces 4.0.4 Class Documentation
|

Classes | |
| struct | DtClearToReceiveData |
Public Member Functions | |
| virtual | ~DtExternalCommModel () |
| virtual DtString | type () const |
| virtual void | registerRadio (DtVrfRadio *radio) |
| Overridden to set ReadyToSend on the radio to true if the model is not using external ready to send signals. | |
| virtual void | sendMessage (DtVrfObjectMessage *message, DtVrfRadio *sendingRadio) |
| Send this message if/when the external comms server indicates that it should be sent. | |
| virtual void | tick () |
| Delivers any messages that have been approved for delivery and are on the queue. | |
Static Public Member Functions | |
| static DtCommModel * | create (DtCommModelCreationParams ¶ms) |
| Static creator function that can be registered with factories. | |
Protected Types | |
| typedef std::map< DtU32, DtVrfObjectMessageConstPtr > | DtRadioMessageMap |
| typedef std::deque < DtClearToReceiveData > | DtClearToReceiveDeque |
| This holds messages that have been cleared for sending by the external comms server. | |
| typedef std::map< DtU32, DtExternalCommsProcessMessageData > | DtExternalCommsMessageDataMap |
| This holds information for Qualnet clear to receive, if the transporter hasn't finished collecting all message parts. | |
| typedef std::map< DtU32, DtExternalCommsTimeoutData > | DtExternalCommsTimeoutMap |
| This holds information for Qualnet timeout, if the transporter hasn't finished collecting all message parts. | |
Protected Member Functions | |
| DtExternalCommModel (DtCommModelCreationParams ¶ms) | |
| Use the create() method instead of calling the constructor. | |
| virtual bool | init () |
| Virtual init() called from the create() method. | |
| virtual DtU32 | nextMessageId (const DtEntityIdentifier &entityId) |
| virtual void | passMessageToReceiver (DtVrfObjectMessageConstPtr, const DtEntityIdentifier &receiver) |
| Gives the message to the indicated receiver. | |
| virtual void | processMessageClearToReceive (const DtExternalCommsProcessMessageData &data) |
| virtual void | processMessageTimeout (const DtExternalCommsTimeoutData &data) |
| virtual void | processNewMessage (const DtExternalCommsMessageTransporter::DtExternalCommsMessageCallbackParams ¶ms) |
| virtual void | processReadyToSend (const DtExternalCommsReadyToSendData &data) |
Static Protected Member Functions | |
| static void | messageClearToReceiveCallback (const DtExternalCommsProcessMessageData &data, void *usr) |
| static void | messageTimeoutCallback (const DtExternalCommsTimeoutData &data, void *usr) |
| static void | newMessageCallback (const DtExternalCommsMessageTransporter::DtExternalCommsMessageCallbackParams ¶ms, void *usr) |
| static void | readyToSendCallback (const DtExternalCommsReadyToSendData &data, void *usr) |
Protected Attributes | |
| DtU32 | myLastMessageId |
| DtRadioMessageMap | mySentMessages |
| Contains all the message that have been sent, but are awaiting authorization from the external comms server. | |
| DtExternalCommsMessageTransporter * | myTransporter |
| DtClearToReceiveDeque | myClearToReceiveDeque |
| const DtExternalCommModelDescriptor * | myExternalCommModelDescriptor |
| DtExternalCommsMessageDataMap | myWaitingForMessageMap |
| DtExternalCommsTimeoutMap | myTimedOutMessageMap |
Private Member Functions | |
| DtExternalCommModel () | |
| Not implemented. | |
| DtExternalCommModel (const DtExternalCommModel &orig) | |
| Not implemented. | |
| DtExternalCommModel & | operator= (const DtExternalCommModel &orig) |
| Not implemented. | |
typedef std::map<DtU32, DtVrfObjectMessageConstPtr> DtExternalCommModel::DtRadioMessageMap [protected] |
typedef std::deque<DtClearToReceiveData> DtExternalCommModel::DtClearToReceiveDeque [protected] |
This holds messages that have been cleared for sending by the external comms server.
The messages will not be sent until the next tick of the propagator.
typedef std::map<DtU32, DtExternalCommsProcessMessageData> DtExternalCommModel::DtExternalCommsMessageDataMap [protected] |
This holds information for Qualnet clear to receive, if the transporter hasn't finished collecting all message parts.
typedef std::map<DtU32, DtExternalCommsTimeoutData> DtExternalCommModel::DtExternalCommsTimeoutMap [protected] |
This holds information for Qualnet timeout, if the transporter hasn't finished collecting all message parts.
| DtExternalCommModel::DtExternalCommModel | ( | ) | [private] |
Not implemented.
| DtExternalCommModel::DtExternalCommModel | ( | const DtExternalCommModel & | orig | ) | [private] |
Not implemented.
| DtExternalCommModel::DtExternalCommModel | ( | DtCommModelCreationParams & | params | ) | [protected] |
Use the create() method instead of calling the constructor.
| virtual DtExternalCommModel::~DtExternalCommModel | ( | ) | [virtual] |
| DtExternalCommModel& DtExternalCommModel::operator= | ( | const DtExternalCommModel & | orig | ) | [private] |
Not implemented.
| virtual bool DtExternalCommModel::init | ( | ) | [protected, virtual] |
Virtual init() called from the create() method.
Reimplemented from DtCommModel.
| static DtCommModel* DtExternalCommModel::create | ( | DtCommModelCreationParams & | params | ) | [static] |
Static creator function that can be registered with factories.
Calls the constructor, and init() on the new instance before returning it.
Reimplemented from DtCommModel.
| virtual DtString DtExternalCommModel::type | ( | ) | const [virtual] |
Reimplemented from DtCommModel.
| virtual void DtExternalCommModel::registerRadio | ( | DtVrfRadio * | radio | ) | [virtual] |
Overridden to set ReadyToSend on the radio to true if the model is not using external ready to send signals.
Reimplemented from DtCommModel.
| virtual void DtExternalCommModel::sendMessage | ( | DtVrfObjectMessage * | message, |
| DtVrfRadio * | sendingRadio | ||
| ) | [virtual] |
Send this message if/when the external comms server indicates that it should be sent.
The sender and receiver in the message are used as the sender and receiver for the comms server.
Reimplemented from DtCommModel.
| virtual void DtExternalCommModel::tick | ( | ) | [virtual] |
Delivers any messages that have been approved for delivery and are on the queue.
Reimplemented from DtCommModel.
| virtual DtU32 DtExternalCommModel::nextMessageId | ( | const DtEntityIdentifier & | entityId | ) | [protected, virtual] |
| virtual void DtExternalCommModel::passMessageToReceiver | ( | DtVrfObjectMessageConstPtr | , |
| const DtEntityIdentifier & | receiver | ||
| ) | [protected, virtual] |
Gives the message to the indicated receiver.
| static void DtExternalCommModel::messageClearToReceiveCallback | ( | const DtExternalCommsProcessMessageData & | data, |
| void * | usr | ||
| ) | [static, protected] |
| virtual void DtExternalCommModel::processMessageClearToReceive | ( | const DtExternalCommsProcessMessageData & | data | ) | [protected, virtual] |
| static void DtExternalCommModel::messageTimeoutCallback | ( | const DtExternalCommsTimeoutData & | data, |
| void * | usr | ||
| ) | [static, protected] |
| virtual void DtExternalCommModel::processMessageTimeout | ( | const DtExternalCommsTimeoutData & | data | ) | [protected, virtual] |
| static void DtExternalCommModel::newMessageCallback | ( | const DtExternalCommsMessageTransporter::DtExternalCommsMessageCallbackParams & | params, |
| void * | usr | ||
| ) | [static, protected] |
| virtual void DtExternalCommModel::processNewMessage | ( | const DtExternalCommsMessageTransporter::DtExternalCommsMessageCallbackParams & | params | ) | [protected, virtual] |
| static void DtExternalCommModel::readyToSendCallback | ( | const DtExternalCommsReadyToSendData & | data, |
| void * | usr | ||
| ) | [static, protected] |
| virtual void DtExternalCommModel::processReadyToSend | ( | const DtExternalCommsReadyToSendData & | data | ) | [protected, virtual] |
DtU32 DtExternalCommModel::myLastMessageId [protected] |
DtRadioMessageMap DtExternalCommModel::mySentMessages [protected] |
Contains all the message that have been sent, but are awaiting authorization from the external comms server.
const DtExternalCommModelDescriptor* DtExternalCommModel::myExternalCommModelDescriptor [protected] |