VR-Link API Documentation for DIS
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtRecordPdu Class Reference

Instances of DtRecordPdu are used to send responses to the Record Query PDU. More...

+ Inheritance diagram for DtRecordPdu:
+ Collaboration diagram for DtRecordPdu:

List of all members.

Public Member Functions

 DtRecordPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtRecordPdu (const DtNetRecordPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtRecordPdu (const DtRecordPdu &orig)
virtual ~DtRecordPdu ()
 destructor
DtRecordPduoperator= (const DtRecordPdu &orig)
 Assignment operator.
virtual void setOriginatingEntityID (const DtEntityIdentifier &entity)
 Set/Get originating entity identifier.
virtual const DtEntityIdentifieroriginatingEntityID () const
virtual void setReceivingEntityID (const DtEntityIdentifier &entity)
 Set/Get receiving entity identifier.
virtual const DtEntityIdentifierreceivingEntityID () 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 setResponseSerialNumber (DtU32 num)
 Set/Get the response serial number.
virtual DtU32 responseSerialNumber () 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.

Static Public Member Functions

static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Create a DtRecordPdu.
static void addCallback (DtExerciseConn *conn, DtRecordPduCb cb, void *usr)
 Add (register)/Remove (deregister) function to be called when pdu is received.
static void removeCallback (DtExerciseConn *conn, DtRecordPduCb cb, void *usr)

Protected Member Functions

virtual DtNetRecordSetPdunetRecordSetPduStruct () const
 Returns a pointer to the beginning of the record set data struct.
virtual DtPduKind internalGetPduKind () const
 Returns the internal PDU kind.
virtual DtNetRecordPdunetPduStruct () const
 Casts the netPdu element to our network struct.
DtRecordPduself () const
 Casts the 'this' pointer for changing elements in a const function.

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 DtRecordPdu are used to send responses to the Record Query PDU.


Constructor & Destructor Documentation

Constructors.

virtual DtRecordPdu::~DtRecordPdu ( ) [virtual]

destructor


Member Function Documentation

static void DtRecordPdu::addCallback ( DtExerciseConn conn,
DtRecordPduCb  cb,
void *  usr 
) [static]

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

static DtPdu* DtRecordPdu::create ( const DtNetPacket initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
) [static]

Create a DtRecordPdu.

Caller is responsible for deletion.

virtual DtEventType DtRecordPdu::eventType ( ) const [virtual]
virtual DtPduKind DtRecordPdu::internalGetPduKind ( ) const [protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

virtual DtNetRecordPdu* DtRecordPdu::netPduStruct ( ) const [protected, virtual]

Casts the netPdu element to our network struct.

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

virtual DtNetRecordSetPdu* DtRecordPdu::netRecordSetPduStruct ( ) const [protected, virtual]

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

Implements DtRecordSetPdu.

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

Assignment operator.

virtual const DtEntityIdentifier& DtRecordPdu::originatingEntityID ( ) const [virtual]
virtual void DtRecordPdu::printData ( ) const [virtual]

Print the data contained by this PDU.

Reimplemented from DtRecordSetPdu.

virtual void DtRecordPdu::printDataToStream ( std::ostream &  stream) const [virtual]

Print the data to a stream.

Reimplemented from DtRecordSetPdu.

virtual const DtEntityIdentifier& DtRecordPdu::receivingEntityID ( ) const [virtual]
static void DtRecordPdu::removeCallback ( DtExerciseConn conn,
DtRecordPduCb  cb,
void *  usr 
) [static]
virtual DtU32 DtRecordPdu::requestID ( ) const [virtual]
virtual DtU32 DtRecordPdu::responseSerialNumber ( ) const [virtual]
DtRecordPdu* DtRecordPdu::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 DtRecordPdu::setEventType ( DtEventType  type) [virtual]

Set/Get the event type.

virtual void DtRecordPdu::setOriginatingEntityID ( const DtEntityIdentifier entity) [virtual]

Set/Get originating entity identifier.

virtual void DtRecordPdu::setReceivingEntityID ( const DtEntityIdentifier entity) [virtual]

Set/Get receiving entity identifier.

virtual void DtRecordPdu::setReqRelService ( enum DtRequiredReliabilityService  service) [virtual]

Set/Get required reliability service.

virtual void DtRecordPdu::setRequestID ( DtU32  id) [virtual]

Set/Get request ID.

virtual void DtRecordPdu::setResponseSerialNumber ( DtU32  num) [virtual]

Set/Get the response serial number.


Member Data Documentation

Temporary objects for reference returns.

const int DtRecordPdu::theStaticSize [static, protected]

Size of PDU with zero data bytes.


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)