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

Represent an undefined type of PDU. More...

+ Inheritance diagram for DtUnknownPdu:
+ Collaboration diagram for DtUnknownPdu:

Public Types

enum  { PduStaticSize = 12 }

Public Member Functions

 DtUnknownPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtUnknownPdu (const DtNetPduHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual void printDataToStream (std::ostream &stream) const
void setKind (DtPduKind kind)
- 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 printData () const
 Print the PDU's data (not including header).
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)
static void addCallback (DtPduKind kind, DtExerciseConn *conn, DtUnknownPduCb cb, void *usr)
static void removeCallback (DtPduKind kind, DtExerciseConn *conn, DtUnknownPduCb cb, void *usr)

Protected Member Functions

DtPduKind internalGetPduKind () const
 Returns the PDU kind associated with the derived PDU class.
- Protected Member Functions inherited from DtPdu
 DtPdu ()
 Constructor.
virtual void setStatus (int okStatus)
 Sets the PDU's status to okStatus.
virtual void initPdu (int size, DtBufferPtr buffer)
 Must be called after default ctor before PDU is completely constructed.
virtual void initPdu (const void *initial, DtBufferPtr buffer)
 Called by from-net-rep ctor. Initializes DtBaseMsg.
virtual DtProtocolFamily kindToFamily (DtPduKind kind) const
 Maps PDU kind to ProtocolFamily.
virtual void sizeChanged (int size)
 Called by changeSize. Sets the size in the header to size.
virtual void clearData ()
 zeros out all bytes after the PDU header.
virtual void initHeader (DtPduKind kind, int size)
 Initializes PDU header. Called by initPdu.
- Protected Member Functions inherited from DtBaseMsg
 DtBaseMsg ()
 Constructor Object is not fully constructed until initMsg is called.
void initMsg (int size, DtBufferPtr bufferPtr)
void initMsg (const void *initial, int size, DtBufferPtr bufferPtr)
virtual void changeSize (int size)
 Changes the size of the message.
virtual void insertBytes (int offset, int numBytes)
 Inserts numBytes zeroed-out bytes at the indicated offset into the net rep.
virtual void insertBytes (void *address, int numBytes)
 Inserts numBytes zeroed-out bytes at the indicated address.
virtual void deleteBytes (int offset, int numBytes)
 Deletes numBytes bytes at the indicated offset in the net rep.
virtual void deleteBytes (void *address, int numBytes)
 Deletes numBytes bytes starting at the indicated address.
virtual void clearAll ()
 Zeros out all bytes in the network representation.
virtual void * newInternalBuffer (int size)
 Sets myInternalBuff to point to a malloc'ed buffer of size bytes.

Additional Inherited Members

- Protected Attributes inherited from DtPdu
int myOKStatus

Detailed Description

Represent an undefined type of PDU.

Member Enumeration Documentation

anonymous enum
Enumerator:
PduStaticSize 

Constructor & Destructor Documentation

DtUnknownPdu::DtUnknownPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
DtUnknownPdu::DtUnknownPdu ( const DtNetPduHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Member Function Documentation

static void DtUnknownPdu::addCallback ( DtPduKind  kind,
DtExerciseConn conn,
DtUnknownPduCb  cb,
void *  usr 
)
static
static DtPdu* DtUnknownPdu::create ( const DtNetPacket initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
static
DtPduKind DtUnknownPdu::internalGetPduKind ( ) const
protectedvirtual

Returns the PDU kind associated with the derived PDU class.

Implements DtPdu.

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

Reimplemented from DtPdu.

static void DtUnknownPdu::removeCallback ( DtPduKind  kind,
DtExerciseConn conn,
DtUnknownPduCb  cb,
void *  usr 
)
static
void DtUnknownPdu::setKind ( DtPduKind  kind)

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)