DtStartResumePdu Class Reference

Instances of DtStartResumePdu are used to send/receive start/resume PDUs. More...

Inheritance diagram for DtStartResumePdu:

Collaboration diagram for DtStartResumePdu:

Public Types
enum	{ PduStaticSize = 44 }

Public Member Functions
	DtStartResumePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtStartResumePdu (const DtNetStartResumePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtStartResumePdu (const DtEntityIdentifier &to, const DtEntityIdentifier &from, const DtTime realTime, const DtTime simTime, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
DtTime	realWorldTime () const
	Set/Get real world time.
void	setRealWorldTime (const DtTime time)
DtTimeStampType	realWorldTimeType () const
	Set/Get real world time type (represented by last bit of RealWorldTime).
void	setRealWorldTimeType (const DtTimeStampType type)
DtTime	simulationTime () const
	Set/Get simulation time.
void	setSimulationTime (const DtTime time)
DtTimeStampType	simulationTimeType () const
	Set/Get simulation time type (represented by last bit of SimulationTime).
void	setSimulationTimeType (const DtTimeStampType type)
int	requestId () const
	Set/Get the request id.
void	setRequestId (int id)
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 DtStartResumePdu.
static void	addCallback (DtExerciseConn *conn, DtStartResumePduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtStartResumePduCb cb, void *usr)

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

Additional Inherited Members
Protected Attributes inherited from DtSimanPdu
DtEntityIdentifier	cache

Detailed Description

Instances of DtStartResumePdu are used to send/receive start/resume PDUs.

Member Enumeration Documentation

anonymous enum

Enumerator:

PduStaticSize

Constructor & Destructor Documentation

DtStartResumePdu::DtStartResumePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtStartResumePdu::DtStartResumePdu	(	const DtNetStartResumePdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtStartResumePdu::DtStartResumePdu	(	const DtEntityIdentifier &	to,
		const DtEntityIdentifier &	from,
		const DtTime	realTime,
		const DtTime	simTime,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Member Function Documentation

static void DtStartResumePdu::addCallback ( DtExerciseConn *  conn, DtStartResumePduCb  cb, void *  usr  )

static

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

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

static

Create a DtStartResumePdu.

Caller is responsible for deletion.

DtPduKind DtStartResumePdu::internalGetPduKind ( ) const

inlineprotectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

References DtStartResumePduKind.

virtual void DtStartResumePdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtSimanPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtSimanPdu.

DtTime DtStartResumePdu::realWorldTime

(

)

const

Set/Get real world time.

DtTimeStampType DtStartResumePdu::realWorldTimeType

(

)

const

Set/Get real world time type (represented by last bit of RealWorldTime).

static void DtStartResumePdu::removeCallback ( DtExerciseConn *  conn, DtStartResumePduCb  cb, void *  usr  )

static

int DtStartResumePdu::requestId

(

)

const

Set/Get the request id.

void DtStartResumePdu::setRealWorldTime

(

const DtTime

time

)

void DtStartResumePdu::setRealWorldTimeType

(

const DtTimeStampType

type

)

void DtStartResumePdu::setRequestId

(

int

id

)

void DtStartResumePdu::setSimulationTime

(

const DtTime

time

)

void DtStartResumePdu::setSimulationTimeType

(

const DtTimeStampType

type

)

DtTime DtStartResumePdu::simulationTime

(

)

const

Set/Get simulation time.

DtTimeStampType DtStartResumePdu::simulationTimeType

(

)

const

Set/Get simulation time type (represented by last bit of SimulationTime).

---

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

• startPdu.h