DtLgcyLgrTotalStatePdu Class Reference

Instances of DtLgcyLgrTotalStatePdu are used to convey to a remote logger- controller the total current state of a logger instance. More...

Inheritance diagram for DtLgcyLgrTotalStatePdu:

Collaboration diagram for DtLgcyLgrTotalStatePdu:

Public Member Functions
	DtLgcyLgrTotalStatePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	(default) constructor More...
	DtLgcyLgrTotalStatePdu (const DtNetLgcyLgrControlPdu *, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Construct from network representation. More...
	DtLgcyLgrTotalStatePdu (DtGlobalObjectDesignator &sender, DtGlobalObjectDesignator &receiver, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Construct and prepare for send. More...
virtual	~DtLgcyLgrTotalStatePdu ()
	Destructor. More...
	DtLgcyLgrTotalStatePdu (const DtLgcyLgrTotalStatePdu &)
	Copy constructor. More...
DtLgcyLgrTotalStatePdu &	operator= (const DtLgcyLgrTotalStatePdu &)
	Assignment operator. More...
virtual DtLgcyLgrStateDesc *	params () const
	Return correctly casted parameters pointer; see legacyLgrControlP.h. More...
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 DtLgcyLgrFilePosition	filePos () const
virtual void	setFilePos (DtLgcyLgrFilePosition pos)
virtual DtLgcyLgrMode	mode () const
virtual void	setMode (DtLgcyLgrMode md)
virtual DtLgcyLgrMode	playAction () const
virtual void	setPlayAction (DtLgcyLgrMode md)
virtual DtLgcyLgrMode	recordAction () const
virtual void	setRecordAction (DtLgcyLgrMode md)
virtual DtLgcyLgrMode	eofAction () const
virtual void	setEofAction (DtLgcyLgrMode 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 char *name)
virtual const char *	annotationsFile () const
virtual void	setAnnotationsFile (const char *name)
virtual void	printData () const
	Print contents. More...
Public Member Functions inherited from DtLgcyLgrControlPdu
	DtLgcyLgrControlPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	(default) constructor More...
	DtLgcyLgrControlPdu (const DtNetLgcyLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	constructor (constructs from network representation) More...
virtual	~DtLgcyLgrControlPdu ()
	destructor More...
	DtLgcyLgrControlPdu (const DtLgcyLgrControlPdu &src)
	copy constructor More...
DtLgcyLgrControlPdu &	operator= (const DtLgcyLgrControlPdu &src)
	assignment operator More...
const DtGlobalObjectDesignator &	receiverId () const
	Get/set Object Identifier of intended recipient (logger). More...
virtual void	setReceiverId (const DtGlobalObjectDesignator &id)
virtual const DtGlobalObjectDesignator &	senderId () const
	Get/set Object Identifier of sender, if applicable. More...
virtual void	setSenderId (const DtGlobalObjectDesignator &id)
DtLgrCommand	lgrCommand () const
	Get message-type for proper casting to a subclass. More...
DtNetLgcyLgrControlParams *	defaultParams () const
	Data place holder. More...

Protected Member Functions
void	initLgrDesc ()
	Used by constructors and such... More...
void	copyLgrDesc (const DtLgcyLgrStateDesc *src)
Protected Member Functions inherited from DtLgcyLgrControlPdu
DtPduKind	internalGetPduKind () const
	Identity for use by toolkit. More...
void	setLgrCommand (DtLgrCommand com)
	Set is done by constructing the proper subclass. More...

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. More...
static DtLgcyLgrControlPdu *	create (DtLgrCommand command)
	Create a PDU from DtLgrCommand. More...
static const char *	lgrModeEnum2string (DtLgcyLgrMode md)
	The name (as a string) of a 'DtLgcyLgrMode'-type enum (from value) More...
static const char *	lgrFilePosEnum2string (DtLgcyLgrFilePosition pos)
	The name (as a string) of a 'DtLgcyLgrFilePosition'-type enum (from value) More...
static const char *	lgrStateFlag2string (DtLgcyLgrCtrlFlagStates flg)
	The name (as a string) of a 'DtLgcyLgrCtrlFlagStates'-type enum (from value) More...

Detailed Description

Instances of DtLgcyLgrTotalStatePdu are used to convey to a remote logger- controller the total current state of a logger instance.

Constructor & Destructor Documentation

DtLgcyLgrTotalStatePdu::DtLgcyLgrTotalStatePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

(default) constructor

DtLgcyLgrTotalStatePdu::DtLgcyLgrTotalStatePdu	(	const DtNetLgcyLgrControlPdu *	,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Construct from network representation.

DtLgcyLgrTotalStatePdu::DtLgcyLgrTotalStatePdu	(	DtGlobalObjectDesignator &	sender,
		DtGlobalObjectDesignator &	receiver,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Construct and prepare for send.

virtual DtLgcyLgrTotalStatePdu::~DtLgcyLgrTotalStatePdu ( )

virtual

Destructor.

DtLgcyLgrTotalStatePdu::DtLgcyLgrTotalStatePdu

(

const DtLgcyLgrTotalStatePdu &

)

Copy constructor.

Member Function Documentation

virtual const char* DtLgcyLgrTotalStatePdu::annotationsFile ( ) const

virtual

void DtLgcyLgrTotalStatePdu::copyLgrDesc ( const DtLgcyLgrStateDesc *  src )

protected

virtual bool DtLgcyLgrTotalStatePdu::dataScaling ( ) const

virtual

virtual DtLgcyLgrMode DtLgcyLgrTotalStatePdu::eofAction ( ) const

virtual

virtual DtTime DtLgcyLgrTotalStatePdu::fileLength ( ) const

virtual

virtual DtLgcyLgrFilePosition DtLgcyLgrTotalStatePdu::filePos ( ) const

virtual

virtual DtTime DtLgcyLgrTotalStatePdu::heartbeat ( ) const

virtual

virtual DtTime DtLgcyLgrTotalStatePdu::idealTime ( ) const

virtual

void DtLgcyLgrTotalStatePdu::initLgrDesc ( )

protected

Used by constructors and such...

virtual const char* DtLgcyLgrTotalStatePdu::lgrFile ( ) const

virtual

virtual DtLgcyLgrMode DtLgcyLgrTotalStatePdu::mode ( ) const

virtual

DtLgcyLgrTotalStatePdu& DtLgcyLgrTotalStatePdu::operator=

(

const DtLgcyLgrTotalStatePdu &

)

Assignment operator.

virtual DtLgcyLgrStateDesc* DtLgcyLgrTotalStatePdu::params ( ) const

virtual

Return correctly casted parameters pointer; see legacyLgrControlP.h.

virtual DtLgcyLgrMode DtLgcyLgrTotalStatePdu::playAction ( ) const

virtual

virtual void DtLgcyLgrTotalStatePdu::printData ( ) const

virtual

Print contents.

Reimplemented from DtLgcyLgrControlPdu.

virtual DtLgcyLgrMode DtLgcyLgrTotalStatePdu::recordAction ( ) const

virtual

virtual double DtLgcyLgrTotalStatePdu::scale ( ) const

virtual

virtual void DtLgcyLgrTotalStatePdu::setAnnotationsFile ( const char *  name )

virtual

virtual void DtLgcyLgrTotalStatePdu::setDataScaling ( bool  onOff )

virtual

virtual void DtLgcyLgrTotalStatePdu::setEofAction ( DtLgcyLgrMode  md )

virtual

virtual void DtLgcyLgrTotalStatePdu::setFileLength ( DtTime  tm )

virtual

virtual void DtLgcyLgrTotalStatePdu::setFilePos ( DtLgcyLgrFilePosition  pos )

virtual

virtual void DtLgcyLgrTotalStatePdu::setHeartbeat ( DtTime  tm )

virtual

virtual void DtLgcyLgrTotalStatePdu::setIdealTime ( DtTime  tm )

virtual

virtual void DtLgcyLgrTotalStatePdu::setLgrFile ( const char *  name )

virtual

virtual void DtLgcyLgrTotalStatePdu::setMode ( DtLgcyLgrMode  md )

virtual

virtual void DtLgcyLgrTotalStatePdu::setPlayAction ( DtLgcyLgrMode  md )

virtual

virtual void DtLgcyLgrTotalStatePdu::setRecordAction ( DtLgcyLgrMode  md )

virtual

virtual void DtLgcyLgrTotalStatePdu::setScale ( double  sc )

virtual

virtual void DtLgcyLgrTotalStatePdu::setTime ( DtTime  tm )

virtual

virtual void DtLgcyLgrTotalStatePdu::setTimeConstrained ( bool  onOff )

virtual

virtual void DtLgcyLgrTotalStatePdu::setTimeout ( DtTime  tm )

virtual

virtual void DtLgcyLgrTotalStatePdu::setTimeRegulated ( bool  onOff )

virtual

virtual void DtLgcyLgrTotalStatePdu::setUsingOwnFedAmb ( bool  onOff )

virtual

virtual DtTime DtLgcyLgrTotalStatePdu::time ( ) const

virtual

virtual bool DtLgcyLgrTotalStatePdu::timeConstrained ( ) const

virtual

virtual DtTime DtLgcyLgrTotalStatePdu::timeout ( ) const

virtual

virtual bool DtLgcyLgrTotalStatePdu::timeRegulated ( ) const

virtual

virtual bool DtLgcyLgrTotalStatePdu::usingOwnFedAmb ( ) const

virtual

---

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

• legacyLcTotalState.h