VR-Link API Documentation for DIS
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes
DtDataQueryRPdu Class Reference

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

+ Inheritance diagram for DtDataQueryRPdu:
+ Collaboration diagram for DtDataQueryRPdu:

Public Member Functions

 DtDataQueryRPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtDataQueryRPdu (const DtNetDataQueryRPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtDataQueryRPdu (const DtDataQueryRPdu &orig)
virtual ~DtDataQueryRPdu ()
 destructor
DtDataQueryRPduoperator= (const DtDataQueryRPdu &orig)
 Assignment operator.
virtual void setRequestId (unsigned long id)
 Set/Get the request id.
virtual unsigned long requestId () const
virtual void setTimeInterval (DtTime seconds)
 Set/Get the time interval.
virtual DtTime timeInterval () const
virtual unsigned long numFixedFields () const
 Get the number of fixed fields.
virtual unsigned long numVarFields () const
 Get the number of variable fields.
virtual int setFixedDatumId (int index, DtDatumParam id)
 Set/Get the fixed datum id at the specified index.
virtual DtDatumParam fixedDatumId (int index) const
virtual int setVarDatumId (int index, DtDatumParam id)
 Set/Get the variable datum id at the specified index.
virtual DtDatumParam varDatumId (int index) const
virtual void setReqRelService (DtRequiredReliabilityService value)
 Set/Get the required reliability service.
virtual
DtRequiredReliabilityService 
reqRelService () const
virtual 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
DtSimanPduoperator= (const DtSimanPdu &orig)
 Assignment operator.
virtual const DtEntityIdentifiersenderId () const
 Get the sender ID.
virtual const DtEntityIdentifierreceiverId () 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
DtInteractionoperator= (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.
DtPduoperator= (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 DtNetPduHeadernetHeader () 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.
DtBaseMsgoperator= (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 DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Create a DtDataQueryRPdu.
static void addCallback (DtExerciseConn *conn, DtDataQueryRPduCb cb, void *usr)
 Add (register)/Remove (deregister) function to be called when pdu is received.
static void removeCallback (DtExerciseConn *conn, DtDataQueryRPduCb cb, void *usr)

Protected Member Functions

virtual DtPduKind internalGetPduKind () const
 Returns the internal PDU kind.

Static Protected Attributes

static const int theStaticSize

Additional Inherited Members

- Protected Attributes inherited from DtSimanPdu
DtEntityIdentifier cache

Detailed Description

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

Constructor & Destructor Documentation

DtDataQueryRPdu::DtDataQueryRPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

DtDataQueryRPdu::DtDataQueryRPdu ( const DtNetDataQueryRPdu initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtDataQueryRPdu::DtDataQueryRPdu ( const DtDataQueryRPdu orig)
virtual DtDataQueryRPdu::~DtDataQueryRPdu ( )
virtual

destructor

Member Function Documentation

static void DtDataQueryRPdu::addCallback ( DtExerciseConn conn,
DtDataQueryRPduCb  cb,
void *  usr 
)
static

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

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

Create a DtDataQueryRPdu.

Caller is responsible for deletion.

virtual DtDatumParam DtDataQueryRPdu::fixedDatumId ( int  index) const
virtual
virtual void DtDataQueryRPdu::initDatumIds ( unsigned long  numFixedFields,
unsigned long  numVarFields 
)
virtual

Initialize the fixed and variable fields.

DtPduKind DtDataQueryRPdu::internalGetPduKind ( ) const
inlineprotectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

References DtDataQueryRPduKind.

virtual unsigned long DtDataQueryRPdu::numFixedFields ( ) const
virtual

Get the number of fixed fields.

virtual unsigned long DtDataQueryRPdu::numVarFields ( ) const
virtual

Get the number of variable fields.

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

Assignment operator.

virtual void DtDataQueryRPdu::printData ( ) const
virtual

Print the data contained by this PDU.

Reimplemented from DtSimanPdu.

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

Print the data to a stream.

Reimplemented from DtSimanPdu.

static void DtDataQueryRPdu::removeCallback ( DtExerciseConn conn,
DtDataQueryRPduCb  cb,
void *  usr 
)
static
virtual DtRequiredReliabilityService DtDataQueryRPdu::reqRelService ( ) const
virtual
virtual unsigned long DtDataQueryRPdu::requestId ( ) const
virtual
virtual int DtDataQueryRPdu::setFixedDatumId ( int  index,
DtDatumParam  id 
)
virtual

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

virtual void DtDataQueryRPdu::setReqRelService ( DtRequiredReliabilityService  value)
virtual

Set/Get the required reliability service.

virtual void DtDataQueryRPdu::setRequestId ( unsigned long  id)
virtual

Set/Get the request id.

virtual void DtDataQueryRPdu::setTimeInterval ( DtTime  seconds)
virtual

Set/Get the time interval.

virtual int DtDataQueryRPdu::setVarDatumId ( int  index,
DtDatumParam  id 
)
virtual

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

virtual DtTime DtDataQueryRPdu::timeInterval ( ) const
virtual
virtual DtDatumParam DtDataQueryRPdu::varDatumId ( int  index) const
virtual

Member Data Documentation

const int DtDataQueryRPdu::theStaticSize
staticprotected

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

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)