StopFreezeMessage Class Reference

Inheritance diagram for StopFreezeMessage:

Collaboration diagram for StopFreezeMessage:

Public Types
enum	StopReason {   StopReason_OTHER, StopReason_RECESS, StopReason_TERMINATION, StopReason_SYSTEMFAILURE,   StopReason_SECURITYFAILURE, StopReason_ENTITYRECONSTRUCTION }

Public Member Functions
	StopFreezeMessage ()
virtual	~StopFreezeMessage ()
virtual std::string	getSenderId ()
virtual void	setSenderId (std::string val)
virtual std::string	getReceiverId ()
virtual void	setReceiverId (std::string val)
virtual unsigned int	getRequestId ()
virtual void	setRequestId (unsigned int val)
virtual double	getRealTime ()
virtual void	setRealTime (double val)
virtual StopReason	getStopReason ()
virtual void	setStopReason (StopReason val)
virtual bool	getReflectWhenFrozen ()
virtual void	setReflectWhenFrozen (bool val)
virtual bool	getRunClockWhenFrozen ()
virtual void	setRunClockWhenFrozen (bool val)
virtual bool	getUpdateWhenFrozen ()
virtual void	setUpdateWhenFrozen (bool val)
virtual int	messageSize ()
	this function needs to be in each derived class for decoding
Public Member Functions inherited from DtMessage
	DtMessage ()
	constructor
virtual	~DtMessage ()
	destructor
virtual std::string	name () const
	Get the name of the message type.
virtual unsigned char *	encode ()
	Encode the message as an array of bytes and return the bytes.

Static Public Member Functions
static DtMessage *	decode (unsigned char *buffer, int length)
static std::string	theMessageName ()

Protected Member Functions
virtual void	serialize (DtStreamWriter &writer)
virtual void	deserialize (DtStreamReader &reader)

Protected Attributes
std::string	mySenderId
std::string	myReceiverId
unsigned int	myRequestId
double	myRealTime
StopReason	myStopReason
bool	myReflectWhenFrozen
bool	myRunClockWhenFrozen
bool	myUpdateWhenFrozen
Protected Attributes inherited from DtMessage
std::string	myName

Static Protected Attributes
static std::string	theFullName

Detailed Description

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!This is an auto-generated file. Any changes will be destroyed!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Member Enumeration Documentation

enum StopFreezeMessage::StopReason

Enumerator:

StopReason_OTHER
StopReason_RECESS
StopReason_TERMINATION
StopReason_SYSTEMFAILURE
StopReason_SECURITYFAILURE
StopReason_ENTITYRECONSTRUCTION

Constructor & Destructor Documentation

StopFreezeMessage::StopFreezeMessage

(

)

virtual StopFreezeMessage::~StopFreezeMessage ( )

virtual

Member Function Documentation

static DtMessage* StopFreezeMessage::decode ( unsigned char *  buffer, int  length  )

static

virtual void StopFreezeMessage::deserialize ( DtStreamReader &  reader )

protectedvirtual

Reimplemented from DtMessage.

virtual double StopFreezeMessage::getRealTime ( )

virtual

virtual std::string StopFreezeMessage::getReceiverId ( )

virtual

virtual bool StopFreezeMessage::getReflectWhenFrozen ( )

virtual

virtual unsigned int StopFreezeMessage::getRequestId ( )

virtual

virtual bool StopFreezeMessage::getRunClockWhenFrozen ( )

virtual

virtual std::string StopFreezeMessage::getSenderId ( )

virtual

virtual StopReason StopFreezeMessage::getStopReason ( )

virtual

virtual bool StopFreezeMessage::getUpdateWhenFrozen ( )

virtual

virtual int StopFreezeMessage::messageSize ( )

virtual

this function needs to be in each derived class for decoding

Get the size of the message data in bytes

Reimplemented from DtMessage.

virtual void StopFreezeMessage::serialize ( DtStreamWriter &  writer )

protectedvirtual

Reimplemented from DtMessage.

virtual void StopFreezeMessage::setRealTime ( double  val )

virtual

virtual void StopFreezeMessage::setReceiverId ( std::string  val )

virtual

virtual void StopFreezeMessage::setReflectWhenFrozen ( bool  val )

virtual

virtual void StopFreezeMessage::setRequestId ( unsigned int  val )

virtual

virtual void StopFreezeMessage::setRunClockWhenFrozen ( bool  val )

virtual

virtual void StopFreezeMessage::setSenderId ( std::string  val )

virtual

virtual void StopFreezeMessage::setStopReason ( StopReason  val )

virtual

virtual void StopFreezeMessage::setUpdateWhenFrozen ( bool  val )

virtual

static std::string StopFreezeMessage::theMessageName ( )

static

Member Data Documentation

double StopFreezeMessage::myRealTime

protected

std::string StopFreezeMessage::myReceiverId

protected

bool StopFreezeMessage::myReflectWhenFrozen

protected

unsigned int StopFreezeMessage::myRequestId

protected

bool StopFreezeMessage::myRunClockWhenFrozen

protected

std::string StopFreezeMessage::mySenderId

protected

StopReason StopFreezeMessage::myStopReason

protected

bool StopFreezeMessage::myUpdateWhenFrozen

protected

std::string StopFreezeMessage::theFullName

staticprotected

---

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

• managedInterface/messages/stopFreeze.h