DtSetRecordPdu Class Reference

class DtSetRecordPdu: More...

Inheritance diagram for DtSetRecordPdu:

Collaboration diagram for DtSetRecordPdu:

Public Member Functions
	DtSetRecordPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtSetRecordPdu (const DtNetSetRecordPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtSetRecordPdu (const DtSetRecordPdu &orig)
virtual	~DtSetRecordPdu ()
	destructor
DtSetRecordPdu &	operator= (const DtSetRecordPdu &orig)
	Assignment operator.
virtual void	setOriginatingEntityID (const DtEntityIdentifier &entity)
	Set/Get originating entity identifier.
virtual const DtEntityIdentifier &	originatingEntityID () const
virtual void	setReceivingEntityID (const DtEntityIdentifier &entity)
	Set/Get receiving entity identifier.
virtual const DtEntityIdentifier &	receivingEntityID () const
virtual void	setRequestID (DtU32 id)
	Set/Get request ID.
virtual DtU32	requestID () const
virtual void	setReqRelService (enum DtRequiredReliabilityService service)
	Set/Get required reliability service.
virtual DtRequiredReliabilityService	reqRelService () 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 DtRecordSetPdu
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
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 DtSetRecordPdu.
static void	addCallback (DtExerciseConn *conn, DtSetRecordPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtSetRecordPduCb cb, void *usr)

Protected Member Functions
virtual DtNetRecordSetPdu *	netRecordSetPduStruct () const
	Returns a pointer to the beginning of the record set data struct.
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetSetRecordPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtSetRecordPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.
Protected Member Functions inherited from DtRecordSetPdu
	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 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.

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
Protected Attributes inherited from DtRecordSetPdu
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

Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero data bytes.

Detailed Description

class DtSetRecordPdu:

Instances of DtSetRecordPdu are used to initialize or change internal parameter values using record sets.

Constructor & Destructor Documentation

DtSetRecordPdu::DtSetRecordPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtSetRecordPdu::DtSetRecordPdu	(	const DtNetSetRecordPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtSetRecordPdu::DtSetRecordPdu

(

const DtSetRecordPdu &

orig

)

virtual DtSetRecordPdu::~DtSetRecordPdu ( )

virtual

destructor

Member Function Documentation

static void DtSetRecordPdu::addCallback ( DtExerciseConn *  conn, DtSetRecordPduCb  cb, void *  usr  )

static

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

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

static

Create a DtSetRecordPdu.

Caller is responsible for deletion.

virtual DtPduKind DtSetRecordPdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual DtNetSetRecordPdu* DtSetRecordPdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

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

virtual DtNetRecordSetPdu* DtSetRecordPdu::netRecordSetPduStruct ( ) const

protectedvirtual

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

Implements DtRecordSetPdu.

DtSetRecordPdu& DtSetRecordPdu::operator=

(

const DtSetRecordPdu &

orig

)

Assignment operator.

virtual const DtEntityIdentifier& DtSetRecordPdu::originatingEntityID ( ) const

virtual

virtual void DtSetRecordPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtRecordSetPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtRecordSetPdu.

virtual const DtEntityIdentifier& DtSetRecordPdu::receivingEntityID ( ) const

virtual

static void DtSetRecordPdu::removeCallback ( DtExerciseConn *  conn, DtSetRecordPduCb  cb, void *  usr  )

static

virtual DtRequiredReliabilityService DtSetRecordPdu::reqRelService ( ) const

virtual

virtual DtU32 DtSetRecordPdu::requestID ( ) const

virtual

DtSetRecordPdu* DtSetRecordPdu::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 from DtRecordSetPdu.

virtual void DtSetRecordPdu::setOriginatingEntityID ( const DtEntityIdentifier &  entity )

virtual

Set/Get originating entity identifier.

virtual void DtSetRecordPdu::setReceivingEntityID ( const DtEntityIdentifier &  entity )

virtual

Set/Get receiving entity identifier.

virtual void DtSetRecordPdu::setReqRelService ( enum DtRequiredReliabilityService  service )

virtual

Set/Get required reliability service.

virtual void DtSetRecordPdu::setRequestID ( DtU32  id )

virtual

Set/Get request ID.

Member Data Documentation

DtEntityIdentifier DtSetRecordPdu::myEntityID

protected

Temporary objects for reference returns.

const int DtSetRecordPdu::theStaticSize

staticprotected

Size of PDU with zero data bytes.

---

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

• setRecordPdu.h