![]() |
MAK RTIspy API Documentation for HLA 1516
|
Inheritance diagram for DtRestoreReplyMsg:
Collaboration diagram for DtRestoreReplyMsg:Public Types | |
| enum | replyCodes { DT_RESTORE_OK = 0, DT_RESTORE_NO_LABEL = 1, DT_RESTORE_WRONG_CONFIG = 2, DT_RESTORE_IN_PROCESS = 3 } |
Public Member Functions | |
| DtRestoreReplyMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| DtRestoreReplyMsg (const char *theLabel, const replyCodes response, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| DtRestoreReplyMsg (const DtNetRestoreReplyMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| virtual | ~DtRestoreReplyMsg () |
| Destructor. | |
| virtual DtRtiMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. | |
| virtual void | setLabel (const char *label) |
| Set/Get label. | |
| virtual const char * | label () const |
| virtual void | setReply (const replyCodes value) |
| Set/Get successIndicator. | |
| virtual replyCodes | reply () const |
| virtual void | printData (DtLogicalTimeFactory *logicalTimeFactory) const |
| Print the data section. | |
| virtual unsigned long | destinationID () const |
| Set/Get federate destination ID The federate name is not enough to uniquely identify it among other federates. | |
| virtual void | setDestinationID (unsigned long destinationIDValue) |
Static Public Member Functions | |
| static DtRtiMsg * | create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creator. | |
| static DtRtiMsg * | create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creator. | |
| static void | addCallback (DtConnectionMgr *conn, DtRestoreReplyCb cb, void *usr) |
| Callback management. | |
| static void | removeCallback (DtConnectionMgr *conn, DtRestoreReplyCb cb, void *usr) |
Protected Member Functions | |
| virtual char * | labelPtr () |
| Returns pointer to the label in the netMsg. | |
| virtual int | labelFieldSize () const |
| Returns size of label field. | |
| virtual DtNetRestoreReplyMsg * | netRestoreReplyMsg () |
| The network representation. | |
| virtual const DtNetRestoreReplyMsg * | netRestoreReplyMsg () const |
| virtual DtRtiMsgKind | internalDtRtiMsgKind () |
| Returns the kind of an Restore Reply Msg. | |
| virtual int | minSize (const char *theLabel=NULL) const |
| Returns minimum size of a message, including header. | |
| virtual void | setLabelSize (int size) |
| Set/Get tag size. | |
| virtual int | labelSize () const |
| virtual DtRestoreReplyMsg * | self () const |
| Casts away const-ness. | |
Protected Attributes | |
| char * | myLabel |
| DtRestoreReplyMsg::DtRestoreReplyMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructor.
References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and minSize().
| DtRestoreReplyMsg::DtRestoreReplyMsg | ( | const char * | theLabel, |
| const replyCodes | response, | ||
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
Constructor.
References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setLabel(), and setReply().
| DtRestoreReplyMsg::DtRestoreReplyMsg | ( | const DtNetRestoreReplyMsg * | netRepMsg, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
Constructor.
References DtNetRestoreReplyMsg::header, and DtRtiMsg::initDtRtiMsg().
| DtRestoreReplyMsg::~DtRestoreReplyMsg | ( | ) | [virtual] |
| void DtRestoreReplyMsg::addCallback | ( | DtConnectionMgr * | conn, |
| DtRestoreReplyCb | cb, | ||
| void * | usr | ||
| ) | [static] |
Callback management.
References DtConnectionMgr::addMsgCallback(), and DtRestoreReplyMsgKind.
Referenced by DtFederateMgr::postJoinInit().
| DtRtiMsg * DtRestoreReplyMsg::clone | ( | bool | copy = true | ) | const [virtual] |
Return a copy/empty object of the same type as this.
Implements DtRtiMsg.
References DtRestoreReplyMsg(), and netRestoreReplyMsg().
| DtRtiMsg * DtRestoreReplyMsg::create | ( | const DtNetMsgHeader * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) | [static] |
Creator.
References DtRestoreReplyMsg().
| DtRtiMsg * DtRestoreReplyMsg::create | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) | [static] |
Creator.
References DtRestoreReplyMsg().
| unsigned long DtRestoreReplyMsg::destinationID | ( | ) | const [virtual] |
Set/Get federate destination ID The federate name is not enough to uniquely identify it among other federates.
This destination ID was the unique source ID that the federate supplied for join.
References DtNetRestoreReplyMsg::destinationID, and netRestoreReplyMsg().
Referenced by DtRtiExecFederateMgr::processRestoreReply().
| DtRtiMsgKind DtRestoreReplyMsg::internalDtRtiMsgKind | ( | ) | [protected, virtual] |
Returns the kind of an Restore Reply Msg.
Implements DtRtiMsg.
References DtRestoreReplyMsgKind.
Referenced by DtRestoreReplyMsg().
| const char * DtRestoreReplyMsg::label | ( | ) | const [virtual] |
References labelPtr(), labelSize(), myLabel, netRestoreReplyMsg(), and NULL.
Referenced by printData(), and DtRtiExecFederateMgr::processRestoreReply().
| int DtRestoreReplyMsg::labelFieldSize | ( | ) | const [protected, virtual] |
Returns size of label field.
References DtNetRestoreReplyMsg::labelSize, labelSize(), and netRestoreReplyMsg().
Referenced by setLabel().
| char * DtRestoreReplyMsg::labelPtr | ( | ) | [protected, virtual] |
Returns pointer to the label in the netMsg.
References labelSize(), and netRestoreReplyMsg().
Referenced by label(), and setLabel().
| int DtRestoreReplyMsg::labelSize | ( | ) | const [protected, virtual] |
References DtNetRestoreReplyMsg::labelSize, and netRestoreReplyMsg().
Referenced by label(), labelFieldSize(), labelPtr(), and setLabel().
| int DtRestoreReplyMsg::minSize | ( | const char * | theLabel = NULL | ) | const [protected, virtual] |
Returns minimum size of a message, including header.
Referenced by DtRestoreReplyMsg().
| DtNetRestoreReplyMsg * DtRestoreReplyMsg::netRestoreReplyMsg | ( | ) | [protected, virtual] |
The network representation.
Referenced by clone(), destinationID(), label(), labelFieldSize(), labelPtr(), labelSize(), reply(), setDestinationID(), setLabel(), setLabelSize(), and setReply().
| const DtNetRestoreReplyMsg * DtRestoreReplyMsg::netRestoreReplyMsg | ( | ) | const [protected, virtual] |
| void DtRestoreReplyMsg::printData | ( | DtLogicalTimeFactory * | logicalTimeFactory | ) | const [virtual] |
Print the data section.
Reimplemented from DtRtiMsg.
References DT_RESTORE_IN_PROCESS, DT_RESTORE_NO_LABEL, DT_RESTORE_OK, DT_RESTORE_WRONG_CONFIG, label(), and reply().
| void DtRestoreReplyMsg::removeCallback | ( | DtConnectionMgr * | conn, |
| DtRestoreReplyCb | cb, | ||
| void * | usr | ||
| ) | [static] |
References DtRestoreReplyMsgKind, and DtConnectionMgr::removeMsgCallback().
Referenced by DtFederateMgr::resignFederationExecution(), and DtFederateMgr::~DtFederateMgr().
| DtRestoreReplyMsg::replyCodes DtRestoreReplyMsg::reply | ( | ) | const [virtual] |
References netRestoreReplyMsg(), and DtNetRestoreReplyMsg::response.
Referenced by printData(), DtRtiExecFederateMgr::processRestoreReply(), and setReply().
| DtRestoreReplyMsg * DtRestoreReplyMsg::self | ( | ) | const [inline, protected, virtual] |
Casts away const-ness.
| void DtRestoreReplyMsg::setDestinationID | ( | unsigned long | destinationIDValue | ) | [virtual] |
References DtNetRestoreReplyMsg::destinationID, and netRestoreReplyMsg().
Referenced by DtFedExec::processRestoreRequest().
| void DtRestoreReplyMsg::setLabel | ( | const char * | label | ) | [virtual] |
Set/Get label.
References rti1516e::insertBytes(), labelFieldSize(), labelPtr(), DtNetRestoreReplyMsg::labelSize, labelSize(), myLabel, and netRestoreReplyMsg().
Referenced by DtRestoreReplyMsg().
| void DtRestoreReplyMsg::setLabelSize | ( | int | size | ) | [protected, virtual] |
Set/Get tag size.
References DtNetRestoreReplyMsg::labelSize, and netRestoreReplyMsg().
| void DtRestoreReplyMsg::setReply | ( | const replyCodes | value | ) | [virtual] |
Set/Get successIndicator.
References netRestoreReplyMsg(), reply(), and DtNetRestoreReplyMsg::response.
Referenced by DtRestoreReplyMsg().
char* DtRestoreReplyMsg::myLabel [protected] |
Referenced by label(), setLabel(), and ~DtRestoreReplyMsg().