DtSimanPdu Class Reference

DtSimanPdu provides a base class for all of the simulation management PDU's. More...

Inheritance diagram for DtSimanPdu:

Collaboration diagram for DtSimanPdu:

Public Member Functions
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.
virtual void	printData () const
	Prints the contents of the PDU.
virtual void	printDataToStream (std::ostream &stream) const
	Prints the contents of the PDU to the specified stream.
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.

Protected Attributes
DtEntityIdentifier	cache

Additional Inherited Members
Protected Member Functions inherited from DtPdu
	DtPdu ()
	Constructor.
virtual void	setStatus (int okStatus)
	Sets the PDU's status to okStatus.
virtual void	initPdu (int size, DtBufferPtr buffer)
	Must be called after default ctor before PDU is completely constructed.
virtual void	initPdu (const void *initial, DtBufferPtr buffer)
	Called by from-net-rep ctor. Initializes DtBaseMsg.
virtual DtPduKind	internalGetPduKind () const =0
	Returns the PDU kind associated with the derived PDU class.
virtual DtProtocolFamily	kindToFamily (DtPduKind kind) const
	Maps PDU kind to ProtocolFamily.
virtual void	sizeChanged (int size)
	Called by changeSize. Sets the size in the header to size.
virtual void	clearData ()
	zeros out all bytes after the PDU header.
virtual void	initHeader (DtPduKind kind, int size)
	Initializes PDU header. Called by initPdu.

Detailed Description

DtSimanPdu provides a base class for all of the simulation management PDU's.

Member Function Documentation

DtSimanPdu& DtSimanPdu::operator= ( const DtSimanPdu &  orig )

inline

Assignment operator.

References DtPdu::operator=().

virtual void DtSimanPdu::printData ( ) const

virtual

Prints the contents of the PDU.

Reimplemented from DtPdu.

Reimplemented in DtPduWithData, DtActionResponsePdu, DtDataQueryRPdu, DtStopFreezeRPdu, DtStartResumePdu, DtDataQueryPdu, DtStartResumeRPdu, DtAcknowledgePdu, DtActionRequestPdu, DtCreateEntityPdu, DtStopFreezePdu, DtAcknowledgeRPdu, DtActionRequestRPdu, DtCreateEntityRPdu, DtSetDataPdu, DtRemoveEntityRPdu, DtDataRPdu, DtSetDataRPdu, DtRemoveEntityPdu, DtActionResponseRPdu, DtDataPdu, DtEventReportPdu, and DtEventReptRPdu.

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

virtual

Prints the contents of the PDU to the specified stream.

Reimplemented from DtPdu.

Reimplemented in DtPduWithData, DtActionResponsePdu, DtDataQueryRPdu, DtStopFreezeRPdu, DtStartResumePdu, DtDataQueryPdu, DtStartResumeRPdu, DtAcknowledgePdu, DtActionRequestPdu, DtCreateEntityPdu, DtStopFreezePdu, DtAcknowledgeRPdu, DtActionRequestRPdu, DtCreateEntityRPdu, DtSetDataPdu, DtRemoveEntityRPdu, DtDataRPdu, DtSetDataRPdu, DtRemoveEntityPdu, DtActionResponseRPdu, DtDataPdu, DtEventReportPdu, and DtEventReptRPdu.

virtual const DtEntityIdentifier& DtSimanPdu::receiverId ( ) const

virtual

Get the receiver ID.

virtual const DtEntityIdentifier& DtSimanPdu::senderId ( ) const

virtual

Get the sender ID.

virtual void DtSimanPdu::setReceiverId ( const DtEntityIdentifier &  id )

virtual

Set the receiver ID.

virtual void DtSimanPdu::setSenderId ( const DtEntityIdentifier &  id )

virtual

Set the sender ID.

Member Data Documentation

DtEntityIdentifier DtSimanPdu::cache

protected

---

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

• simanPdu.h