DtWwwFederateStateRspMsg Class Reference

Inheritance diagram for DtWwwFederateStateRspMsg:

Collaboration diagram for DtWwwFederateStateRspMsg:

List of all members.

Public Member Functions
	DtWwwFederateStateRspMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtWwwFederateStateRspMsg (unsigned long connId, unsigned long federationHandle, unsigned long federateHandle, unsigned long responseType, const MAKRti::DtString &xml, bool replaceExistingNotAppend=true, bool isStateFragment=false, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtWwwFederateStateRspMsg (const DtNetWwwFederateStateMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtWwwFederateStateRspMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual unsigned long	sourceConnectionId () const
	Set/Get target connection handle.
virtual void	setSourceConnectionId (unsigned long connId)
virtual unsigned long	sourceFederateHandle () const
	Set/Get source federate handle.
virtual void	setSourceFederateHandle (unsigned long handle)
virtual unsigned long	responseType () const
	Set/Get state component ID contained in response.
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, DtWwwFederateStateResponseCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtWwwFederateStateResponseCb cb, void *usr)
Protected Member Functions
virtual DtNetWwwFederateStateMsg *	netWwwFederateStateMsg ()
	The network representation.
virtual const DtNetWwwFederateStateMsg *	netWwwFederateStateMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an DtWwwFederateStateRspMsg 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

DtWwwFederateStateRspMsg::DtWwwFederateStateRspMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtWwwFederateStateRspMsg::DtWwwFederateStateRspMsg	(	unsigned long	connId,
		unsigned long	federationHandle,
		unsigned long	federateHandle,
		unsigned long	responseType,
		const MAKRti::DtString &	xml,
		bool	replaceExistingNotAppend = true,
		bool	isStateFragment = false,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), netWwwFederateStateMsg(), DtNetWwwFederateStateMsg::requestNotResponse, DtRtiMsg::setFedEx(), setIsComplete(), setIsReplacementNotAppend(), setPayload(), setResponseType(), setSourceConnectionId(), and setSourceFederateHandle().

DtWwwFederateStateRspMsg::DtWwwFederateStateRspMsg	(	const DtNetWwwFederateStateMsg *	netRep,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

References DtNetWwwFederateStateMsg::header, DtRtiMsg::initDtRtiMsg(), myXmlResponse, netMsgPayload(), and netWwwFederateStateMsg().

DtWwwFederateStateRspMsg::~DtWwwFederateStateRspMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtWwwFederateStateRspMsg::addCallback	(	DtConnectionMgr *	conn,
		DtWwwFederateStateResponseCb	cb,
		void *	usr
	)		[static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtWwwFederateStateRspMsgKind.

DtRtiMsg * DtWwwFederateStateRspMsg::clone

(

bool

copy = true

)

const [virtual]

Return a copy/empty object of the same type as this.

Implements DtRtiMsg.

References DtWwwFederateStateRspMsg(), and netWwwFederateStateMsg().

DtRtiMsg * DtWwwFederateStateRspMsg::create	(	const DtNetMsgHeader *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)		[static]

Creator.

References DtWwwFederateStateRspMsg().

DtRtiMsg * DtWwwFederateStateRspMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtWwwFederateStateRspMsg().

DtRtiMsgKind DtWwwFederateStateRspMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an DtWwwFederateStateRspMsg Msg.

Implements DtRtiMsg.

References DtWwwFederateStateRspMsgKind.

Referenced by DtWwwFederateStateRspMsg().

bool DtWwwFederateStateRspMsg::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 DtNetWwwFederateStateMsg::completeState, and netWwwFederateStateMsg().

Referenced by DtWwwClientProtocol::parseFederateStateMsg().

bool DtWwwFederateStateRspMsg::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 netWwwFederateStateMsg(), and DtNetWwwFederateStateMsg::replaceExisiting.

Referenced by DtWwwClientProtocol::parseFederateStateMsg().

int DtWwwFederateStateRspMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtWwwFederateStateRspMsg().

char * DtWwwFederateStateRspMsg::netMsgPayload

(

)

[protected, virtual]

Get a pointer to the message payload.

References netWwwFederateStateMsg(), and DtNetWwwFederateStateMsg::payloadLength.

Referenced by DtWwwFederateStateRspMsg(), and setPayload().

DtNetWwwFederateStateMsg * DtWwwFederateStateRspMsg::netWwwFederateStateMsg

(

)

[protected, virtual]

The network representation.

Referenced by clone(), DtWwwFederateStateRspMsg(), isComplete(), isReplacementNotAppend(), netMsgPayload(), responseType(), setIsComplete(), setIsReplacementNotAppend(), setPayload(), setResponseType(), setSourceConnectionId(), setSourceFederateHandle(), sourceConnectionId(), and sourceFederateHandle().

const DtNetWwwFederateStateMsg * DtWwwFederateStateRspMsg::netWwwFederateStateMsg

(

)

const [protected, virtual]

const MAKRti::DtString & DtWwwFederateStateRspMsg::payload

(

)

const [virtual]

Set/Get the payload data.

References myXmlResponse.

Referenced by DtWwwClientProtocol::parseFederateStateMsg(), and printData().

void DtWwwFederateStateRspMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References payload(), sourceConnectionId(), and sourceFederateHandle().

void DtWwwFederateStateRspMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtWwwFederateStateResponseCb	cb,
		void *	usr
	)		[static]

References DtWwwFederateStateRspMsgKind, and DtConnectionMgr::removeMsgCallback().

unsigned long DtWwwFederateStateRspMsg::responseType

(

)

const [virtual]

Set/Get state component ID contained in response.

References netWwwFederateStateMsg(), and DtNetWwwFederateStateMsg::stateType.

Referenced by DtWwwClientProtocol::parseFederateStateMsg(), and DtRtiexecObserverForWebService::processFederateStateRspMsg().

void DtWwwFederateStateRspMsg::setIsComplete

(

bool

complete = true

)

[virtual]

References DtNetWwwFederateStateMsg::completeState, and netWwwFederateStateMsg().

Referenced by DtWwwFederateStateRspMsg().

void DtWwwFederateStateRspMsg::setIsReplacementNotAppend

(

bool

replacesExistingState = true

)

[virtual]

References netWwwFederateStateMsg(), and DtNetWwwFederateStateMsg::replaceExisiting.

Referenced by DtWwwFederateStateRspMsg().

void DtWwwFederateStateRspMsg::setPayload

(

const MAKRti::DtString &

xml

)

[virtual]

References rti1516e::insertBytes(), myXmlResponse, netMsgPayload(), netWwwFederateStateMsg(), and DtNetWwwFederateStateMsg::payloadLength.

Referenced by DtWwwFederateStateRspMsg().

void DtWwwFederateStateRspMsg::setResponseType

(

unsigned long

responseType

)

[virtual]

References netWwwFederateStateMsg(), and DtNetWwwFederateStateMsg::stateType.

Referenced by DtWwwFederateStateRspMsg().

void DtWwwFederateStateRspMsg::setSourceConnectionId

(

unsigned long

connId

)

[virtual]

References DtNetWwwFederateStateMsg::connId, and netWwwFederateStateMsg().

Referenced by DtWwwFederateStateRspMsg().

void DtWwwFederateStateRspMsg::setSourceFederateHandle

(

unsigned long

handle

)

[virtual]

References DtNetWwwFederateStateMsg::federateHandle, and netWwwFederateStateMsg().

Referenced by DtWwwFederateStateRspMsg().

unsigned long DtWwwFederateStateRspMsg::sourceConnectionId

(

)

const [virtual]

Set/Get target connection handle.

References DtNetWwwFederateStateMsg::connId, and netWwwFederateStateMsg().

Referenced by DtWwwClientProtocol::parseFederateStateMsg(), printData(), and DtRtiexecObserverForWebService::processFederateStateRspMsg().

unsigned long DtWwwFederateStateRspMsg::sourceFederateHandle

(

)

const [virtual]

Set/Get source federate handle.

References DtNetWwwFederateStateMsg::federateHandle, and netWwwFederateStateMsg().

Referenced by printData(), and DtRtiexecObserverForWebService::processFederateStateRspMsg().

---

Member Data Documentation

MAKRti::DtString DtWwwFederateStateRspMsg::myXmlResponse [protected]

Federate XML response data.

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

---

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

• wwwFederateStateRspMsg.h
• wwwFederateStateRspMsg.cxx