MAK Data Logger API Documentation for HLA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions

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

+ Inheritance diagram for DtLgrResponsePdu:
+ Collaboration diagram for DtLgrResponsePdu:

Public Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from DtLgrCommandPdu
static void setDomainToString (DtDomainToStringFunc func)
static void setProtocolToString (DtProtocolToStringFunc func)
static void setCommandToString (DtCommandToStringFunc func)
- Static Public Attributes inherited from DtLgrControlPdu
static bool theDisableCheckVersion
 Enable/Disable version check.
- Protected Member Functions inherited from DtLgrCommandPdu
virtual DtLgrCommandDataparams () const
 Return correctly cast parameters pointer; see lgrControlP.h.
void initData ()
 Initialize data in constructor.
- Protected Attributes inherited from DtLgrControlPdu
DtEntityIdentifier mySenderId
 Parameter.
DtEntityIdentifier myReceiverId
- Static Protected Attributes inherited from DtLgrCommandPdu
static DtDomainToStringFunc theDomainToStringFunc
static DtProtocolToStringFunc theProtocolToStringFunc
static DtCommandToStringFunc theCommandToStringFunc

Detailed Description

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

Constructor & Destructor Documentation

DtLgrResponsePdu::DtLgrResponsePdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

(default) constructor

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

constructor (construct from network representation)

DtLgrResponsePdu::DtLgrResponsePdu ( const DtEntityIdentifier &  sender,
const DtEntityIdentifier &  receiver,
int  commandDomain,
int  commandProtocol,
int  commandId,
const DtString parametersBuffer,
int  pduSize = theCommandPduSize,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

constructor (construct and prepare for send)

virtual DtLgrResponsePdu::~DtLgrResponsePdu ( )
virtual

destructor

DtLgrResponsePdu::DtLgrResponsePdu ( const DtLgrResponsePdu src)

copy constructor

Member Function Documentation

DtLgrResponsePdu& DtLgrResponsePdu::operator= ( const DtLgrResponsePdu src)

assignment operator

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

Print contents.

Reimplemented from DtLgrCommandPdu.


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

Document ID: Generated on Thu Jul 23 15:05:27 EDT 2020 from SVN revision 215371
Copyright © 2020 MAK Technologies. All Rights Reserved (www.mak.com)