DtRecordSetPdu is an abstract base class used by PDUs which require the record set functionality. More...

Inheritance diagram for DtRecordSetPdu:

Collaboration diagram for DtRecordSetPdu:

Public Member Functions
virtual	~DtRecordSetPdu ()
	destructor
DtRecordSetPdu &	operator= (const DtRecordSetPdu &orig)
	Assignment operator.
virtual bool	setNumRecordSets (DtU32 numSets)
	Set/Get the number of record sets.
virtual DtU32	numRecordSets () const
virtual bool	setRecordSet (int index, const DtRecordSet &recSet)
	Set/Get a record set.
virtual bool	getRecordSet (int index, DtRecordSet &recSet) 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 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 Member Functions
	DtRecordSetPdu ()
	Constructors (protected because this is an abstract base class).
	DtRecordSetPdu (const DtRecordSetPdu &orig)
bool	validateRecordSets (DtNetRecordSetPdu &netStruct)
	This function checks the data records for consistency between the actual size of the PDU and the size suggested by the PDU.
virtual DtNetRecordSetPdu *	netRecordSetPduStruct () const =0
	Returns a pointer to the beginning of the record set data struct.
virtual char *	var () const
	Returns a pointer to the first byte of variable length data.
virtual int	netRecordSetLength () const
	Returns the length of data used by the record sets beginning at the location specified by netRecordSetPduStruct().
virtual int	recordSetOffset (int recordSetIndex) const
	Returns a buffer offset to the given record set.
DtRecordSetPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.

Protected Attributes
int	mySaveRecCount
	These are used by recordSetOffset() to save the value and index of the last offset which was computed in case it can be used again.
int	mySaveBuffCount

Detailed Description

DtRecordSetPdu is an abstract base class used by PDUs which require the record set functionality.

Constructor & Destructor Documentation

virtual DtRecordSetPdu::~DtRecordSetPdu ( )

virtual

destructor

DtRecordSetPdu::DtRecordSetPdu ( )

protected

Constructors (protected because this is an abstract base class).

DtRecordSetPdu::DtRecordSetPdu ( const DtRecordSetPdu & orig )

protected

Member Function Documentation

virtual bool DtRecordSetPdu::getRecordSet	(	int	index,
		DtRecordSet &	recSet
	)		const

virtual

virtual int DtRecordSetPdu::netRecordSetLength ( ) const

protectedvirtual

Returns the length of data used by the record sets beginning at the location specified by netRecordSetPduStruct().

This can be used by the derived class if any data follows the record set data.

virtual DtNetRecordSetPdu* DtRecordSetPdu::netRecordSetPduStruct ( ) const

protectedpure virtual

Returns a pointer to the beginning of the record set data struct.

This must be implemented by the derived class because the location of the record sets within the PDU can vary.

Implemented in DtTransferControlRequestPdu, DtRecordPdu, and DtSetRecordPdu.

virtual DtU32 DtRecordSetPdu::numRecordSets ( ) const

virtual

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

Assignment operator.

virtual void DtRecordSetPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

Reimplemented in DtTransferControlRequestPdu, DtRecordPdu, and DtSetRecordPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtPdu.

Reimplemented in DtTransferControlRequestPdu, DtRecordPdu, and DtSetRecordPdu.

virtual int DtRecordSetPdu::recordSetOffset ( int recordSetIndex ) const

protectedvirtual

Returns a buffer offset to the given record set.

DtRecordSetPdu* DtRecordSetPdu::self ( ) const

protected

Casts the 'this' pointer for changing elements in a const function.

Non virtual, since you can't override based on return type.

Reimplemented in DtTransferControlRequestPdu, DtRecordPdu, and DtSetRecordPdu.

virtual bool DtRecordSetPdu::setNumRecordSets ( DtU32 numSets )

virtual

Set/Get the number of record sets.

virtual bool DtRecordSetPdu::setRecordSet	(	int	index,
		const DtRecordSet &	recSet
	)

virtual

Set/Get a record set.

If the index is out of bounds, then false is returned. If the space would exceed the maximum space permitted for a PDU (for a set) then false may be returned.

bool DtRecordSetPdu::validateRecordSets ( DtNetRecordSetPdu & netStruct )

protected

This function checks the data records for consistency between the actual size of the PDU and the size suggested by the PDU.

It also tries to fix any problems that are detected. This function is intended to be called in the PDU constructor that accepts network data immediately following initpdu. Non-virtual, since meant to be called from ctor.

virtual char* DtRecordSetPdu::var ( ) const

protectedvirtual

Returns a pointer to the first byte of variable length data.

Member Data Documentation

int DtRecordSetPdu::mySaveBuffCount

protected

int DtRecordSetPdu::mySaveRecCount

protected

These are used by recordSetOffset() to save the value and index of the last offset which was computed in case it can be used again.

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

recordSetPdu.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation