DtLgrAcknowledgePdu Class Reference

Instances of DtLgrAcknowledgePdu are to respond to a remote controller with the result of a logger command. More...

Inheritance diagram for DtLgrAcknowledgePdu:

Collaboration diagram for DtLgrAcknowledgePdu:

Public Member Functions
	DtLgrAcknowledgePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	(default) constructor
	DtLgrAcknowledgePdu (const DtNetLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	constructor (construct from network representation)
	DtLgrAcknowledgePdu (const DtEntityIdentifier &sender, const DtEntityIdentifier &receiver, bool processedOk, int pduSize=theAcknowledgePduSize, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	constructor (construct and prepare for send)
virtual	~DtLgrAcknowledgePdu ()
	destructor
	DtLgrAcknowledgePdu (const DtLgrAcknowledgePdu &src)
	copy constructor
DtLgrAcknowledgePdu &	operator= (const DtLgrAcknowledgePdu &src)
	assignment operator
virtual bool	accepted () const
	Get/set result for a command.
virtual void	setAccepted (bool cmdResult)
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
DtLgrControlPdu &	operator= (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.

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

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.
static DtLgrControlPdu *	create (DtLgrCommand command)
	Create a PDU from DtLgrCommand.
static DtLgrControlPdu *	create (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 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 DtLgrAcknowledgePdu are to respond to a remote controller with the result of a logger command.

Constructor & Destructor Documentation

DtLgrAcknowledgePdu::DtLgrAcknowledgePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

(default) constructor

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

constructor (construct from network representation)

DtLgrAcknowledgePdu::DtLgrAcknowledgePdu	(	const DtEntityIdentifier &	sender,
		const DtEntityIdentifier &	receiver,
		bool	processedOk,
		int	pduSize = theAcknowledgePduSize,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

constructor (construct and prepare for send)

virtual DtLgrAcknowledgePdu::~DtLgrAcknowledgePdu ( )

virtual

destructor

DtLgrAcknowledgePdu::DtLgrAcknowledgePdu

(

const DtLgrAcknowledgePdu &

src

)

copy constructor

Member Function Documentation

virtual bool DtLgrAcknowledgePdu::accepted ( ) const

virtual

Get/set result for a command.

DtLgrAcknowledgePdu& DtLgrAcknowledgePdu::operator=

(

const DtLgrAcknowledgePdu &

src

)

assignment operator

virtual DtLgrAcknowledgeData* DtLgrAcknowledgePdu::params ( ) const

protectedvirtual

Return correctly cast parameters pointer; see lgrControlP.h.

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

virtual

Print contents.

Reimplemented from DtLgrControlPdu.

virtual void DtLgrAcknowledgePdu::setAccepted ( bool  cmdResult )

virtual

---

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

• lcAcknowledge.h