DtLgrControlPdu Class Reference

Instances of DtLgrControlPdu are a family of messages used to control a remote instance of the MAK-Logger over the network. More...

Inheritance diagram for DtLgrControlPdu:

Collaboration diagram for DtLgrControlPdu:

Public Member Functions
	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 void	printDataToStream (std::ostream &stream) const
	Print contents. More...
virtual bool	checkVersion () const
	Check that this PDU's LCT version is compatible. More...

Static Public Member Functions
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
static bool	theDisableCheckVersion
	Enable/Disable version check. More...

Protected Member Functions
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...

Protected Attributes
DtEntityIdentifier	mySenderId
	Parameter. More...
DtEntityIdentifier	myReceiverId

Static Protected Attributes
static const DtU16	theAddressWildcard = ((1<<16)-1)
static const DtEntityIdentifier	theWildcardAddress

Detailed Description

Instances of DtLgrControlPdu are a family of messages used to control a remote instance of the MAK-Logger over the network.

See lc*.h.

Constructor & Destructor Documentation

DtLgrControlPdu::DtLgrControlPdu	(	DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER,
		int	pduSize = sizeof(DtNetLgrControlPdu)
	)

(default) constructor

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

constructor (constructs from network representation)

virtual DtLgrControlPdu::~DtLgrControlPdu ( )

virtual

destructor

DtLgrControlPdu::DtLgrControlPdu

(

const DtLgrControlPdu &

src

)

copy constructor

Member Function Documentation

static DtU16 DtLgrControlPdu::addressWildcard ( )

static

Wildcard value for addresses.

virtual bool DtLgrControlPdu::checkVersion ( ) const

virtual

Check that this PDU's LCT version is compatible.

static bool DtLgrControlPdu::checkVersion ( DtNetLgrControlPdu *  header )

static

Given a LC header, check that the LCT version is compatible.

virtual DtNetLgrControlPdu* DtLgrControlPdu::controlHeader ( )

protectedvirtual

Access to the payload as control pdu header.

virtual DtNetLgrControlPdu* DtLgrControlPdu::controlHeader ( ) const

protectedvirtual

Access to the payload as control pdu header.

static DtPdu* DtLgrControlPdu::create ( const DtNetPacket *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory *  pduFactory = 0  )

static

Create a PDU representation from a network packet.

static DtLgrControlPdu* DtLgrControlPdu::create ( DtLgrCommand  command )

static

Create a PDU from DtLgrCommand.

static DtLgrControlPdu* DtLgrControlPdu::create ( DtLgrCommandExt  command )

static

Create a PDU from DtLgrCommandExt.

DtPduKind DtLgrControlPdu::internalGetPduKind ( ) const

inlineprotected

Identity for use by toolkit.

virtual DtU16 DtLgrControlPdu::lctVersion ( ) const

virtual

Get/set version.

virtual DtLgrCommand DtLgrControlPdu::lgrCommand ( ) const

virtual

Get message-type for proper casting to a subclass.

static const char* DtLgrControlPdu::lgrFilePosEnum2string ( DtLgrFilePosition  pos )

static

The name (as a string) of a 'DtLgrFilePosition'-type enum (from value)

static const char* DtLgrControlPdu::lgrModeEnum2string ( DtLgrMode  md )

static

The name (as a string) of a 'DtLgrMode'-type enum (from value)

static const char* DtLgrControlPdu::lgrStateFlag2string ( DtLgrCtrlFlagStates  flg )

static

The name (as a string) of a 'DtLgrCtrlFlagStates'-type enum (from value)

DtLgrControlPdu& DtLgrControlPdu::operator=

(

const DtLgrControlPdu &

src

)

assignment operator

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

virtual

Print contents.

Reimplemented in DtLgrTotalStatePdu, DtLgrCommandPdu, DtLgrConnectPdu, DtLgrConnectionEstablishedPdu, DtLgrDisconnectPdu, DtLgrAcknowledgePdu, and DtLgrResponsePdu.

virtual const DtEntityIdentifier& DtLgrControlPdu::receiverId ( ) const

virtual

Get/set identifier of intended recipient (logger).

virtual const DtEntityIdentifier& DtLgrControlPdu::senderId ( ) const

virtual

Get/set identifier of sender, if applicable.

virtual DtU32 DtLgrControlPdu::sequence ( ) const

virtual

Get/set sequence number.

void DtLgrControlPdu::setLctVersion

(

DtU16

versionNumber

)

Called in constructor so not virtual.

virtual void DtLgrControlPdu::setLgrCommand ( DtLgrCommand  com )

protectedvirtual

Set is done by constructing the proper subclass.

virtual void DtLgrControlPdu::setLgrCommand ( DtLgrCommandExt  com )

protectedvirtual

Set is done by constructing the proper subclass.

virtual void DtLgrControlPdu::setReceiverId ( const DtEntityIdentifier &  id )

virtual

virtual void DtLgrControlPdu::setSenderId ( const DtEntityIdentifier &  id )

virtual

virtual void DtLgrControlPdu::setSequence ( DtU32  sequenceNumber )

virtual

static const DtEntityIdentifier& DtLgrControlPdu::wildcardAddress ( )

static

Wildcard address.

Member Data Documentation

DtEntityIdentifier DtLgrControlPdu::myReceiverId

protected

DtEntityIdentifier DtLgrControlPdu::mySenderId

protected

Parameter.

const DtU16 DtLgrControlPdu::theAddressWildcard = ((1<<16)-1)

staticprotected

bool DtLgrControlPdu::theDisableCheckVersion

static

Enable/Disable version check.

const DtEntityIdentifier DtLgrControlPdu::theWildcardAddress

staticprotected

---

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

• lcPdu.h