MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtWwwStateRspMsg Class Reference
+ Inheritance diagram for DtWwwStateRspMsg:
+ Collaboration diagram for DtWwwStateRspMsg:

List of all members.

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 DtRtiMsgclone (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 DtRtiMsgcreate (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static DtRtiMsgcreate (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 DtNetWwwStateRspMsgnetWwwStateRspMsg ()
 The network representation.
virtual const DtNetWwwStateRspMsgnetWwwStateRspMsg () 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.

Constructor & Destructor Documentation

DtWwwStateRspMsg::DtWwwStateRspMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and minSize().

Referenced by clone(), and create().

DtWwwStateRspMsg::DtWwwStateRspMsg ( unsigned long  handle,
unsigned long  responseType,
const MAKRti::DtString &  xml,
bool  replaceExistingNotAppend = true,
bool  isStateFragment = false,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtWwwStateRspMsg::DtWwwStateRspMsg ( const DtNetWwwStateRspMsg netRep,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Destructor.


Member Function Documentation

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().

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().

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().

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]

Print the data section.

Reimplemented from DtRtiMsg.

References payload(), and source().

void DtWwwStateRspMsg::removeCallback ( DtConnectionMgr conn,
DtWwwStateResponseCb  cb,
void *  usr 
) [static]
unsigned long DtWwwStateRspMsg::responseType ( ) const [virtual]
void DtWwwStateRspMsg::setIsComplete ( bool  complete = true) [virtual]
void DtWwwStateRspMsg::setIsReplacementNotAppend ( bool  replacesExistingState = true) [virtual]
void DtWwwStateRspMsg::setPayload ( const MAKRti::DtString &  xml) [virtual]
void DtWwwStateRspMsg::setResponseType ( unsigned long  responseType) [virtual]
void DtWwwStateRspMsg::setSource ( unsigned long  connHandle) [virtual]
unsigned long DtWwwStateRspMsg::source ( ) const [virtual]

Member Data Documentation

MAKRti::DtString DtWwwStateRspMsg::myXmlResponse [protected]

Federate XML response data.

Referenced by DtWwwStateRspMsg(), payload(), and setPayload().


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)