MAK Data Logger API Documentation for DIS
List of all members | Public Member Functions | Protected Attributes
MAKLogger::DtPduDescriptor Class Reference

A runtime description of a DIS pdu. More...

+ Collaboration diagram for MAKLogger::DtPduDescriptor:

Public Member Functions

 DtPduDescriptor (DtDisDescriptor *disObj, const DtString &name, DtU32 kind, int _enIdOff, int _typeOff)
 Main Constructor.
 DtPduDescriptor (DtDisDescriptor *disObj, const char *bfr, int bsz, int &pduSize)
 Constructor from serial form.
virtual ~DtPduDescriptor ()
 Destructor.
 DtPduDescriptor (const DtPduDescriptor &src)
 Copy constructor.
DtPduDescriptoroperator= (const DtPduDescriptor &src)
 Assignment operator.
const DtString & name () const
 Get the Pdu name.
DtU32 kind () const
 Get the Pdu kind enumerator.
void setEntityIdOffset (int off)
 Set/Get the offset to the EntityId field (within the Pdu layout)
int entityIdOffset () const
void setEntityTypeOffset (int off)
 Set/Get the offset to the EntityType field (within the Pdu layout)
int entityTypeOffset () const
void setIsFilteredPdu (bool onOff)
 Toggle on/off the filtering of this object class.
bool isFilteredPdu () const
 Is this object class filtered out.
int serialize (char *bfr, int bsz)
 This method serializes the entire information contained in the current Pdu descriptor in a preallocated buffer (pointed to by 'bfr') of (remaining) free size 'bsz'.

Protected Attributes

DtU32 myKind
bool myFilteredFlag
DtString myName
int myNameIndex
int myEntityIdOff
int myEntityTypeOff
DtDisDescriptormyDisObject

Detailed Description

A runtime description of a DIS pdu.

Constructor & Destructor Documentation

MAKLogger::DtPduDescriptor::DtPduDescriptor ( DtDisDescriptor disObj,
const DtString &  name,
DtU32  kind,
int  _enIdOff,
int  _typeOff 
)

Main Constructor.

MAKLogger::DtPduDescriptor::DtPduDescriptor ( DtDisDescriptor disObj,
const char *  bfr,
int  bsz,
int &  pduSize 
)

Constructor from serial form.

virtual MAKLogger::DtPduDescriptor::~DtPduDescriptor ( )
virtual

Destructor.

MAKLogger::DtPduDescriptor::DtPduDescriptor ( const DtPduDescriptor src)

Copy constructor.

Member Function Documentation

int MAKLogger::DtPduDescriptor::entityIdOffset ( ) const
inline

References myEntityIdOff.

int MAKLogger::DtPduDescriptor::entityTypeOffset ( ) const
inline

References myEntityTypeOff.

bool MAKLogger::DtPduDescriptor::isFilteredPdu ( ) const
inline

Is this object class filtered out.

References myFilteredFlag.

DtU32 MAKLogger::DtPduDescriptor::kind ( ) const
inline

Get the Pdu kind enumerator.

References myKind.

const DtString & MAKLogger::DtPduDescriptor::name ( ) const
inline

Get the Pdu name.

References myName.

DtPduDescriptor& MAKLogger::DtPduDescriptor::operator= ( const DtPduDescriptor src)

Assignment operator.

int MAKLogger::DtPduDescriptor::serialize ( char *  bfr,
int  bsz 
)

This method serializes the entire information contained in the current Pdu descriptor in a preallocated buffer (pointed to by 'bfr') of (remaining) free size 'bsz'.

Upon success the method advances 'bfr' to the end of the stored block and decrements 'bsz' by the number of bytes that were used. In either case the method returns the necessary size (in bytes) for the serialized form of the current Pdu descriptor.


Note: To figure out what buffer size will be necessary, call this method with 'bfr' set to NULL – the method will compute and return the necessary size without any actual copying of data.

void MAKLogger::DtPduDescriptor::setEntityIdOffset ( int  off)
inline

Set/Get the offset to the EntityId field (within the Pdu layout)

References myEntityIdOff.

void MAKLogger::DtPduDescriptor::setEntityTypeOffset ( int  off)
inline

Set/Get the offset to the EntityType field (within the Pdu layout)

References myEntityTypeOff.

void MAKLogger::DtPduDescriptor::setIsFilteredPdu ( bool  onOff)
inline

Toggle on/off the filtering of this object class.

References myFilteredFlag.

Member Data Documentation

DtDisDescriptor* MAKLogger::DtPduDescriptor::myDisObject
protected
int MAKLogger::DtPduDescriptor::myEntityIdOff
protected
int MAKLogger::DtPduDescriptor::myEntityTypeOff
protected
bool MAKLogger::DtPduDescriptor::myFilteredFlag
protected

Referenced by isFilteredPdu(), and setIsFilteredPdu().

DtU32 MAKLogger::DtPduDescriptor::myKind
protected

Referenced by kind().

DtString MAKLogger::DtPduDescriptor::myName
protected

Referenced by name().

int MAKLogger::DtPduDescriptor::myNameIndex
protected

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

Document ID: Generated on Thu Apr 11 12:13:00 EDT 2013 from SVN revision 126011
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)