ExampleTDLMessage Class Reference

The variable portion is the string of the message itself. More...

Inheritance diagram for ExampleTDLMessage:

Public Member Functions
	ExampleTDLMessage ()
	default constructor
	ExampleTDLMessage (const ExampleTDLMessage &orig)
	copy constructor: shallow; copies values only
const ExampleTDLMessage &	operator= (ExampleTDLMessage &orig)
	assignment operator: shallow; assigns values only
virtual	~ExampleTDLMessage ()
	destructor
virtual int	tdlMessageType () const
	TDL Message type.
virtual DtVrfTDLMessage *	clone () const
virtual void	printDataToString (DtString &str)
	Print message.
virtual int	messageVersion () const
virtual int	fixedSize () const
	Fixed size of this message.
virtual int	variableSize () const
	Returns the variable data size. Size of all the Statuss.
virtual void	setMessage (const DtString &)
	Set message.
const DtString &	message () const
virtual void	setLocation (const DtVector &)
	Accessor for location of object.
virtual const DtVector &	location () const
Public Member Functions inherited from DtVrfTDLMessage
	DtVrfTDLMessage ()
	default constructor
	DtVrfTDLMessage (const DtVrfTDLMessage &orig)
	copy constructor: shallow; copies values only
const DtVrfTDLMessage &	operator= (DtVrfTDLMessage &orig)
	assignment operator: shallow; assigns values only
virtual	~DtVrfTDLMessage ()
	destructor
virtual int	headerVersion () const
virtual int	getContentType (const char *buffer)
	Given the message buffer, get the content type from it.
virtual void	setRecipient (const DtSimulationAddress &recipient)
	The recipient of this message.
virtual const DtSimulationAddress &	recipient () const
virtual void	setSender (const DtSimulationAddress &recipient)
	The sender of this message.
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.
virtual const char *	netRep ()
	The buffer which is the content for this message.
virtual void	setToNet (char *buffer)
	Sets the contents of this object into the memory buffer specified by myNetRep.
virtual bool	setFromNet (const char *buffer, int bufferSize)
	Sets the content from the net by calling setFixedFromNet and setVariableFromNext.
virtual void	setMarkingText (const DtString &)
	Accessor for marking text of the item sending this message.
virtual const DtString &	markingText () const
virtual void	setUUID (const DtString &)
	Accessor for the UUID for this item.
virtual const DtString &	uuid () const
virtual void	setTimeStamp (unsigned int)
	Accessor for time stamp.
virtual unsigned int	timeStamp () const

Static Public Member Functions
static DtVrfTDLMessage *	creator ()
Static Public Member Functions inherited from DtVrfTDLMessage
static void	setFactory (DtVrfTDLMessageFactory *)
	Factory accessors.
static DtVrfTDLMessageFactory *	factory ()

Protected Member Functions
virtual void	setFixedToNet (char *buffer)
	Sets the fixed potion to the net. Must call parent method first.
virtual int	setFixedFromNet (const char *buffer)
	Sets the fixed portion from the buffer into internal structures and variables.
virtual const char *	setVariableFromNet (const char *buffer, const char *fixedBuffer, int messageVersion)
	Sets the variable portion into internal structures.
virtual char *	setVariableToNet (char *buffer)
	Sets the variable portion to the net.
Protected Member Functions inherited from DtVrfTDLMessage
virtual char *	createNetworkBuffer ()
	Creates the network buffer of the size needed.

Protected Attributes
DtVector	myTgtLocation
DtString	myTgtMessage
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 string of the message itself.

Constructor & Destructor Documentation

ExampleTDLMessage::ExampleTDLMessage

(

)

default constructor

ExampleTDLMessage::ExampleTDLMessage

(

const ExampleTDLMessage &

orig

)

copy constructor: shallow; copies values only

virtual ExampleTDLMessage::~ExampleTDLMessage ( )

virtual

destructor

Member Function Documentation

const ExampleTDLMessage& ExampleTDLMessage::operator=

(

ExampleTDLMessage &

orig

)

assignment operator: shallow; assigns values only

virtual int ExampleTDLMessage::tdlMessageType ( ) const

virtual

TDL Message type.

Reimplemented from DtVrfTDLMessage.

virtual DtVrfTDLMessage* ExampleTDLMessage::clone ( ) const

virtual

Reimplemented from DtVrfTDLMessage.

static DtVrfTDLMessage* ExampleTDLMessage::creator ( )

static

Reimplemented from DtVrfTDLMessage.

virtual void ExampleTDLMessage::printDataToString ( DtString &  str )

virtual

Print message.

Reimplemented from DtVrfTDLMessage.

virtual int ExampleTDLMessage::messageVersion ( ) const

virtual

Reimplemented from DtVrfTDLMessage.

virtual int ExampleTDLMessage::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 ExampleTDLMessage::variableSize ( ) const

virtual

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

Reimplemented from DtVrfTDLMessage.

virtual void ExampleTDLMessage::setMessage ( const DtString &  )

virtual

Set message.

const DtString& ExampleTDLMessage::message

(

)

const

virtual void ExampleTDLMessage::setLocation ( const DtVector &  )

virtual

Accessor for location of object.

virtual const DtVector& ExampleTDLMessage::location ( ) const

virtual

virtual void ExampleTDLMessage::setFixedToNet ( char *  buffer )

protectedvirtual

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

Reimplemented from DtVrfTDLMessage.

virtual int ExampleTDLMessage::setFixedFromNet ( const char *  buffer )

protectedvirtual

Sets the fixed portion from the buffer into internal structures and variables.

Reimplemented from DtVrfTDLMessage.

virtual const char* ExampleTDLMessage::setVariableFromNet ( const char *  buffer, 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* ExampleTDLMessage::setVariableToNet ( char *  buffer )

protectedvirtual

Sets the variable portion to the net.

Reimplemented from DtVrfTDLMessage.

Member Data Documentation

DtVector ExampleTDLMessage::myTgtLocation

protected

DtString ExampleTDLMessage::myTgtMessage

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/examples/tdlMessage/tdlMessageSim/exTDLMessage.h