VR-Link API Documentation for DIS
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtStopFreezePdu Class Reference

Instances of DtStopFreezePdu are used to send/receive stop/freeze PDUs. More...

+ Inheritance diagram for DtStopFreezePdu:
+ Collaboration diagram for DtStopFreezePdu:

List of all members.

Public Types

enum  { PduStaticSize = 40 }

Public Member Functions

 DtStopFreezePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtStopFreezePdu (const DtNetStopFreezePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtStopFreezePdu (const DtEntityIdentifier &to, const DtEntityIdentifier &from, const DtTime realTime, DtStopReason reason, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
DtTime realWorldTime () const
 Set/Get real world time.
void setRealWorldTime (const DtTime time)
DtStopReason reason () const
 Set/Get the stop reason.
void setReason (DtStopReason reason)
int frozenBehavior () const
 Set/Get the frozen behavior.
void setFrozenBehavior (int behavior)
int requestId () const
 Set/Get the request id.
void setRequestId (int id)
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 DtStopFreezePdu.
static void addCallback (DtExerciseConn *conn, DtStopFreezePduCb cb, void *usr)
 Add (register)/Remove (deregister) function to be called when pdu is received.
static void removeCallback (DtExerciseConn *conn, DtStopFreezePduCb cb, void *usr)

Protected Member Functions

DtPduKind internalGetPduKind () const
 Returns the internal PDU kind.

Detailed Description

Instances of DtStopFreezePdu are used to send/receive stop/freeze PDUs.


Member Enumeration Documentation

anonymous enum
Enumerator:
PduStaticSize 

Constructor & Destructor Documentation

Constructors.

DtStopFreezePdu::DtStopFreezePdu ( const DtEntityIdentifier to,
const DtEntityIdentifier from,
const DtTime  realTime,
DtStopReason  reason,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Member Function Documentation

static void DtStopFreezePdu::addCallback ( DtExerciseConn conn,
DtStopFreezePduCb  cb,
void *  usr 
) [static]

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

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

Create a DtStopFreezePdu.

Caller is responsible for deletion.

Set/Get the frozen behavior.

DtPduKind DtStopFreezePdu::internalGetPduKind ( ) const [inline, protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

References DtStopFreezePduKind.

virtual void DtStopFreezePdu::printData ( ) const [virtual]

Print the data contained by this PDU.

Reimplemented from DtSimanPdu.

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

Print the data to a stream.

Reimplemented from DtSimanPdu.

Set/Get real world time.

Set/Get the stop reason.

static void DtStopFreezePdu::removeCallback ( DtExerciseConn conn,
DtStopFreezePduCb  cb,
void *  usr 
) [static]

Set/Get the request id.

void DtStopFreezePdu::setFrozenBehavior ( int  behavior)

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)