 |
MAK Data Logger API Documentation for HLA
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
MAK Data Logger API Documentation for HLA
|
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 More... | |
| DtLgrResponsePdu (const DtNetLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0) | |
| constructor (construct from network representation) More... | |
| DtLgrResponsePdu (const DtEntityIdentifier &sender, const DtEntityIdentifier &receiver, int commandDomain, int commandProtocol, int commandId, const DtString ¶metersBuffer, int pduSize=theCommandPduSize, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| constructor (construct and prepare for send) More... | |
| virtual | ~DtLgrResponsePdu () |
| destructor More... | |
| DtLgrResponsePdu (const DtLgrResponsePdu &src) | |
| copy constructor More... | |
| DtLgrResponsePdu & | operator= (const DtLgrResponsePdu &src) |
| assignment operator More... | |
| virtual void | printDataToStream (std::ostream &stream) const |
| Print contents. More... | |
| Public Member Functions inherited from DtLgrCommandPdu | |
| 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 ¶metersBuffer, 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 ¶msBuffer) |
| 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... | |
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 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 Member Functions inherited from DtLgrCommandPdu | |
| 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... | |
| Protected Attributes inherited from DtLgrControlPdu | |
| DtEntityIdentifier | mySenderId |
| Parameter. More... | |
| DtEntityIdentifier | myReceiverId |
| Static Protected Attributes inherited from DtLgrCommandPdu | |
| 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 |
Instances of DtLgrResponsePdu are to respond to a remote controller with the result of a logger command.
| 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 |
destructor
| DtLgrResponsePdu::DtLgrResponsePdu | ( | const DtLgrResponsePdu & | src | ) |
copy constructor
| DtLgrResponsePdu& DtLgrResponsePdu::operator= | ( | const DtLgrResponsePdu & | src | ) |
assignment operator
|
virtual |
Print contents.
Reimplemented from DtLgrCommandPdu.
