DtVrfTDLStatusMessage Class Reference

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

Inheritance diagram for DtVrfTDLStatusMessage:

Public Member Functions
	DtVrfTDLStatusMessage ()
	DtVrfTDLStatusMessage (const DtVrfTDLStatusMessage &orig)
const DtVrfTDLStatusMessage &	operator= (DtVrfTDLStatusMessage &orig)
virtual	~DtVrfTDLStatusMessage ()
virtual int	tdlMessageType () const
virtual DtVrfTDLMessage *	clone () const
virtual void	printDataToString (DtString &str)
virtual int	messageVersion () const
virtual int	fixedSize () const
virtual int	variableSize () const
virtual void	addStatusMessage (const DtString &key, const DtString &value)
virtual void	removeStatusMessage (const DtString &)
virtual int	numberOfStatusMessages () const
virtual DtString	statusMessage (const DtString &) const
const std::map< DtString, DtString > &	statusMessages () const
Public Member Functions inherited from DtVrfTDLMessage
	DtVrfTDLMessage ()
	DtVrfTDLMessage (const DtVrfTDLMessage &orig)
const DtVrfTDLMessage &	operator= (DtVrfTDLMessage &orig)
virtual	~DtVrfTDLMessage ()
virtual int	headerVersion () const
virtual int	getContentType (const char *buffer)
virtual void	setRecipient (const DtSimulationAddress &recipient)
virtual const DtSimulationAddress &	recipient () const
virtual void	setSender (const DtSimulationAddress &recipient)
virtual const DtSimulationAddress &	sender () const
virtual int	netRepSize () const
virtual const char *	netRep ()
virtual void	setToNet (char *buffer)
virtual bool	setFromNet (const char *buffer, int bufferSize)
virtual void	setMarkingText (const DtString &)
virtual const DtString &	markingText () const
virtual void	setUUID (const DtString &)
virtual const DtString &	uuid () const
virtual void	setTimeStamp (unsigned int)
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 *)
static DtVrfTDLMessageFactory *	factory ()

Protected Member Functions
virtual void	setFixedToNet (char *buffer)
virtual const char *	setVariableFromNet (const char *variableBuffer, const char *fixedBuffer, int messageVersion)
virtual char *	setVariableToNet (char *buffer)
Protected Member Functions inherited from DtVrfTDLMessage
virtual char *	createNetworkBuffer ()
virtual int	setFixedFromNet (const char *buffer)

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

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.vrf5-1-branch/include/vrfmsgs/vrfTDLStatusMessage.h