DtStateMsg Class Reference

class DtStateMsg: More...

Collaboration diagram for DtStateMsg:

Public Member Functions
	DtStateMsg (objHandle id, const HandleValueMap &attrs)
	constructor More...
	DtStateMsg (objHandle id, HandleValueMap *attrs)
	constructor More...
virtual	~DtStateMsg ()
	destructor More...
	DtStateMsg (const DtStateMsg &orig)
	copy constructor More...
DtStateMsg &	operator= (const DtStateMsg &orig)
	assignment operator More...
virtual objHandle	objectId () const
	Get the object identifier. More...
virtual const HandleValueMap &	handleMap () const
	Get the attribute handle value pair set. (Const version) More...
virtual HandleValueMap *	handleMap ()
	Get the attribute handle value pair set. (Non-const version) More...
virtual void	setTag (const DtString &tag)
	Set/Get the user-defined tag. More...
virtual void	setCustomTag (const DtString &tag)
virtual const DtString &	tag () const
virtual bool	customTagSet () const
	Get whether a custom tag has been set on the interaction or not. More...
virtual void	print (DtExerciseConn *exConn, RTI::ObjectClassHandle h) const
	Prints the header and attributes with values. More...
virtual void	printToStream (std::ostream &stream, DtExerciseConn *exConn, RTI::ObjectClassHandle h) const
	Prints the header and attributes with values to a stream. More...
virtual void	printHeader (DtExerciseConn *exConn, RTI::ObjectClassHandle classHandle) const
	Prints the header information. More...
virtual void	printHeaderToStream (std::ostream &stream, DtExerciseConn *exConn, RTI::ObjectClassHandle classHandle) const
	Prints the header information to a stream. More...
virtual void	printAttrs (DtExerciseConn *exConn, RTI::ObjectClassHandle classHandle, int withHex) const
	Print the attributes (with hex values if withHex is 1). More...
virtual void	printAttrsToStream (std::ostream &stream, DtExerciseConn *exConn, RTI::ObjectClassHandle classHandle, int withHex) const
	Print the attributes to a stream. More...
virtual void	print (DtHlaObject *obj, bool fullReport=true) const
	Uses the object to print host representation of data. More...
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the time of validity of the message, and whether this represents relative or absolute time. More...
virtual DtTime	timeStamp () const
	Return the time of validity of the message (in seconds past an hour) as set by setTimeStamp. More...
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp. More...
virtual DtTime	guessTimeValid (DtTime referenceTime) const
	Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour. More...
virtual const RTI::Region *	conveyedRegion () const
	Get & Set the conveyed region of the received interaction message. More...
virtual void	setConveyedRegion (const RTI::Region *region)

Static Public Member Functions
static void	setTagIsAsciiTime (bool val)
	Set/Get flag that tells us whether we're using the RPR FOM convention that the UserDefinedTag in updates and interactions represents a DIS-style timestamp. More...
static bool	tagIsAsciiTime ()

Protected Attributes
HandleValueMap *	myAvList
DtString	myTag
objHandle	myId
const RTI::Region *	myConveyedRegion
DtTime	myTime
DtTimeStampType	myTimeType
bool	myCustomTagSet

Static Protected Attributes
static bool	theTagIsAsciiTime

Detailed Description

class DtStateMsg:

Instances of DtStateMsg are used to represent state data communicated via the network in an HLA (as opposed to DIS) environment.

Constructor & Destructor Documentation

DtStateMsg::DtStateMsg	(	objHandle	id,
		const HandleValueMap &	attrs
	)

constructor

DtStateMsg::DtStateMsg	(	objHandle	id,
		HandleValueMap *	attrs
	)

constructor

virtual DtStateMsg::~DtStateMsg ( )

virtual

destructor

DtStateMsg::DtStateMsg

(

const DtStateMsg &

orig

)

copy constructor

Member Function Documentation

virtual const RTI::Region* DtStateMsg::conveyedRegion ( ) const

virtual

Get & Set the conveyed region of the received interaction message.

