MAK Data Logger API Documentation for HLA
List of all members | Public Member Functions | Private Attributes
DtLgcyLgrTimeoutPdu Class Reference

Instances of DtLgcyLgrTimeoutPdu are to tell a remote logger how long to generate interim packets for an entity before assuming no more packets in file. More...

+ Inheritance diagram for DtLgcyLgrTimeoutPdu:
+ Collaboration diagram for DtLgcyLgrTimeoutPdu:

Public Member Functions

 DtLgcyLgrTimeoutPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 (default) constructor
 DtLgcyLgrTimeoutPdu (const DtNetLgcyLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 constructor (construct from network representation)
 DtLgcyLgrTimeoutPdu (DtGlobalObjectDesignator &sender, DtGlobalObjectDesignator &receiver, DtReal val, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 constructor (construct and prepare for send)
virtual ~DtLgcyLgrTimeoutPdu ()
 destructor
 DtLgcyLgrTimeoutPdu (const DtLgcyLgrTimeoutPdu &src)
 copy constructor
DtLgcyLgrTimeoutPduoperator= (const DtLgcyLgrTimeoutPdu &src)
 assignment operator
virtual DtReal timeout () const
 Get/set timeout. See class description.
virtual void setTimeout (DtReal val)
virtual DtLgcyLgrRealParamsparams () const
 Return correctly casted parameters pointer. See legacyLgrControlP.h.
virtual void printData () const
 Diagnostic output.
- Public Member Functions inherited from DtLgcyLgrControlPdu
 DtLgcyLgrControlPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 (default) constructor
 DtLgcyLgrControlPdu (const DtNetLgcyLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 constructor (constructs from network representation)
virtual ~DtLgcyLgrControlPdu ()
 destructor
 DtLgcyLgrControlPdu (const DtLgcyLgrControlPdu &src)
 copy constructor
DtLgcyLgrControlPduoperator= (const DtLgcyLgrControlPdu &src)
 assignment operator
const DtGlobalObjectDesignator & receiverId () const
 Get/set Object Identifier of intended recipient (logger).
virtual void setReceiverId (const DtGlobalObjectDesignator &id)
virtual const
DtGlobalObjectDesignator & 
senderId () const
 Get/set Object Identifier of sender, if applicable.
virtual void setSenderId (const DtGlobalObjectDesignator &id)
DtLgrCommand lgrCommand () const
 Get message-type for proper casting to a subclass.
DtNetLgcyLgrControlParamsdefaultParams () const
 Data place holder.

Private Attributes

DtReal myTimeout
 Parameter.

Additional Inherited Members

- Static Public Member Functions inherited from DtLgcyLgrControlPdu
static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Create a PDU representation from a network packet.
static DtLgcyLgrControlPducreate (DtLgrCommand command)
 Create a PDU from DtLgrCommand.
static const char * lgrModeEnum2string (DtLgcyLgrMode md)
 The name (as a string) of a 'DtLgcyLgrMode'-type enum (from value)
static const char * lgrFilePosEnum2string (DtLgcyLgrFilePosition pos)
 The name (as a string) of a 'DtLgcyLgrFilePosition'-type enum (from value)
static const char * lgrStateFlag2string (DtLgcyLgrCtrlFlagStates flg)
 The name (as a string) of a 'DtLgcyLgrCtrlFlagStates'-type enum (from value)
- Protected Member Functions inherited from DtLgcyLgrControlPdu
DtPduKind internalGetPduKind () const
 Identity for use by toolkit.
void setLgrCommand (DtLgrCommand com)
 Set is done by constructing the proper subclass.

Detailed Description

Instances of DtLgcyLgrTimeoutPdu are to tell a remote logger how long to generate interim packets for an entity before assuming no more packets in file.

Useful during slow-motion playback.

Constructor & Destructor Documentation

DtLgcyLgrTimeoutPdu::DtLgcyLgrTimeoutPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

(default) constructor

DtLgcyLgrTimeoutPdu::DtLgcyLgrTimeoutPdu ( const DtNetLgcyLgrControlPdu initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

constructor (construct from network representation)

DtLgcyLgrTimeoutPdu::DtLgcyLgrTimeoutPdu ( DtGlobalObjectDesignator &  sender,
DtGlobalObjectDesignator &  receiver,
DtReal  val,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

constructor (construct and prepare for send)

virtual DtLgcyLgrTimeoutPdu::~DtLgcyLgrTimeoutPdu ( )
virtual

destructor

DtLgcyLgrTimeoutPdu::DtLgcyLgrTimeoutPdu ( const DtLgcyLgrTimeoutPdu src)

copy constructor

Member Function Documentation

DtLgcyLgrTimeoutPdu& DtLgcyLgrTimeoutPdu::operator= ( const DtLgcyLgrTimeoutPdu src)

assignment operator

virtual DtLgcyLgrRealParams* DtLgcyLgrTimeoutPdu::params ( ) const
virtual

Return correctly casted parameters pointer. See legacyLgrControlP.h.

virtual void DtLgcyLgrTimeoutPdu::printData ( ) const
virtual

Diagnostic output.

Reimplemented from DtLgcyLgrControlPdu.

virtual void DtLgcyLgrTimeoutPdu::setTimeout ( DtReal  val)
virtual
virtual DtReal DtLgcyLgrTimeoutPdu::timeout ( ) const
virtual

Get/set timeout. See class description.

Member Data Documentation

DtReal DtLgcyLgrTimeoutPdu::myTimeout
private

Parameter.


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

Document ID: Generated on Thu Apr 11 12:13:00 EDT 2013 from SVN revision 126011
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)