![]() |
MAK RTIspy API Documentation for HLA 1516
|
Inheritance diagram for DtWwwStateRspMsg:
Collaboration diagram for DtWwwStateRspMsg:Public Member Functions | |
| DtWwwStateRspMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| DtWwwStateRspMsg (unsigned long handle, unsigned long responseType, const MAKRti::DtString &xml, bool replaceExistingNotAppend=true, bool isStateFragment=false, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| DtWwwStateRspMsg (const DtNetWwwStateRspMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| virtual | ~DtWwwStateRspMsg () |
| Destructor. | |
| virtual DtRtiMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. | |
| virtual unsigned long | source () const |
| Set/Get source connection handle. | |
| virtual void | setSource (unsigned long connHandle) |
| virtual unsigned long | responseType () const |
| Set/Get source connection handle. | |
| virtual void | setResponseType (unsigned long responseType) |
| virtual const MAKRti::DtString & | payload () const |
| Set/Get the payload data. | |
| virtual void | setPayload (const MAKRti::DtString &xml) |
| virtual bool | isReplacementNotAppend () const |
| Is this message to be appended to the existing state representation (for example, streamed events like LRC log messages)? Or is it a complete replacement for the existing state? | |
| virtual void | setIsReplacementNotAppend (bool replacesExistingState=true) |
| virtual bool | isComplete () const |
| Is the state update complete? This may indicate that a single state message is a complete update (most state updates), or it may indicate that this message completes a string of partial updates for state that is too large for a single message ( for example, FOM and RID files ) | |
| virtual void | setIsComplete (bool complete=true) |
| virtual void | printData (DtLogicalTimeFactory *logicalTimeFactory) const |
| Print the data section. | |
Static Public Member Functions | |
| static DtRtiMsg * | create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creator. | |
| static DtRtiMsg * | create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| static void | addCallback (DtConnectionMgr *conn, DtWwwStateResponseCb cb, void *usr) |
| Callback management. | |
| static void | removeCallback (DtConnectionMgr *conn, DtWwwStateResponseCb cb, void *usr) |
Protected Member Functions | |
| virtual DtNetWwwStateRspMsg * | netWwwStateRspMsg () |
| The network representation. | |
| virtual const DtNetWwwStateRspMsg * | netWwwStateRspMsg () const |
| virtual DtRtiMsgKind | internalDtRtiMsgKind () |
| Returns the kind of an DtWwwStateRspMsg Msg. | |
| virtual char * | netMsgPayload () |
| Get a pointer to the message payload. | |
| virtual int | minSize () const |
| Returns minimum size of a message, including header. | |
Protected Attributes | |
| MAKRti::DtString | myXmlResponse |
| Federate XML response data. | |
| DtWwwStateRspMsg::DtWwwStateRspMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructor.
References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and minSize().
| DtWwwStateRspMsg::DtWwwStateRspMsg | ( | unsigned long | handle, |
| unsigned long | responseType, | ||
| const MAKRti::DtString & | xml, | ||
| bool | replaceExistingNotAppend = true, |
||
| bool | isStateFragment = false, |
||
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
Constructor.
References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setIsComplete(), setIsReplacementNotAppend(), setPayload(), setResponseType(), and setSource().
| DtWwwStateRspMsg::DtWwwStateRspMsg | ( | const DtNetWwwStateRspMsg * | netRep, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
Constructor.
References DtNetWwwStateRspMsg::header, DtRtiMsg::initDtRtiMsg(), myXmlResponse, netMsgPayload(), and netWwwStateRspMsg().
| DtWwwStateRspMsg::~DtWwwStateRspMsg | ( | ) | [virtual] |
Destructor.
| void DtWwwStateRspMsg::addCallback | ( | DtConnectionMgr * | conn, |
| DtWwwStateResponseCb | cb, | ||
| void * | usr | ||
| ) | [static] |
Callback management.
References DtConnectionMgr::addMsgCallback(), and DtWwwStateRspMsgKind.
| DtRtiMsg * DtWwwStateRspMsg::clone | ( | bool | copy = true | ) | const [virtual] |
Return a copy/empty object of the same type as this.
Implements DtRtiMsg.
References DtWwwStateRspMsg(), and netWwwStateRspMsg().
| DtRtiMsg * DtWwwStateRspMsg::create | ( | const DtNetMsgHeader * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) | [static] |
Creator.
References DtWwwStateRspMsg().
| DtRtiMsg * DtWwwStateRspMsg::create | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) | [static] |
References DtWwwStateRspMsg().
| DtRtiMsgKind DtWwwStateRspMsg::internalDtRtiMsgKind | ( | ) | [protected, virtual] |
Returns the kind of an DtWwwStateRspMsg Msg.
Implements DtRtiMsg.
References DtWwwStateRspMsgKind.
Referenced by DtWwwStateRspMsg().
| bool DtWwwStateRspMsg::isComplete | ( | ) | const [virtual] |
Is the state update complete? This may indicate that a single state message is a complete update (most state updates), or it may indicate that this message completes a string of partial updates for state that is too large for a single message ( for example, FOM and RID files )
References DtNetWwwStateRspMsg::completeState, and netWwwStateRspMsg().
Referenced by DtWwwClientProtocol::parseComponentStateMsg().
| bool DtWwwStateRspMsg::isReplacementNotAppend | ( | ) | const [virtual] |
Is this message to be appended to the existing state representation (for example, streamed events like LRC log messages)? Or is it a complete replacement for the existing state?
References netWwwStateRspMsg(), and DtNetWwwStateRspMsg::replaceExisiting.
Referenced by DtWwwClientProtocol::parseComponentStateMsg().
| int DtWwwStateRspMsg::minSize | ( | ) | const [protected, virtual] |
Returns minimum size of a message, including header.
Referenced by DtWwwStateRspMsg().
| char * DtWwwStateRspMsg::netMsgPayload | ( | ) | [protected, virtual] |
Get a pointer to the message payload.
References netWwwStateRspMsg(), and DtNetWwwStateRspMsg::payloadLength.
Referenced by DtWwwStateRspMsg(), and setPayload().
| DtNetWwwStateRspMsg * DtWwwStateRspMsg::netWwwStateRspMsg | ( | ) | [protected, virtual] |
The network representation.
Referenced by clone(), DtWwwStateRspMsg(), isComplete(), isReplacementNotAppend(), netMsgPayload(), responseType(), setIsComplete(), setIsReplacementNotAppend(), setPayload(), setResponseType(), setSource(), and source().
| const DtNetWwwStateRspMsg * DtWwwStateRspMsg::netWwwStateRspMsg | ( | ) | const [protected, virtual] |
| const MAKRti::DtString & DtWwwStateRspMsg::payload | ( | ) | const [virtual] |
Set/Get the payload data.
References myXmlResponse.
Referenced by DtWwwClientProtocol::parseComponentStateMsg(), and printData().
| void DtWwwStateRspMsg::printData | ( | DtLogicalTimeFactory * | logicalTimeFactory | ) | const [virtual] |
| void DtWwwStateRspMsg::removeCallback | ( | DtConnectionMgr * | conn, |
| DtWwwStateResponseCb | cb, | ||
| void * | usr | ||
| ) | [static] |
References DtWwwStateRspMsgKind, and DtConnectionMgr::removeMsgCallback().
| unsigned long DtWwwStateRspMsg::responseType | ( | ) | const [virtual] |
Set/Get source connection handle.
References netWwwStateRspMsg(), and DtNetWwwStateRspMsg::responseType.
Referenced by DtWwwClientProtocol::parseComponentStateMsg(), and DtRtiexecObserverForWebService::processStateRspMsg().
| void DtWwwStateRspMsg::setIsComplete | ( | bool | complete = true | ) | [virtual] |
References DtNetWwwStateRspMsg::completeState, and netWwwStateRspMsg().
Referenced by DtWwwStateRspMsg().
| void DtWwwStateRspMsg::setIsReplacementNotAppend | ( | bool | replacesExistingState = true | ) | [virtual] |
References netWwwStateRspMsg(), and DtNetWwwStateRspMsg::replaceExisiting.
Referenced by DtWwwStateRspMsg().
| void DtWwwStateRspMsg::setPayload | ( | const MAKRti::DtString & | xml | ) | [virtual] |
References rti1516e::insertBytes(), myXmlResponse, netMsgPayload(), netWwwStateRspMsg(), and DtNetWwwStateRspMsg::payloadLength.
Referenced by DtWwwStateRspMsg().
| void DtWwwStateRspMsg::setResponseType | ( | unsigned long | responseType | ) | [virtual] |
References netWwwStateRspMsg(), and DtNetWwwStateRspMsg::responseType.
Referenced by DtWwwStateRspMsg().
| void DtWwwStateRspMsg::setSource | ( | unsigned long | connHandle | ) | [virtual] |
References netWwwStateRspMsg(), and DtNetWwwStateRspMsg::sourceId.
Referenced by DtWwwStateRspMsg().
| unsigned long DtWwwStateRspMsg::source | ( | ) | const [virtual] |
Set/Get source connection handle.
References netWwwStateRspMsg(), and DtNetWwwStateRspMsg::sourceId.
Referenced by DtWwwClientProtocol::parseComponentStateMsg(), printData(), and DtRtiexecObserverForWebService::processStateRspMsg().
MAKRti::DtString DtWwwStateRspMsg::myXmlResponse [protected] |
Federate XML response data.
Referenced by DtWwwStateRspMsg(), payload(), and setPayload().