VR-Link API Documentation for DIS
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtResupplyReceivedPdu Class Reference
+ Inheritance diagram for DtResupplyReceivedPdu:
+ Collaboration diagram for DtResupplyReceivedPdu:

Public Types

enum  { PduStaticSize = 28 }

Public Member Functions

 DtResupplyReceivedPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtResupplyReceivedPdu (const DtNetResupplyReceivedPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtResupplyReceivedPdu (const DtEntityIdentifier &receiver, const DtEntityIdentifier &supplier, const DtEntityType &supply, float quantity, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
const DtEntityIdentifierreceivingId () const
void setReceivingId (const DtEntityIdentifier &requester)
const DtEntityIdentifiersupplyingId () const
void setSupplyingId (const DtEntityIdentifier &servicer)
int numSupplyTypes () const
void setNumSupplyTypes (int numTypes)
float supplyQuantity (const DtEntityType &supply) const
const DtEntityTypenthSupply (int supplyIndex, float *quantity=0, int *retCode=0) const
void setNthSupply (int supplyIndex, const DtEntityType &supply, float quantity, int *retCode=0)
virtual void printData () const
 Print the PDU's data (not including header).
virtual void printDataToStream (std::ostream &stream) const
- 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)
static void addCallback (DtExerciseConn *conn, DtResupplyReceivedPduCb cb, void *usr)
static void removeCallback (DtExerciseConn *conn, DtResupplyReceivedPduCb cb, void *usr)

Protected Member Functions

DtPduKind internalGetPduKind () const
 Returns the PDU kind associated with the derived PDU class.
int indexInBounds (int ind) const

Protected Attributes

DtEntityIdentifier theId
DtEntityType supType

Member Enumeration Documentation

anonymous enum
Enumerator:
PduStaticSize 

Constructor & Destructor Documentation

DtResupplyReceivedPdu::DtResupplyReceivedPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
DtResupplyReceivedPdu::DtResupplyReceivedPdu ( const DtNetResupplyReceivedPdu initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtResupplyReceivedPdu::DtResupplyReceivedPdu ( const DtEntityIdentifier receiver,
const DtEntityIdentifier supplier,
const DtEntityType supply,
float  quantity,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Member Function Documentation

static void DtResupplyReceivedPdu::addCallback ( DtExerciseConn conn,
DtResupplyReceivedPduCb  cb,
void *  usr 
)
static
static DtPdu* DtResupplyReceivedPdu::create ( const DtNetPacket initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
static
int DtResupplyReceivedPdu::indexInBounds ( int  ind) const
protected
DtPduKind DtResupplyReceivedPdu::internalGetPduKind ( ) const
inlineprotectedvirtual

Returns the PDU kind associated with the derived PDU class.

Implements DtPdu.

References DtResupplyReceivedPduKind.

const DtEntityType& DtResupplyReceivedPdu::nthSupply ( int  supplyIndex,
float *  quantity = 0,
int *  retCode = 0 
) const
int DtResupplyReceivedPdu::numSupplyTypes ( ) const
virtual void DtResupplyReceivedPdu::printData ( ) const
virtual

Print the PDU's data (not including header).

Base DtPdu version just prints hex. Use the printDataToString to put the data into a DtString instead of simply sending the output to stdout. printData() calls printDataToStream(DtInfo).

Reimplemented from DtPdu.

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

Reimplemented from DtPdu.

const DtEntityIdentifier& DtResupplyReceivedPdu::receivingId ( ) const
static void DtResupplyReceivedPdu::removeCallback ( DtExerciseConn conn,
DtResupplyReceivedPduCb  cb,
void *  usr 
)
static
void DtResupplyReceivedPdu::setNthSupply ( int  supplyIndex,
const DtEntityType supply,
float  quantity,
int *  retCode = 0 
)
void DtResupplyReceivedPdu::setNumSupplyTypes ( int  numTypes)
void DtResupplyReceivedPdu::setReceivingId ( const DtEntityIdentifier requester)
void DtResupplyReceivedPdu::setSupplyingId ( const DtEntityIdentifier servicer)
const DtEntityIdentifier& DtResupplyReceivedPdu::supplyingId ( ) const
float DtResupplyReceivedPdu::supplyQuantity ( const DtEntityType supply) const

Member Data Documentation

DtEntityType DtResupplyReceivedPdu::supType
protected
DtEntityIdentifier DtResupplyReceivedPdu::theId
protected

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)