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

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 More...
 
 DtLgrAcknowledgePdu (const DtNetLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 constructor (construct from network representation) More...
 
 DtLgrAcknowledgePdu (const DtEntityIdentifier &sender, const DtEntityIdentifier &receiver, bool processedOk, int pduSize=theAcknowledgePduSize, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 constructor (construct and prepare for send) More...
 
virtual ~DtLgrAcknowledgePdu ()
 destructor More...
 
 DtLgrAcknowledgePdu (const DtLgrAcknowledgePdu &src)
 copy constructor More...
 
DtLgrAcknowledgePduoperator= (const DtLgrAcknowledgePdu &src)
 assignment operator More...
 
virtual bool accepted () const
 Get/set result for a command. More...
 
virtual void setAccepted (bool cmdResult)
 
virtual void printDataToStream (std::ostream &stream) const
 Print contents. 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...
 
DtLgrControlPduoperator= (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...
 

Protected Member Functions

virtual DtLgrAcknowledgeDataparams () const
 Return correctly cast parameters pointer; see lgrControlP.h. 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 DtNetLgrControlPducontrolHeader ()
 Access to the payload as control pdu header. More...
 
virtual DtNetLgrControlPducontrolHeader () const
 Access to the payload as control pdu header. More...
 
DtPduKind internalGetPduKind () const
 Identity for use by toolkit. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DtLgrControlPdu
static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 Create a PDU representation from a network packet. More...
 
static DtLgrControlPducreate (DtLgrCommand command)
 Create a PDU from DtLgrCommand. More...
 
static DtLgrControlPducreate (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 Attributes inherited from DtLgrControlPdu
DtEntityIdentifier mySenderId
 Parameter. More...
 
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:

Document ID: Generated on Thu Dec 18 15:35:09 EST 2025 from SVN revision 282494
Copyright © 2024 MAK Technologies. All Rights Reserved (www.mak.com)