DtDataQueryPdu Class Reference

Instances of DtDataQueryPdu are used to send/receive data query PDUs. More...

Inheritance diagram for DtDataQueryPdu:

Collaboration diagram for DtDataQueryPdu:

Public Types
enum	{ PduStaticSize = 40 }

Public Member Functions
	DtDataQueryPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtDataQueryPdu (const DtNetDataQueryPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
unsigned long	requestId () const
	Set/Get the request id.
void	setRequestId (unsigned long id)
DtTime	timeInterval () const
	Set/Get the time interval.
void	setTimeInterval (DtTime seconds)
unsigned long	numFixedFields () const
	Get the number of fixed fields.
unsigned long	numVarFields () const
	Get the number of variable fields.
DtDatumParam	fixedDatumId (int index) const
	Set/Get the fixed datum id at the specified index.
int	setFixedDatumId (int index, DtDatumParam id)
DtDatumParam	varDatumId (int index) const
	Set/Get the variable datum id at the specified index.
int	setVarDatumId (int index, DtDatumParam id)
void	initDatumIds (unsigned long numFixedFields, unsigned long numVarFields)
	Initialize the fixed and variable fields.
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 DtSimanPdu
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.
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 DtDataQueryPdu.
static void	addCallback (DtExerciseConn *conn, DtDataQueryPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtDataQueryPduCb cb, void *usr)

Protected Member Functions
DtPduKind	internalGetPduKind () const
	Returns the PDU kind associated with the derived PDU class.

Additional Inherited Members
Protected Attributes inherited from DtSimanPdu
DtEntityIdentifier	cache

Detailed Description

Instances of DtDataQueryPdu are used to send/receive data query PDUs.

Member Enumeration Documentation

anonymous enum

Enumerator:

PduStaticSize

Constructor & Destructor Documentation

DtDataQueryPdu::DtDataQueryPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtDataQueryPdu::DtDataQueryPdu	(	const DtNetDataQueryPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Member Function Documentation

static void DtDataQueryPdu::addCallback ( DtExerciseConn *  conn, DtDataQueryPduCb  cb, void *  usr  )

static

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

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

static

Create a DtDataQueryPdu.

Caller is responsible for deletion.

DtDatumParam DtDataQueryPdu::fixedDatumId

(

int

index

)

const

Set/Get the fixed datum id at the specified index.

void DtDataQueryPdu::initDatumIds	(	unsigned long	numFixedFields,
		unsigned long	numVarFields
	)

Initialize the fixed and variable fields.

DtPduKind DtDataQueryPdu::internalGetPduKind ( ) const

inlineprotectedvirtual

Returns the PDU kind associated with the derived PDU class.

Implements DtPdu.

References DtDataQueryPduKind.

unsigned long DtDataQueryPdu::numFixedFields

(

)

const

Get the number of fixed fields.

unsigned long DtDataQueryPdu::numVarFields

(

)

const

Get the number of variable fields.

virtual void DtDataQueryPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtSimanPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtSimanPdu.

static void DtDataQueryPdu::removeCallback ( DtExerciseConn *  conn, DtDataQueryPduCb  cb, void *  usr  )

static

unsigned long DtDataQueryPdu::requestId

(

)

const

Set/Get the request id.

int DtDataQueryPdu::setFixedDatumId	(	int	index,
		DtDatumParam	id
	)

void DtDataQueryPdu::setRequestId

(

unsigned long

id

)

void DtDataQueryPdu::setTimeInterval

(

DtTime

seconds

)

int DtDataQueryPdu::setVarDatumId	(	int	index,
		DtDatumParam	id
	)

DtTime DtDataQueryPdu::timeInterval

(

)

const

Set/Get the time interval.

DtDatumParam DtDataQueryPdu::varDatumId

(

int

index

)

const

Set/Get the variable datum id at the specified index.

---

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

• queryPdu.h