The variable portion is the list of keyword/value strings where the strings are the string length followed by the string itself. More...

Inheritance diagram for DtVrfTDLStatusMessage:

[legend]

Public Member Functions
	DtVrfTDLStatusMessage ()
	default constructor More...

	DtVrfTDLStatusMessage (const DtVrfTDLStatusMessage &orig)
	copy constructor: shallow; copies values only More...

const DtVrfTDLStatusMessage &	operator= (DtVrfTDLStatusMessage &orig)
	assignment operator: shallow; assigns values only More...

virtual	~DtVrfTDLStatusMessage ()
	destructor More...

virtual int	tdlMessageType () const
	TDL Message type. More...

virtual DtVrfTDLMessage *	clone () const

virtual void	printDataToString (DtString &str)
	Print message. More...

virtual int	messageVersion () const

virtual int	fixedSize () const
	Fixed size of this message. More...

virtual int	variableSize () const
	Returns the variable data size. Size of all the Statuss. More...

virtual void	addStatusMessage (const DtString &key, const DtString &value)
	Adds the status key/value to be sent as part of this message. More...

virtual void	removeStatusMessage (const DtString &)
	Removes the Status with the given name. More...

virtual int	numberOfStatusMessages () const
	Returns the number of Statuss. More...

virtual DtString	statusMessage (const DtString &) const
	Returns status information at the given key. More...

const std::map< DtString, DtString > &	statusMessages () const
	Returns the dictionary of status items. More...

Public Member Functions inherited from DtVrfTDLMessage
	DtVrfTDLMessage ()
	default constructor More...

	DtVrfTDLMessage (const DtVrfTDLMessage &orig)
	copy constructor: shallow; copies values only More...

const DtVrfTDLMessage &	operator= (DtVrfTDLMessage &orig)
	assignment operator: shallow; assigns values only More...

virtual	~DtVrfTDLMessage ()
	destructor More...

virtual int	headerVersion () const

virtual int	getContentType (const char *buffer)
	Given the message buffer, get the content type from it. More...

virtual void	setRecipient (const DtSimulationAddress &recipient)
	The recipient of this message. More...

virtual const DtSimulationAddress &	recipient () const

virtual void	setSender (const DtSimulationAddress &recipient)
	The sender of this message. More...

virtual const DtSimulationAddress &	sender () const

virtual int	netRepSize () const
	The number of bytes on the network for this message. Returns the sum of the fixed and variable sizes. More...

virtual const char *	netRep ()
	The buffer which is the content for this message. More...

virtual void	setToNet (char *buffer)
	Sets the contents of this object into the memory buffer specified by myNetRep. More...

virtual bool	setFromNet (const char *buffer, int bufferSize)
	Sets the content from the net by calling setFixedFromNet and setVariableFromNext. More...

virtual void	setMarkingText (const DtString &)
	Accessor for marking text of the item sending this message. More...

virtual const DtString &	markingText () const

virtual void	setUUID (const DtString &)
	Accessor for the UUID for this item. More...

virtual const DtString &	uuid () const

virtual void	setTimeStamp (unsigned int)
	Accessor for time stamp. More...

virtual unsigned int	timeStamp () const

Static Public Member Functions
static DtVrfTDLMessage *	creator ()

Static Public Member Functions inherited from DtVrfTDLMessage
static DtVrfTDLMessage *	creator ()

static void	setFactory (DtVrfTDLMessageFactory *)
	Factory accessors. More...

static DtVrfTDLMessageFactory *	factory ()

Protected Member Functions
virtual void	setFixedToNet (char *buffer)
	Sets the fixed potion to the net. Must call parent method first. More...

virtual const char *	setVariableFromNet (const char variableBuffer, const char fixedBuffer, int messageVersion)
	Sets the variable portion into internal structures. More...

virtual char *	setVariableToNet (char *buffer)
	Sets the variable portion to the net. More...

Protected Member Functions inherited from DtVrfTDLMessage
virtual char *	createNetworkBuffer ()
	Creates the network buffer of the size needed. More...

virtual int	setFixedFromNet (const char *buffer)
	Sets the fixed portion from the buffer into internal structures and variables. More...