The region is only valid during the processing of the reflect callback. If the region information is needed after the callback it must be copied. If the region is NULL, there was not a conveyed region

virtual bool DtStateMsg::customTagSet ( ) const

virtual

Get whether a custom tag has been set on the interaction or not.

virtual DtTime DtStateMsg::guessTimeValid ( DtTime  referenceTime ) const

virtual

Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour.

const HandleValueMap & DtStateMsg::handleMap ( ) const

inlinevirtual

Get the attribute handle value pair set. (Const version)

References myAvList.

HandleValueMap * DtStateMsg::handleMap ( )

inlinevirtual

Get the attribute handle value pair set. (Non-const version)

References myAvList.

objHandle DtStateMsg::objectId ( ) const

inlinevirtual

Get the object identifier.

References myId.

DtStateMsg& DtStateMsg::operator=

(

const DtStateMsg &

orig

)

assignment operator

virtual void DtStateMsg::print ( DtExerciseConn *  exConn, RTI::ObjectClassHandle  h  ) const

virtual

Prints the header and attributes with values.

virtual void DtStateMsg::print ( DtHlaObject *  obj, bool  fullReport = true  ) const

virtual

Uses the object to print host representation of data.

virtual void DtStateMsg::printAttrs ( DtExerciseConn *  exConn, RTI::ObjectClassHandle  classHandle, int  withHex  ) const

virtual

Print the attributes (with hex values if withHex is 1).

virtual void DtStateMsg::printAttrsToStream ( std::ostream &  stream, DtExerciseConn *  exConn, RTI::ObjectClassHandle  classHandle, int  withHex  ) const

virtual

Print the attributes to a stream.

virtual void DtStateMsg::printHeader ( DtExerciseConn *  exConn, RTI::ObjectClassHandle  classHandle  ) const

virtual

Prints the header information.

virtual void DtStateMsg::printHeaderToStream ( std::ostream &  stream, DtExerciseConn *  exConn, RTI::ObjectClassHandle  classHandle  ) const

virtual

Prints the header information to a stream.

virtual void DtStateMsg::printToStream ( std::ostream &  stream, DtExerciseConn *  exConn, RTI::ObjectClassHandle  h  ) const

virtual

Prints the header and attributes with values to a stream.

virtual void DtStateMsg::setConveyedRegion ( const RTI::Region *  region )

virtual

virtual void DtStateMsg::setCustomTag ( const DtString &  tag )

virtual

virtual void DtStateMsg::setTag ( const DtString &  tag )

virtual

Set/Get the user-defined tag.

static void DtStateMsg::setTagIsAsciiTime ( bool  val )

static

Set/Get flag that tells us whether we're using the RPR FOM convention that the UserDefinedTag in updates and interactions represents a DIS-style timestamp.

virtual void DtStateMsg::setTimeStamp ( DtTime  time, DtTimeStampType  type = DtTimeStampRelative  )

virtual

Set the time of validity of the message, and whether this represents relative or absolute time.

Time is in seconds, but only time modulo an hour is stored.

virtual const DtString& DtStateMsg::tag ( ) const

virtual

static bool DtStateMsg::tagIsAsciiTime ( )

static

virtual DtTime DtStateMsg::timeStamp ( ) const

virtual

Return the time of validity of the message (in seconds past an hour) as set by setTimeStamp.

virtual DtTimeStampType DtStateMsg::timeStampType ( ) const

virtual

Return the type of the time stamp.

Member Data Documentation

HandleValueMap* DtStateMsg::myAvList

protected

Referenced by handleMap().

const RTI::Region* DtStateMsg::myConveyedRegion

protected

bool DtStateMsg::myCustomTagSet

protected

objHandle DtStateMsg::myId

protected

Referenced by objectId().

DtString DtStateMsg::myTag

protected

DtTime DtStateMsg::myTime

protected

DtTimeStampType DtStateMsg::myTimeType

protected

bool DtStateMsg::theTagIsAsciiTime

staticprotected

---

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

• stateMsgHLA.h