DtLgcyLgrHeartbeatPdu Class Reference

Instances of DtLgcyLgrHeartbeatPdu are to tell a remote logger to send a packet for each playback entity at least every HEARTBEAT seconds. More...

Inheritance diagram for DtLgcyLgrHeartbeatPdu:

Collaboration diagram for DtLgcyLgrHeartbeatPdu:

Public Member Functions
	DtLgcyLgrHeartbeatPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	(default) constructor
	DtLgcyLgrHeartbeatPdu (const DtNetLgcyLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	constructor (construct from network representation)
	DtLgcyLgrHeartbeatPdu (DtGlobalObjectDesignator &sender, DtGlobalObjectDesignator &receiver, DtReal hbeat, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	constructor (construct and prepare for send)
virtual	~DtLgcyLgrHeartbeatPdu ()
	destructor
	DtLgcyLgrHeartbeatPdu (const DtLgcyLgrHeartbeatPdu &src)
	copy constructor
DtLgcyLgrHeartbeatPdu &	operator= (const DtLgcyLgrHeartbeatPdu &src)
	assignment operator
virtual DtReal	heartbeat () const
	Get/set the heartbeat. See class description.
virtual void	setHeartbeat (DtReal val)
virtual DtLgcyLgrRealParams *	params () 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, DtPduFactory *pduFactory=0)
	constructor (constructs from network representation)
virtual	~DtLgcyLgrControlPdu ()
	destructor
	DtLgcyLgrControlPdu (const DtLgcyLgrControlPdu &src)
	copy constructor
DtLgcyLgrControlPdu &	operator= (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.
DtNetLgcyLgrControlParams *	defaultParams () const
	Data place holder.

Private Attributes
DtReal	myHeartbeat
	Parameter.

Additional Inherited Members
Static Public Member Functions inherited from DtLgcyLgrControlPdu
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	Create a PDU representation from a network packet.
static DtLgcyLgrControlPdu *	create (DtLgrCommand command)
	Create a PDU from DtLgrCommand.
static void	addCallback (DtExerciseConn *conn, DtLgcyLgrControlInteractionCb cb, void *usr)
	DIS – install/remove handler to call when receiving a LC packet.
static void	removeCallback (DtExerciseConn *conn, DtLgcyLgrControlInteractionCb cb, void *usr)
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 DtLgcyLgrHeartbeatPdu are to tell a remote logger to send a packet for each playback entity at least every HEARTBEAT seconds.

Important when in slow-motion.

Constructor & Destructor Documentation

DtLgcyLgrHeartbeatPdu::DtLgcyLgrHeartbeatPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

(default) constructor

DtLgcyLgrHeartbeatPdu::DtLgcyLgrHeartbeatPdu	(	const DtNetLgcyLgrControlPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

constructor (construct from network representation)

DtLgcyLgrHeartbeatPdu::DtLgcyLgrHeartbeatPdu	(	DtGlobalObjectDesignator &	sender,
		DtGlobalObjectDesignator &	receiver,
		DtReal	hbeat,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

constructor (construct and prepare for send)

virtual DtLgcyLgrHeartbeatPdu::~DtLgcyLgrHeartbeatPdu ( )

virtual

destructor

DtLgcyLgrHeartbeatPdu::DtLgcyLgrHeartbeatPdu

(

const DtLgcyLgrHeartbeatPdu &

src

)

copy constructor

Member Function Documentation

virtual DtReal DtLgcyLgrHeartbeatPdu::heartbeat ( ) const

virtual

Get/set the heartbeat. See class description.

DtLgcyLgrHeartbeatPdu& DtLgcyLgrHeartbeatPdu::operator=

(

const DtLgcyLgrHeartbeatPdu &

src

)

assignment operator

virtual DtLgcyLgrRealParams* DtLgcyLgrHeartbeatPdu::params ( ) const

virtual

Return correctly casted parameters pointer; see legacyLgrControlP.h.

virtual void DtLgcyLgrHeartbeatPdu::printData ( ) const

virtual

Diagnostic output.

Reimplemented from DtLgcyLgrControlPdu.

virtual void DtLgcyLgrHeartbeatPdu::setHeartbeat ( DtReal  val )

virtual

Member Data Documentation

DtReal DtLgcyLgrHeartbeatPdu::myHeartbeat

private

Parameter.

---

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

• legacyLcHeartbeat.h