Protected Attributes
std::map< DtString, DtString >	myStatusMessages

Protected Attributes inherited from DtVrfTDLMessage
DtSimulationAddress	myRecipient

DtSimulationAddress	mySender

char *	myNetRep

int	myLastAllocatedSize

DtString	myMarkingText

DtString	myUUID

unsigned int	myTimeStamp

Additional Inherited Members
Static Protected Attributes inherited from DtVrfTDLMessage
static DtVrfTDLMessageFactory *	theVrfTDLMessageFactory

Detailed Description

The variable portion is the list of keyword/value strings where the strings are the string length followed by the string itself.

Constructor & Destructor Documentation

DtVrfTDLStatusMessage::DtVrfTDLStatusMessage ( )

default constructor

DtVrfTDLStatusMessage::DtVrfTDLStatusMessage ( const DtVrfTDLStatusMessage & orig )

copy constructor: shallow; copies values only

virtual DtVrfTDLStatusMessage::~DtVrfTDLStatusMessage ( )

virtual

destructor

Member Function Documentation

const DtVrfTDLStatusMessage& DtVrfTDLStatusMessage::operator= ( DtVrfTDLStatusMessage & orig )

assignment operator: shallow; assigns values only

virtual int DtVrfTDLStatusMessage::tdlMessageType ( ) const

virtual

TDL Message type.

Reimplemented from DtVrfTDLMessage.

virtual DtVrfTDLMessage* DtVrfTDLStatusMessage::clone ( ) const

virtual

Reimplemented from DtVrfTDLMessage.

static DtVrfTDLMessage* DtVrfTDLStatusMessage::creator ( )

static

virtual void DtVrfTDLStatusMessage::printDataToString ( DtString & str )

virtual

Print message.

Reimplemented from DtVrfTDLMessage.

virtual int DtVrfTDLStatusMessage::messageVersion ( ) const

virtual

Reimplemented from DtVrfTDLMessage.

virtual int DtVrfTDLStatusMessage::fixedSize ( ) const

virtual

Fixed size of this message.

Do not need to call parent method if this as the fixed portion will contain the header, as all messages structures are expected to be subclassed from the TDL message header

Reimplemented from DtVrfTDLMessage.

virtual int DtVrfTDLStatusMessage::variableSize ( ) const

virtual

Returns the variable data size. Size of all the Statuss.

Reimplemented from DtVrfTDLMessage.

virtual void DtVrfTDLStatusMessage::addStatusMessage	(	const DtString &	key,
		const DtString &	value
	)

virtual

Adds the status key/value to be sent as part of this message.

virtual void DtVrfTDLStatusMessage::removeStatusMessage ( const DtString & )

virtual

Removes the Status with the given name.

virtual int DtVrfTDLStatusMessage::numberOfStatusMessages ( ) const

virtual

Returns the number of Statuss.

virtual DtString DtVrfTDLStatusMessage::statusMessage ( const DtString & ) const

virtual

Returns status information at the given key.

const std::map<DtString, DtString>& DtVrfTDLStatusMessage::statusMessages ( ) const

inline

Returns the dictionary of status items.

virtual void DtVrfTDLStatusMessage::setFixedToNet ( char * buffer )

protectedvirtual

Sets the fixed potion to the net. Must call parent method first.

Reimplemented from DtVrfTDLMessage.

virtual const char* DtVrfTDLStatusMessage::setVariableFromNet	(	const char *	variableBuffer,
		const char *	fixedBuffer,
		int	messageVersion
	)

protectedvirtual

Sets the variable portion into internal structures.

Returns a pointer at the end of this variable such that a subclass can continue on reading

Reimplemented from DtVrfTDLMessage.

virtual char* DtVrfTDLStatusMessage::setVariableToNet ( char * buffer )

protectedvirtual

Sets the variable portion to the net.

Reimplemented from DtVrfTDLMessage.

Member Data Documentation

std::map<DtString, DtString> DtVrfTDLStatusMessage::myStatusMessages

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfmsgs/vrfTDLStatusMessage.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation