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

class DtAcknowledgeRPdu: More...

+ Inheritance diagram for DtAcknowledgeRPdu:
+ Collaboration diagram for DtAcknowledgeRPdu:

Public Member Functions

 DtAcknowledgeRPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAcknowledgeRPdu (const DtNetAcknowledgeRPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtAcknowledgeRPdu (const DtAcknowledgeRPdu &orig)
virtual ~DtAcknowledgeRPdu ()
 destructor
DtAcknowledgeRPduoperator= (const DtAcknowledgeRPdu &orig)
 Assignment operator.
virtual void setAcknowledgeFlag (DtAcknowledgeFlag flag)
 Set/Get the acknowledge flag.
virtual DtAcknowledgeFlag acknowledgeFlag () const
virtual void setResponseFlag (DtResponseFlag flag)
 Set/Get the response flag.
virtual DtResponseFlag responseFlag () const
virtual void setRequestId (int id)
 Set/Get the request id.
virtual int requestId () 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 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 DtAcknowledgeRPdu.
static void addCallback (DtExerciseConn *conn, DtAcknowledgeRPduCb cb, void *usr)
 Add (register)/Remove (deregister) function to be called when pdu is received.
static void removeCallback (DtExerciseConn *conn, DtAcknowledgeRPduCb cb, void *usr)

Protected Member Functions

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

Static Protected Attributes

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

Additional Inherited Members

- Protected Attributes inherited from DtSimanPdu
DtEntityIdentifier cache

Detailed Description

class DtAcknowledgeRPdu:

Instances of DtAcknowledgeRPdu are used to send reliable acknowledge PDUs.

Constructor & Destructor Documentation

DtAcknowledgeRPdu::DtAcknowledgeRPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

DtAcknowledgeRPdu::DtAcknowledgeRPdu ( const DtNetAcknowledgeRPdu initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtAcknowledgeRPdu::DtAcknowledgeRPdu ( const DtAcknowledgeRPdu orig)
virtual DtAcknowledgeRPdu::~DtAcknowledgeRPdu ( )
virtual

destructor

Member Function Documentation

virtual DtAcknowledgeFlag DtAcknowledgeRPdu::acknowledgeFlag ( ) const
virtual
static void DtAcknowledgeRPdu::addCallback ( DtExerciseConn conn,
DtAcknowledgeRPduCb  cb,
void *  usr 
)
static

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

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

Create a DtAcknowledgeRPdu.

Caller is responsible for deletion.

DtPduKind DtAcknowledgeRPdu::internalGetPduKind ( ) const
inlineprotectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

References DtAcknowledgeRPduKind.

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

Assignment operator.

virtual void DtAcknowledgeRPdu::printData ( ) const
virtual

Print the data contained by this PDU.

Reimplemented from DtSimanPdu.

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

Print the data to a stream.

Reimplemented from DtSimanPdu.

static void DtAcknowledgeRPdu::removeCallback ( DtExerciseConn conn,
DtAcknowledgeRPduCb  cb,
void *  usr 
)
static
virtual int DtAcknowledgeRPdu::requestId ( ) const
virtual
virtual DtResponseFlag DtAcknowledgeRPdu::responseFlag ( ) const
virtual
virtual void DtAcknowledgeRPdu::setAcknowledgeFlag ( DtAcknowledgeFlag  flag)
virtual

Set/Get the acknowledge flag.

virtual void DtAcknowledgeRPdu::setRequestId ( int  id)
virtual

Set/Get the request id.

virtual void DtAcknowledgeRPdu::setResponseFlag ( DtResponseFlag  flag)
virtual

Set/Get the response flag.

Member Data Documentation

const int DtAcknowledgeRPdu::theStaticSize
staticprotected

Size of PDU with zero data bytes.


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)