Instances of DtRecordQueryPdu are used to request data records from an entity. More...

Inheritance diagram for DtRecordQueryPdu:

Collaboration diagram for DtRecordQueryPdu:

Public Member Functions
	DtRecordQueryPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtRecordQueryPdu (const DtNetRecordQueryPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtRecordQueryPdu (const DtRecordQueryPdu &orig)
virtual	~DtRecordQueryPdu ()
	destructor
DtRecordQueryPdu &	operator= (const DtRecordQueryPdu &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	setEventType (DtEventType type)
	Set/Get the event type.
virtual DtEventType	eventType () const
virtual void	setTime (DtU32 value)
	Set/Get the time.
virtual DtU32	time () const
virtual bool	setNumRecords (DtU32 num)
	Set/Get the number of records to be queried for.
virtual DtU32	numRecords () const
virtual bool	setRecordID (int index, DtDatumParam value)
	Set/Get a record ID.
virtual bool	getRecordID (int index, DtDatumParam &value) 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.

Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Create a DtRecordQueryPdu.
static void	addCallback (DtExerciseConn conn, DtRecordQueryPduCb cb, void usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn conn, DtRecordQueryPduCb cb, void usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetRecordQueryPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtRecordQueryPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.
virtual char *	var () const
	Returns a pointer to the first byte of variable length data.

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.

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

Detailed Description

Instances of DtRecordQueryPdu are used to request data records from an entity.

Constructor & Destructor Documentation

DtRecordQueryPdu::DtRecordQueryPdu ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

DtRecordQueryPdu::DtRecordQueryPdu	(	const DtNetRecordQueryPdu *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

DtRecordQueryPdu::DtRecordQueryPdu ( const DtRecordQueryPdu & orig )

virtual DtRecordQueryPdu::~DtRecordQueryPdu ( )

virtual

destructor

Member Function Documentation

static void DtRecordQueryPdu::addCallback	(	DtExerciseConn *	conn,
		DtRecordQueryPduCb	cb,
		void *	usr
	)

static

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

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

static

Create a DtRecordQueryPdu.

Caller is responsible for deletion.

virtual DtEventType DtRecordQueryPdu::eventType ( ) const

virtual

virtual bool DtRecordQueryPdu::getRecordID	(	int	index,
		DtDatumParam &	value
	)		const

virtual

virtual DtPduKind DtRecordQueryPdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual DtNetRecordQueryPdu* DtRecordQueryPdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

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

virtual DtU32 DtRecordQueryPdu::numRecords ( ) const

virtual

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

Assignment operator.

virtual const DtEntityIdentifier& DtRecordQueryPdu::originatingEntityID ( ) const

virtual

virtual void DtRecordQueryPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtPdu.

virtual const DtEntityIdentifier& DtRecordQueryPdu::receivingEntityID ( ) const

virtual

static void DtRecordQueryPdu::removeCallback	(	DtExerciseConn *	conn,
		DtRecordQueryPduCb	cb,
		void *	usr
	)

static

virtual DtRequiredReliabilityService DtRecordQueryPdu::reqRelService ( ) const

virtual

virtual DtU32 DtRecordQueryPdu::requestID ( ) const

virtual

DtRecordQueryPdu* DtRecordQueryPdu::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.

virtual void DtRecordQueryPdu::setEventType ( DtEventType type )

virtual

Set/Get the event type.

virtual bool DtRecordQueryPdu::setNumRecords ( DtU32 num )

virtual

Set/Get the number of records to be queried for.

Set may return false if the number of records is too large.

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

virtual

Set/Get originating entity identifier.

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

virtual

Set/Get receiving entity identifier.

virtual bool DtRecordQueryPdu::setRecordID	(	int	index,
		DtDatumParam	value
	)

virtual

Set/Get a record ID.

These methods return false if the index is out of range.

virtual void DtRecordQueryPdu::setReqRelService ( enum DtRequiredReliabilityService service )

virtual

Set/Get required reliability service.

virtual void DtRecordQueryPdu::setRequestID ( DtU32 id )

virtual

Set/Get request ID.

virtual void DtRecordQueryPdu::setTime ( DtU32 value )

virtual

Set/Get the time.

virtual DtU32 DtRecordQueryPdu::time ( ) const

virtual

virtual char* DtRecordQueryPdu::var ( ) const

protectedvirtual

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

Member Data Documentation

DtEntityIdentifier DtRecordQueryPdu::myEntityID

protected

Temporary objects for reference returns.

const int DtRecordQueryPdu::theStaticSize

staticprotected

Size of PDU with zero data bytes.

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

recQueryPdu.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation