MAK Data Logger API Documentation for HLA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions

Instances of DtLgrLgrHeartbeatPdu are used for fault tolerance indicating that the logger is still active. More...

+ Inheritance diagram for DtLgrLgrHeartbeatPdu:
+ Collaboration diagram for DtLgrLgrHeartbeatPdu:

Public Member Functions

 DtLgrLgrHeartbeatPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 (default) constructor
 DtLgrLgrHeartbeatPdu (const DtNetLgrControlPdu *, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 Construct from network representation.
 DtLgrLgrHeartbeatPdu (const DtEntityIdentifier &sender, const DtEntityIdentifier &receiver, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Construct and prepare for send.
virtual ~DtLgrLgrHeartbeatPdu ()
 Destructor.
 DtLgrLgrHeartbeatPdu (const DtLgrLgrHeartbeatPdu &)
 Copy constructor.
DtLgrLgrHeartbeatPduoperator= (const DtLgrLgrHeartbeatPdu &)
 Assignment operator.
- Public Member Functions inherited from DtLgrTotalStatePdu
 DtLgrTotalStatePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 (default) constructor
 DtLgrTotalStatePdu (const DtNetLgrControlPdu *, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 Construct from network representation.
 DtLgrTotalStatePdu (const DtEntityIdentifier &sender, const DtEntityIdentifier &receiver, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Construct and prepare for send.
virtual ~DtLgrTotalStatePdu ()
 Destructor.
 DtLgrTotalStatePdu (const DtLgrTotalStatePdu &)
 Copy constructor.
DtLgrTotalStatePduoperator= (const DtLgrTotalStatePdu &)
 Assignment operator.
virtual DtTime time () const
virtual void setTime (DtTime tm)
virtual DtTime idealTime () const
virtual void setIdealTime (DtTime tm)
virtual double scale () const
virtual void setScale (double sc)
virtual DtTime fileLength () const
virtual void setFileLength (DtTime tm)
virtual DtTime heartbeat () const
virtual void setHeartbeat (DtTime tm)
virtual DtTime timeout () const
virtual void setTimeout (DtTime tm)
virtual bool dataScaling () const
virtual void setDataScaling (bool onOff)
virtual DtLgrFilePosition filePos () const
virtual void setFilePos (DtLgrFilePosition pos)
virtual DtLgrMode mode () const
virtual void setMode (DtLgrMode md)
virtual DtLgrMode playAction () const
virtual void setPlayAction (DtLgrMode md)
virtual DtLgrMode recordAction () const
virtual void setRecordAction (DtLgrMode md)
virtual DtLgrMode eofAction () const
virtual void setEofAction (DtLgrMode md)
virtual bool timeConstrained () const
virtual void setTimeConstrained (bool onOff)
virtual bool timeRegulated () const
virtual void setTimeRegulated (bool onOff)
virtual bool usingOwnFedAmb () const
virtual void setUsingOwnFedAmb (bool onOff)
virtual const char * lgrFile () const
virtual void setLgrFile (const DtString &name)
virtual const char * annotationsFile () const
virtual void setAnnotationsFile (const DtString &name)
virtual void printDataToStream (std::ostream &stream) const
 Print contents.
- Public Member Functions inherited from DtLgrControlPdu
 DtLgrControlPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, int pduSize=sizeof(DtNetLgrControlPdu))
 (default) constructor
 DtLgrControlPdu (const DtNetLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 constructor (constructs from network representation)
virtual ~DtLgrControlPdu ()
 destructor
 DtLgrControlPdu (const DtLgrControlPdu &src)
 copy constructor
DtLgrControlPduoperator= (const DtLgrControlPdu &src)
 assignment operator
virtual const DtEntityIdentifier & receiverId () const
 Get/set identifier of intended recipient (logger).
virtual void setReceiverId (const DtEntityIdentifier &id)
virtual const DtEntityIdentifier & senderId () const
 Get/set identifier of sender, if applicable.
virtual void setSenderId (const DtEntityIdentifier &id)
virtual DtLgrCommand lgrCommand () const
 Get message-type for proper casting to a subclass.
virtual DtU16 lctVersion () const
 Get/set version.
void setLctVersion (DtU16 versionNumber)
 Called in constructor so not virtual.
virtual DtU32 sequence () const
 Get/set sequence number.
virtual void setSequence (DtU32 sequenceNumber)
virtual bool checkVersion () const
 Check that this PDU's LCT version is compatible.

Additional Inherited Members

- Static Public Member Functions inherited from DtLgrControlPdu
static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 Create a PDU representation from a network packet.
static DtLgrControlPducreate (DtLgrCommand command)
 Create a PDU from DtLgrCommand.
static DtLgrControlPducreate (DtLgrCommandExt command)
 Create a PDU from DtLgrCommandExt.
static bool checkVersion (DtNetLgrControlPdu *header)
 Given a LC header, check that the LCT version is compatible.
static DtU16 addressWildcard ()
 Wildcard value for addresses.
static const DtEntityIdentifier & wildcardAddress ()
 Wildcard address.
static const char * lgrModeEnum2string (DtLgrMode md)
 The name (as a string) of a 'DtLgrMode'-type enum (from value)
static const char * lgrFilePosEnum2string (DtLgrFilePosition pos)
 The name (as a string) of a 'DtLgrFilePosition'-type enum (from value)
static const char * lgrStateFlag2string (DtLgrCtrlFlagStates flg)
 The name (as a string) of a 'DtLgrCtrlFlagStates'-type enum (from value)
- Static Public Attributes inherited from DtLgrControlPdu
static bool theDisableCheckVersion
 Enable/Disable version check.
- Protected Member Functions inherited from DtLgrTotalStatePdu
void initData ()
 Used by constructors and such...
virtual DtLgrStateDescparams () const
 Return correctly casted parameters pointer; see lgrControlP.h.
- Protected Attributes inherited from DtLgrControlPdu
DtEntityIdentifier mySenderId
 Parameter.
DtEntityIdentifier myReceiverId
- Static Protected Attributes inherited from DtLgrControlPdu
static const DtU16 theAddressWildcard = ((1<<16)-1)
static const DtEntityIdentifier theWildcardAddress

Detailed Description

Instances of DtLgrLgrHeartbeatPdu are used for fault tolerance indicating that the logger is still active.

The message is used to carry a small set of state data.

Constructor & Destructor Documentation

DtLgrLgrHeartbeatPdu::DtLgrLgrHeartbeatPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

(default) constructor

DtLgrLgrHeartbeatPdu::DtLgrLgrHeartbeatPdu ( const DtNetLgrControlPdu ,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER,
DtPduFactory *  pduFactory = 0 
)

Construct from network representation.

DtLgrLgrHeartbeatPdu::DtLgrLgrHeartbeatPdu ( const DtEntityIdentifier &  sender,
const DtEntityIdentifier &  receiver,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Construct and prepare for send.

virtual DtLgrLgrHeartbeatPdu::~DtLgrLgrHeartbeatPdu ( )
virtual

Destructor.

DtLgrLgrHeartbeatPdu::DtLgrLgrHeartbeatPdu ( const DtLgrLgrHeartbeatPdu )

Copy constructor.

Member Function Documentation

DtLgrLgrHeartbeatPdu& DtLgrLgrHeartbeatPdu::operator= ( const DtLgrLgrHeartbeatPdu )

Assignment operator.


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

Document ID: Generated on Thu Jul 23 15:05:27 EDT 2020 from SVN revision 215371
Copyright © 2020 MAK Technologies. All Rights Reserved (www.mak.com)