DtLgrTotalStatePdu Class Reference

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

Inheritance diagram for DtLgrTotalStatePdu:

Collaboration diagram for DtLgrTotalStatePdu:

Public Member Functions
	DtLgrTotalStatePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	(default) constructor More...
	DtLgrTotalStatePdu (const DtNetLgrControlPdu *, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	Construct from network representation. More...
	DtLgrTotalStatePdu (const DtEntityIdentifier &sender, const DtEntityIdentifier &receiver, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Construct and prepare for send. More...
virtual	~DtLgrTotalStatePdu ()
	Destructor. More...
	DtLgrTotalStatePdu (const DtLgrTotalStatePdu &)
	Copy constructor. More...
DtLgrTotalStatePdu &	operator= (const DtLgrTotalStatePdu &)
	Assignment operator. 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 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. More...
Public Member Functions inherited from DtLgrControlPdu
	DtLgrControlPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, int pduSize=sizeof(DtNetLgrControlPdu))
	(default) constructor More...
	DtLgrControlPdu (const DtNetLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	constructor (constructs from network representation) More...
virtual	~DtLgrControlPdu ()
	destructor More...
	DtLgrControlPdu (const DtLgrControlPdu &src)
	copy constructor More...
DtLgrControlPdu &	operator= (const DtLgrControlPdu &src)
	assignment operator More...
virtual const DtEntityIdentifier &	receiverId () const
	Get/set identifier of intended recipient (logger). More...
virtual void	setReceiverId (const DtEntityIdentifier &id)
virtual const DtEntityIdentifier &	senderId () const
	Get/set identifier of sender, if applicable. More...
virtual void	setSenderId (const DtEntityIdentifier &id)
virtual DtLgrCommand	lgrCommand () const
	Get message-type for proper casting to a subclass. More...
virtual DtU16	lctVersion () const
	Get/set version. More...
void	setLctVersion (DtU16 versionNumber)
	Called in constructor so not virtual. More...
virtual DtU32	sequence () const
	Get/set sequence number. More...
virtual void	setSequence (DtU32 sequenceNumber)
virtual bool	checkVersion () const
	Check that this PDU's LCT version is compatible. More...

Protected Member Functions
void	initData ()
	Used by constructors and such... More...
virtual DtLgrStateDesc *	params () const
	Return correctly casted parameters pointer; see lgrControlP.h. More...
Protected Member Functions inherited from DtLgrControlPdu
virtual void	setLgrCommand (DtLgrCommand com)
	Set is done by constructing the proper subclass. More...
virtual void	setLgrCommand (DtLgrCommandExt com)
	Set is done by constructing the proper subclass. More...
virtual DtNetLgrControlPdu *	controlHeader ()
	Access to the payload as control pdu header. More...
virtual DtNetLgrControlPdu *	controlHeader () const
	Access to the payload as control pdu header. More...
DtPduKind	internalGetPduKind () const
	Identity for use by toolkit. More...

Additional Inherited Members
Static Public Member Functions inherited from DtLgrControlPdu
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	Create a PDU representation from a network packet. More...
static DtLgrControlPdu *	create (DtLgrCommand command)
	Create a PDU from DtLgrCommand. More...
static DtLgrControlPdu *	create (DtLgrCommandExt command)
	Create a PDU from DtLgrCommandExt. More...
static bool	checkVersion (DtNetLgrControlPdu *header)
	Given a LC header, check that the LCT version is compatible. More...
static DtU16	addressWildcard ()
	Wildcard value for addresses. More...
static const DtEntityIdentifier &	wildcardAddress ()
	Wildcard address. More...
static const char *	lgrModeEnum2string (DtLgrMode md)
	The name (as a string) of a 'DtLgrMode'-type enum (from value) More...
static const char *	lgrFilePosEnum2string (DtLgrFilePosition pos)
	The name (as a string) of a 'DtLgrFilePosition'-type enum (from value) More...
static const char *	lgrStateFlag2string (DtLgrCtrlFlagStates flg)
	The name (as a string) of a 'DtLgrCtrlFlagStates'-type enum (from value) More...
Static Public Attributes inherited from DtLgrControlPdu
static bool	theDisableCheckVersion
	Enable/Disable version check. More...
Protected Attributes inherited from DtLgrControlPdu
DtEntityIdentifier	mySenderId
	Parameter. More...
DtEntityIdentifier	myReceiverId
Static Protected Attributes inherited from DtLgrControlPdu
static const DtU16	theAddressWildcard = ((1<<16)-1)
static const DtEntityIdentifier	theWildcardAddress

Detailed Description

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

Constructor & Destructor Documentation

DtLgrTotalStatePdu::DtLgrTotalStatePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

(default) constructor

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

Construct from network representation.

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

Construct and prepare for send.

virtual DtLgrTotalStatePdu::~DtLgrTotalStatePdu ( )

virtual

Destructor.

DtLgrTotalStatePdu::DtLgrTotalStatePdu

(

const DtLgrTotalStatePdu &

)

Copy constructor.

Member Function Documentation

virtual const char* DtLgrTotalStatePdu::annotationsFile ( ) const

virtual

virtual bool DtLgrTotalStatePdu::dataScaling ( ) const

virtual

virtual DtLgrMode DtLgrTotalStatePdu::eofAction ( ) const

virtual

virtual DtTime DtLgrTotalStatePdu::fileLength ( ) const

virtual

virtual DtLgrFilePosition DtLgrTotalStatePdu::filePos ( ) const

virtual

virtual DtTime DtLgrTotalStatePdu::heartbeat ( ) const

virtual

virtual DtTime DtLgrTotalStatePdu::idealTime ( ) const

virtual

void DtLgrTotalStatePdu::initData ( )

protected

Used by constructors and such...

virtual const char* DtLgrTotalStatePdu::lgrFile ( ) const

virtual

virtual DtLgrMode DtLgrTotalStatePdu::mode ( ) const

virtual

DtLgrTotalStatePdu& DtLgrTotalStatePdu::operator=

(

const DtLgrTotalStatePdu &

)

Assignment operator.

virtual DtLgrStateDesc* DtLgrTotalStatePdu::params ( ) const

protectedvirtual

Return correctly casted parameters pointer; see lgrControlP.h.

virtual DtLgrMode DtLgrTotalStatePdu::playAction ( ) const

virtual

virtual void DtLgrTotalStatePdu::printDataToStream ( std::ostream &  stream ) const

virtual

Print contents.

Reimplemented from DtLgrControlPdu.

virtual DtLgrMode DtLgrTotalStatePdu::recordAction ( ) const

virtual

virtual double DtLgrTotalStatePdu::scale ( ) const

virtual

virtual void DtLgrTotalStatePdu::setAnnotationsFile ( const DtString &  name )

virtual

virtual void DtLgrTotalStatePdu::setDataScaling ( bool  onOff )

virtual

virtual void DtLgrTotalStatePdu::setEofAction ( DtLgrMode  md )

virtual

virtual void DtLgrTotalStatePdu::setFileLength ( DtTime  tm )

virtual

virtual void DtLgrTotalStatePdu::setFilePos ( DtLgrFilePosition  pos )

virtual

virtual void DtLgrTotalStatePdu::setHeartbeat ( DtTime  tm )

virtual

virtual void DtLgrTotalStatePdu::setIdealTime ( DtTime  tm )

virtual

virtual void DtLgrTotalStatePdu::setLgrFile ( const DtString &  name )

virtual

virtual void DtLgrTotalStatePdu::setMode ( DtLgrMode  md )

virtual

virtual void DtLgrTotalStatePdu::setPlayAction ( DtLgrMode  md )

virtual

virtual void DtLgrTotalStatePdu::setRecordAction ( DtLgrMode  md )

virtual

virtual void DtLgrTotalStatePdu::setScale ( double  sc )

virtual

virtual void DtLgrTotalStatePdu::setTime ( DtTime  tm )

virtual

virtual void DtLgrTotalStatePdu::setTimeConstrained ( bool  onOff )

virtual

virtual void DtLgrTotalStatePdu::setTimeout ( DtTime  tm )

virtual

virtual void DtLgrTotalStatePdu::setTimeRegulated ( bool  onOff )

virtual

virtual void DtLgrTotalStatePdu::setUsingOwnFedAmb ( bool  onOff )

virtual

virtual DtTime DtLgrTotalStatePdu::time ( ) const

virtual

virtual bool DtLgrTotalStatePdu::timeConstrained ( ) const

virtual

virtual DtTime DtLgrTotalStatePdu::timeout ( ) const

virtual

virtual bool DtLgrTotalStatePdu::timeRegulated ( ) const

virtual

virtual bool DtLgrTotalStatePdu::usingOwnFedAmb ( ) const

virtual

---

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

• lcTotalState.h