DtStopFreezeRPdu Class Reference

Instances of DtStopFreezeRPdu are used to send/receive reliable stop/freeze PDUs. More...

Inheritance diagram for DtStopFreezeRPdu:

Collaboration diagram for DtStopFreezeRPdu:

Public Member Functions
	DtStopFreezeRPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtStopFreezeRPdu (const DtNetStopFreezeRPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtStopFreezeRPdu (const DtEntityIdentifier &to, const DtEntityIdentifier &from, const DtTime realTime, DtStopReason reason, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtStopFreezeRPdu (const DtStopFreezeRPdu &orig)
virtual	~DtStopFreezeRPdu ()
	destructor
DtStopFreezeRPdu &	operator= (const DtStopFreezeRPdu &orig)
	Assignment operator.
virtual void	setRealWorldTime (const DtTime time)
	Set/Get real world time.
virtual DtTime	realWorldTime () const
virtual void	setReason (DtStopReason reason)
	Set/Get the stop reason.
virtual DtStopReason	reason () const
virtual void	setFrozenBehavior (int behavior)
	Set/Get the frozen behavior.
virtual int	frozenBehavior () const
virtual void	setReqRelService (DtRequiredReliabilityService value)
	Set/Get the required reliability service.
virtual DtRequiredReliabilityService	reqRelService () const
virtual void	setRequestId (int id)
	Set/Get the request id.
virtual int	requestId () const
virtual void	printData () const
	Print the data contained by this PDU.
virtual void	printDataToStream (std::ostream &stream) const
	Print the data to a stream.
Public Member Functions inherited from DtSimanPdu
DtSimanPdu &	operator= (const DtSimanPdu &orig)
	Assignment operator.
virtual const DtEntityIdentifier &	senderId () const
	Get the sender ID.
virtual const DtEntityIdentifier &	receiverId () const
	Get the receiver ID.
virtual void	setSenderId (const DtEntityIdentifier &id)
	Set the sender ID.
virtual void	setReceiverId (const DtEntityIdentifier &id)
	Set the receiver ID.
Public Member Functions inherited from DtInteraction
	DtInteraction ()
	default constructor
virtual	~DtInteraction ()
	destructor
	DtInteraction (const DtInteraction &orig)
	copy constructor
DtInteraction &	operator= (const DtInteraction &orig)
	assignment operator
Public Member Functions inherited from DtPdu
virtual	~DtPdu ()
	Destructor.
	DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtPdu &	operator= (const DtPdu &pdu)
	Assignment operator.
virtual void *	packet () const
	Older function that returns a pointer to the network representation.
virtual int	status () const
	Get PDU status.
virtual void	setVersion (int vers)
	Set/Get protocol version from PDU header.
virtual int	protocolVersion () const
virtual void	setExerciseId (int id)
	Set/Get exerciseID in PDU header.
virtual int	exerciseId () const
virtual DtPduKind	kind () const
	Returns PDU kind from PDU header.
virtual DtProtocolFamily	protocolFamily () const
	Returns protocol family from PDU header.
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the PDU header's time stamp to reflect time and type.
virtual DtTime	timeStamp () const
	Return the time (in seconds past an hour) encoded in the PDU header's time stamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp, as indicated in PDU header.
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.
virtual DtNetPduHeader *	netHeader () const
	Returns a pointer to the PDU's header.
virtual void	print () const
	Print the contents of the PDU by calling printToStream(DtInfo).
virtual void	printToStream (std::ostream &stream) const
	Print the contents of the PDU by calling printHeaderToStream and printDataToStream.
virtual void	printHeader () const
	Print the PDU's header. This calls printHeaderToStream(DtInfo).
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the PDU's header to a stream.
virtual void	printDataToString (DtString &str) const
Public Member Functions inherited from DtBaseMsg
virtual	~DtBaseMsg ()
	Destructor.
	DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtBaseMsg &	operator= (const DtBaseMsg &msg)
	Assignment.
virtual const char *	netRep () const
	Get network representation.
virtual int	length () const
	Get size of message.

Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Create a DtStopFreezeRPdu.
static void	addCallback (DtExerciseConn *conn, DtStopFreezeRPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtStopFreezeRPduCb cb, void *usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.

Static Protected Attributes
static const int	theStaticSize

Additional Inherited Members
Protected Attributes inherited from DtSimanPdu
DtEntityIdentifier	cache

Detailed Description

Instances of DtStopFreezeRPdu are used to send/receive reliable stop/freeze PDUs.

Constructor & Destructor Documentation

DtStopFreezeRPdu::DtStopFreezeRPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtStopFreezeRPdu::DtStopFreezeRPdu	(	const DtNetStopFreezeRPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtStopFreezeRPdu::DtStopFreezeRPdu	(	const DtEntityIdentifier &	to,
		const DtEntityIdentifier &	from,
		const DtTime	realTime,
		DtStopReason	reason,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtStopFreezeRPdu::DtStopFreezeRPdu

(

const DtStopFreezeRPdu &

orig

)

virtual DtStopFreezeRPdu::~DtStopFreezeRPdu ( )

virtual

destructor

Member Function Documentation

static void DtStopFreezeRPdu::addCallback ( DtExerciseConn *  conn, DtStopFreezeRPduCb  cb, void *  usr  )

static

Add (register)/Remove (deregister) function to be called when pdu is received.

static DtPdu* DtStopFreezeRPdu::create ( const DtNetPacket *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER  )

static

Create a DtStopFreezeRPdu.

Caller is responsible for deletion.

virtual int DtStopFreezeRPdu::frozenBehavior ( ) const

virtual

DtPduKind DtStopFreezeRPdu::internalGetPduKind ( ) const

inlineprotectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

References DtStopFreezeRPduKind.

DtStopFreezeRPdu& DtStopFreezeRPdu::operator=

(

const DtStopFreezeRPdu &

orig

)

Assignment operator.

virtual void DtStopFreezeRPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtSimanPdu.

virtual void DtStopFreezeRPdu::printDataToStream ( std::ostream &  stream ) const

virtual

Print the data to a stream.

Reimplemented from DtSimanPdu.

virtual DtTime DtStopFreezeRPdu::realWorldTime ( ) const

virtual

virtual DtStopReason DtStopFreezeRPdu::reason ( ) const

virtual

static void DtStopFreezeRPdu::removeCallback ( DtExerciseConn *  conn, DtStopFreezeRPduCb  cb, void *  usr  )

static

virtual DtRequiredReliabilityService DtStopFreezeRPdu::reqRelService ( ) const

virtual

virtual int DtStopFreezeRPdu::requestId ( ) const

virtual

virtual void DtStopFreezeRPdu::setFrozenBehavior ( int  behavior )

virtual

Set/Get the frozen behavior.

virtual void DtStopFreezeRPdu::setRealWorldTime ( const DtTime  time )

virtual

Set/Get real world time.

virtual void DtStopFreezeRPdu::setReason ( DtStopReason  reason )

virtual

Set/Get the stop reason.

virtual void DtStopFreezeRPdu::setReqRelService ( DtRequiredReliabilityService  value )

virtual

Set/Get the required reliability service.

virtual void DtStopFreezeRPdu::setRequestId ( int  id )

virtual

Set/Get the request id.

Member Data Documentation

const int DtStopFreezeRPdu::theStaticSize

staticprotected

---

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

• stopFrzRPdu.h