DtLgrCommandPdu Class Reference

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

Inheritance diagram for DtLgrCommandPdu:

Collaboration diagram for DtLgrCommandPdu:

Public Member Functions
	DtLgrCommandPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	(default) constructor More...
	DtLgrCommandPdu (const DtNetLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	constructor (construct from network representation) More...
	DtLgrCommandPdu (const DtEntityIdentifier &sender, const DtEntityIdentifier &receiver, int domain, int protocol, int commandId, const DtString &parametersBuffer, int pduSize=theCommandPduSize, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	constructor (construct and prepare for send) More...
virtual	~DtLgrCommandPdu ()
	destructor More...
	DtLgrCommandPdu (const DtLgrCommandPdu &src)
	copy constructor More...
DtLgrCommandPdu &	operator= (const DtLgrCommandPdu &src)
	assignment operator More...
virtual int	commandDomain () const
	Get/set command domain. More...
virtual void	setCommandDomain (int domain)
virtual int	commandProtocol () const
	Get/set command protocol. More...
virtual void	setCommandProtocol (int protocol)
virtual int	command () const
	Get/set command ID. More...
virtual void	setCommand (int commandId)
virtual const char *	parametersBuffer () const
	GetSet parameter buffer. More...
virtual void	setParametersBuffer (const DtString &paramsBuffer)
virtual void	printDataToStream (std::ostream &stream) const
	Print contents. More...
virtual const char *	commandString () const
	Get the command ID as a string. More...
virtual const char *	domainString () const
	Get the domain as a string. More...
virtual const char *	protocolString () const
	Get the protocol as a string. 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...

Static Public Member Functions
static void	setDomainToString (DtDomainToStringFunc func)
static void	setProtocolToString (DtProtocolToStringFunc func)
static void	setCommandToString (DtCommandToStringFunc func)
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 void	addCallback (DtExerciseConn *conn, DtLgrControlInteractionCb cb, void *usr)
	DIS – install/remove handler to call when receiving a LC packet. More...
static void	removeCallback (DtExerciseConn *conn, DtLgrControlInteractionCb cb, void *usr)
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...

Protected Member Functions
virtual DtLgrCommandData *	params () const
	Return correctly cast parameters pointer; see lgrControlP.h. More...
void	initData ()
	Initialize data in constructor. 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...

Static Protected Attributes
static DtDomainToStringFunc	theDomainToStringFunc
static DtProtocolToStringFunc	theProtocolToStringFunc
static DtCommandToStringFunc	theCommandToStringFunc
Static Protected Attributes inherited from DtLgrControlPdu
static const DtU16	theAddressWildcard = ((1<<16)-1)
static const DtEntityIdentifier	theWildcardAddress

Additional Inherited Members
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

Detailed Description

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

Constructor & Destructor Documentation

DtLgrCommandPdu::DtLgrCommandPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

(default) constructor

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

constructor (construct from network representation)

DtLgrCommandPdu::DtLgrCommandPdu	(	const DtEntityIdentifier &	sender,
		const DtEntityIdentifier &	receiver,
		int	domain,
		int	protocol,
		int	commandId,
		const DtString &	parametersBuffer,
		int	pduSize = theCommandPduSize,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

constructor (construct and prepare for send)

virtual DtLgrCommandPdu::~DtLgrCommandPdu ( )

virtual

destructor

DtLgrCommandPdu::DtLgrCommandPdu

(

const DtLgrCommandPdu &

src

)

copy constructor

Member Function Documentation

virtual int DtLgrCommandPdu::command ( ) const

virtual

Get/set command ID.

virtual int DtLgrCommandPdu::commandDomain ( ) const

virtual

Get/set command domain.

virtual int DtLgrCommandPdu::commandProtocol ( ) const

virtual

Get/set command protocol.

virtual const char* DtLgrCommandPdu::commandString ( ) const

virtual

Get the command ID as a string.

virtual const char* DtLgrCommandPdu::domainString ( ) const

virtual

Get the domain as a string.

void DtLgrCommandPdu::initData ( )

protected

Initialize data in constructor.

DtLgrCommandPdu& DtLgrCommandPdu::operator=

(

const DtLgrCommandPdu &

src

)

assignment operator

virtual const char* DtLgrCommandPdu::parametersBuffer ( ) const

virtual

GetSet parameter buffer.

virtual DtLgrCommandData* DtLgrCommandPdu::params ( ) const

protectedvirtual

Return correctly cast parameters pointer; see lgrControlP.h.

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

virtual

Print contents.

Reimplemented from DtLgrControlPdu.

Reimplemented in DtLgrResponsePdu.

virtual const char* DtLgrCommandPdu::protocolString ( ) const

virtual

Get the protocol as a string.

virtual void DtLgrCommandPdu::setCommand ( int  commandId )

virtual

virtual void DtLgrCommandPdu::setCommandDomain ( int  domain )

virtual

virtual void DtLgrCommandPdu::setCommandProtocol ( int  protocol )

virtual

static void DtLgrCommandPdu::setCommandToString ( DtCommandToStringFunc  func )

static

static void DtLgrCommandPdu::setDomainToString ( DtDomainToStringFunc  func )

static

virtual void DtLgrCommandPdu::setParametersBuffer ( const DtString &  paramsBuffer )

virtual

static void DtLgrCommandPdu::setProtocolToString ( DtProtocolToStringFunc  func )

static

Member Data Documentation

DtCommandToStringFunc DtLgrCommandPdu::theCommandToStringFunc

staticprotected

DtDomainToStringFunc DtLgrCommandPdu::theDomainToStringFunc

staticprotected

DtProtocolToStringFunc DtLgrCommandPdu::theProtocolToStringFunc

staticprotected

---

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

• lcCommand.h