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 | Static Public Member Functions | Protected Member Functions | Private Attributes
DtLgcyLgrControlPdu Class Reference

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

+ Inheritance diagram for DtLgcyLgrControlPdu:
+ Collaboration diagram for DtLgcyLgrControlPdu:

Public Member Functions

 DtLgcyLgrControlPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 (default) constructor
 DtLgcyLgrControlPdu (const DtNetLgcyLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 constructor (constructs from network representation)
virtual ~DtLgcyLgrControlPdu ()
 destructor
 DtLgcyLgrControlPdu (const DtLgcyLgrControlPdu &src)
 copy constructor
DtLgcyLgrControlPduoperator= (const DtLgcyLgrControlPdu &src)
 assignment operator
const DtGlobalObjectDesignator & receiverId () const
 Get/set Object Identifier of intended recipient (logger).
virtual void setReceiverId (const DtGlobalObjectDesignator &id)
virtual const
DtGlobalObjectDesignator & 
senderId () const
 Get/set Object Identifier of sender, if applicable.
virtual void setSenderId (const DtGlobalObjectDesignator &id)
DtLgrCommand lgrCommand () const
 Get message-type for proper casting to a subclass.
DtNetLgcyLgrControlParamsdefaultParams () const
 Data place holder.
virtual void printData () const
 Print contents.

Static Public Member Functions

static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 Create a PDU representation from a network packet.
static DtLgcyLgrControlPducreate (DtLgrCommand command)
 Create a PDU from DtLgrCommand.
static const char * lgrModeEnum2string (DtLgcyLgrMode md)
 The name (as a string) of a 'DtLgcyLgrMode'-type enum (from value)
static const char * lgrFilePosEnum2string (DtLgcyLgrFilePosition pos)
 The name (as a string) of a 'DtLgcyLgrFilePosition'-type enum (from value)
static const char * lgrStateFlag2string (DtLgcyLgrCtrlFlagStates flg)
 The name (as a string) of a 'DtLgcyLgrCtrlFlagStates'-type enum (from value)

Protected Member Functions

DtPduKind internalGetPduKind () const
 Identity for use by toolkit.
void setLgrCommand (DtLgrCommand com)
 Set is done by constructing the proper subclass.

Private Attributes

DtGlobalObjectDesignator mySenderId
 Parameter.
DtGlobalObjectDesignator myReceiverId

Detailed Description

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

See lc*.h.

Constructor & Destructor Documentation

DtLgcyLgrControlPdu::DtLgcyLgrControlPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

(default) constructor

DtLgcyLgrControlPdu::DtLgcyLgrControlPdu ( const DtNetLgcyLgrControlPdu initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER,
DtPduFactory *  pduFactory = 0 
)

constructor (constructs from network representation)

virtual DtLgcyLgrControlPdu::~DtLgcyLgrControlPdu ( )
virtual

destructor

DtLgcyLgrControlPdu::DtLgcyLgrControlPdu ( const DtLgcyLgrControlPdu src)

copy constructor

Member Function Documentation

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

Create a PDU representation from a network packet.

static DtLgcyLgrControlPdu* DtLgcyLgrControlPdu::create ( DtLgrCommand  command)
static

Create a PDU from DtLgrCommand.

DtNetLgcyLgrControlParams* DtLgcyLgrControlPdu::defaultParams ( ) const

Data place holder.

DtPduKind DtLgcyLgrControlPdu::internalGetPduKind ( ) const
inlineprotected

Identity for use by toolkit.

DtLgrCommand DtLgcyLgrControlPdu::lgrCommand ( ) const

Get message-type for proper casting to a subclass.

static const char* DtLgcyLgrControlPdu::lgrFilePosEnum2string ( DtLgcyLgrFilePosition  pos)
static

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

static const char* DtLgcyLgrControlPdu::lgrModeEnum2string ( DtLgcyLgrMode  md)
static

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

static const char* DtLgcyLgrControlPdu::lgrStateFlag2string ( DtLgcyLgrCtrlFlagStates  flg)
static

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

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

assignment operator

virtual void DtLgcyLgrControlPdu::printData ( ) const
virtual
const DtGlobalObjectDesignator& DtLgcyLgrControlPdu::receiverId ( ) const

Get/set Object Identifier of intended recipient (logger).

virtual const DtGlobalObjectDesignator& DtLgcyLgrControlPdu::senderId ( ) const
virtual

Get/set Object Identifier of sender, if applicable.

void DtLgcyLgrControlPdu::setLgrCommand ( DtLgrCommand  com)
protected

Set is done by constructing the proper subclass.

virtual void DtLgcyLgrControlPdu::setReceiverId ( const DtGlobalObjectDesignator &  id)
virtual
virtual void DtLgcyLgrControlPdu::setSenderId ( const DtGlobalObjectDesignator &  id)
virtual

Member Data Documentation

DtGlobalObjectDesignator DtLgcyLgrControlPdu::myReceiverId
private
DtGlobalObjectDesignator DtLgcyLgrControlPdu::mySenderId
private

Parameter.


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)