DtPdu Class Reference

DtPdu is the base class for all PDU's in VR-Link. More...

Inheritance diagram for DtPdu:

Collaboration diagram for DtPdu:

Public Member Functions
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	printData () const
	Print the PDU's data (not including header).
virtual void	printDataToStream (std::ostream &stream) const
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 Member Functions
	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.
Protected Member Functions inherited from DtBaseMsg
	DtBaseMsg ()
	Constructor Object is not fully constructed until initMsg is called.
void	initMsg (int size, DtBufferPtr bufferPtr)
void	initMsg (const void *initial, int size, DtBufferPtr bufferPtr)
virtual void	changeSize (int size)
	Changes the size of the message.
virtual void	insertBytes (int offset, int numBytes)
	Inserts numBytes zeroed-out bytes at the indicated offset into the net rep.
virtual void	insertBytes (void *address, int numBytes)
	Inserts numBytes zeroed-out bytes at the indicated address.
virtual void	deleteBytes (int offset, int numBytes)
	Deletes numBytes bytes at the indicated offset in the net rep.
virtual void	deleteBytes (void *address, int numBytes)
	Deletes numBytes bytes starting at the indicated address.
virtual void	clearAll ()
	Zeros out all bytes in the network representation.
virtual void *	newInternalBuffer (int size)
	Sets myInternalBuff to point to a malloc'ed buffer of size bytes.

Protected Attributes
int	myOKStatus
Protected Attributes inherited from DtBaseMsg
void *	myNetMsg
void *	myInternalBuff
int	myIntBuffSize
int	myMsgSize

Detailed Description

DtPdu is the base class for all PDU's in VR-Link.

Constructor & Destructor Documentation

virtual DtPdu::~DtPdu ( )

virtual

Destructor.

DtPdu::DtPdu	(	const DtPdu &	pdu,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Copy constructor.

DtPdu::DtPdu ( )

protected

Constructor.

PDU is not fully constructed until initPdu is called.

Member Function Documentation

virtual void DtPdu::clearData ( )

protectedvirtual

zeros out all bytes after the PDU header.

int DtPdu::exerciseId ( ) const

inlinevirtual

References DtNetPduHeader::DtExercise, and netHeader().

virtual DtTime DtPdu::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.

virtual void DtPdu::initHeader ( DtPduKind  kind, int  size  )

protectedvirtual

Initializes PDU header. Called by initPdu.

virtual void DtPdu::initPdu ( int  size, DtBufferPtr  buffer  )

protectedvirtual

Must be called after default ctor before PDU is completely constructed.

Fills in PDU header, and initializes DtBaseMsg.

virtual void DtPdu::initPdu ( const void *  initial, DtBufferPtr  buffer  )

protectedvirtual

Called by from-net-rep ctor. Initializes DtBaseMsg.

virtual DtPduKind DtPdu::internalGetPduKind ( ) const

protectedpure virtual

Returns the PDU kind associated with the derived PDU class.

Implemented in DtGriddedDataPdu, and DtEnvironmentalProcessPdu.

DtPduKind DtPdu::kind ( ) const

inlinevirtual

Returns PDU kind from PDU header.

References netHeader().

virtual DtProtocolFamily DtPdu::kindToFamily ( DtPduKind  kind ) const

protectedvirtual

Maps PDU kind to ProtocolFamily.

DtNetPduHeader * DtPdu::netHeader ( ) const

inlinevirtual

Returns a pointer to the PDU's header.

References DtBaseMsg::netRep().

Referenced by exerciseId(), kind(), protocolFamily(), protocolVersion(), setExerciseId(), setTimeStamp(), setVersion(), timeStamp(), and timeStampType().

DtPdu& DtPdu::operator=

(

const DtPdu &

pdu

)

Assignment operator.

void * DtPdu::packet ( ) const

inlinevirtual

Older function that returns a pointer to the network representation.

The newer DtBaseMsg::netRep should generally be used instead.

References DtBaseMsg::netRep().

virtual void DtPdu::print ( ) const

virtual

Print the contents of the PDU by calling printToStream(DtInfo).

virtual void DtPdu::printData ( ) const

virtual

Print the PDU's data (not including header).

Base DtPdu version just prints hex. Use the printDataToString to put the data into a DtString instead of simply sending the output to stdout. printData() calls printDataToStream(DtInfo).

Reimplemented in DtGriddedDataPdu, and DtEnvironmentalProcessPdu.

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

virtual

Reimplemented in DtGriddedDataPdu, and DtEnvironmentalProcessPdu.

virtual void DtPdu::printDataToString ( DtString &  str ) const

virtual

virtual void DtPdu::printHeader ( ) const

virtual

Print the PDU's header. This calls printHeaderToStream(DtInfo).

virtual void DtPdu::printHeaderToStream ( std::ostream &  stream ) const

virtual

Print the PDU's header to a stream.

virtual void DtPdu::printToStream ( std::ostream &  stream ) const

virtual

Print the contents of the PDU by calling printHeaderToStream and printDataToStream.

DtProtocolFamily DtPdu::protocolFamily ( ) const

inlinevirtual

Returns protocol family from PDU header.

References netHeader().

int DtPdu::protocolVersion ( ) const

inlinevirtual

References netHeader(), and DtNetPduHeader::version.

void DtPdu::setExerciseId ( int  id )

inlinevirtual

Set/Get exerciseID in PDU header.

References DtNetPduHeader::DtExercise, and netHeader().

void DtPdu::setStatus ( int  okStatus )

inlineprotectedvirtual

Sets the PDU's status to okStatus.

References myOKStatus.

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

inlinevirtual

Set the PDU header's time stamp to reflect time and type.

Time is in seconds, but only the time modulo an hour actually gets into the time stamp.

References DtNetPduHeader::DtTime, and netHeader().

void DtPdu::setVersion ( int  vers )

inlinevirtual

Set/Get protocol version from PDU header.

References netHeader(), and DtNetPduHeader::version.

virtual void DtPdu::sizeChanged ( int  size )

protectedvirtual

Called by changeSize. Sets the size in the header to size.

Implements DtBaseMsg.

int DtPdu::status ( ) const

inlinevirtual

Get PDU status.

DtSTATUS_OK means it's good. Other values indicate a bad PDU. Return codes are derived PDU-dependent.

References myOKStatus.

DtTime DtPdu::timeStamp ( ) const

inlinevirtual

Return the time (in seconds past an hour) encoded in the PDU header's time stamp.

References DtNetPduHeader::DtTime, netHeader(), and DtNetTimeStamp::time().

DtTimeStampType DtPdu::timeStampType ( ) const

inlinevirtual

Return the type of the time stamp, as indicated in PDU header.

References DtNetPduHeader::DtTime, netHeader(), and DtNetTimeStamp::type().

Member Data Documentation

int DtPdu::myOKStatus

protected

Referenced by setStatus(), and status().

---

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

• pdu.h