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
MAKLogger::DtBaseObjClassDesc Class Reference

An Fom Object Class descriptions. More...

+ Inheritance diagram for MAKLogger::DtBaseObjClassDesc:
+ Collaboration diagram for MAKLogger::DtBaseObjClassDesc:

Public Member Functions

 DtBaseObjClassDesc (const DtString &className, DtBaseObjClassDesc *baseClass, unsigned int hand, const void *handCode, int codeSize)
 Main Constructor. More...
 
 DtBaseObjClassDesc (const DtString &className, const DtString &baseClassName, unsigned int hand, const void *handCode, int codeSize)
 Incomplete constructor (from names only, with delayed initialization) More...
 
 DtBaseObjClassDesc (char *&bfr, int &bsz)
 Incomplete constructor (from serial form, with delayed initialization) More...
 
virtual ~DtBaseObjClassDesc ()
 Destructor. More...
 
 DtBaseObjClassDesc (const DtBaseObjClassDesc &src)
 Copy constructor. More...
 
DtBaseObjClassDescoperator= (const DtBaseObjClassDesc &src)
 Assignment operator. More...
 
RTI::ObjectClassHandle rtiHandle (const DtLgrOnlineFomDesc &fomDesc) const
 Return the corresponding RTI ParameterHandle. More...
 
bool isBaseClass () const
 Is this object class a base class for other object classes. More...
 
void setIsBaseClass (bool isBaseClass)
 Set whether is a base class. More...
 
bool isSubscribedTo () const
 Is this object class subscribed to. More...
 
void setIsSubscribedTo (bool onOff)
 Toggle on/off the subscription to this object class. More...
 
bool isFilteredClass () const
 Is this object class filtered out. More...
 
void setIsFilteredClass (bool onOff)
 Toggle on/off the filtering of this object class. More...
 
int serialize (char *&bfr, int &bsz) const
 This method serializes the entire information contained in the current object class in a preallocated buffer (pointed to by 'bfr') of (remaining) free size 'bsz'. More...
 
- Public Member Functions inherited from MAKLogger::DtBaseHla1516Class< DtBaseAttrDesc >
 DtBaseHla1516Class (const DtString &name, DtBaseHlaClass< DtBaseAttrDesc > *baseClass, DtLgrHlaHandle handle, const DtLgrVariableLengthData &code)
 Constructor with valid pointer to base class object. More...
 
 DtBaseHla1516Class (const DtString &name, const DtString &baseClassName, DtLgrHlaHandle handle, const DtLgrVariableLengthData &code)
 Constructor with only the base class name. More...
 
 DtBaseHla1516Class (const DtBaseHla1516Class< DtBaseAttrDesc > &src)
 Copy constructor. More...
 
DtBaseHla1516Class
< DtBaseAttrDesc > & 
operator= (const DtBaseHla1516Class< DtBaseAttrDesc > &src)
 Assignment operator. More...
 
virtual ~DtBaseHla1516Class ()
 DTOR. More...
 
DtBaseAttrDescfindValueByCode (const DtLgrVariableLengthData &code, bool thisClassOnly)
 Look up a value by its encoded handle. More...
 
const DtBaseAttrDescfindValueByCode (const DtLgrVariableLengthData &code, bool thisClassOnly) const
 Look up a value by its encoded handle. More...
 
- Public Member Functions inherited from MAKLogger::DtBaseHlaClass< DtBaseAttrDesc >
 DtBaseHlaClass (const DtString &name, DtBaseHlaClass< DtBaseAttrDesc > *baseClass, DtLgrHlaHandle handle)
 Constructor with valid pointer to base class object. More...
 
 DtBaseHlaClass (const DtString &name, const DtString &baseClassName, DtLgrHlaHandle handle)
 Constructor with only the base class name. More...
 
 DtBaseHlaClass (const DtBaseHlaClass< DtBaseAttrDesc > &src)
 Copy constructor. More...
 
DtBaseHlaClass< DtBaseAttrDesc > & operator= (const DtBaseHlaClass< DtBaseAttrDesc > &src)
 Assignment operator. More...
 
virtual ~DtBaseHlaClass ()
 DTOR. More...
 
const DtStringbaseName () const
 Get the base class name, it can be empty. More...
 
DtString simpleName () const
 Get the simple class name, which does not include the base name. More...
 
const char * baseName2print () const
 Get a raw pointer to the base name for printing. More...
 
void setBaseNameOnly (const DtString &name0)
 Set the base class name. More...
 
void setBaseClass (DtBaseHlaClass< DtBaseAttrDesc > *baseClass)
 Set the base class pointer. More...
 
bool isOfClass (DtLgrHlaHandle handle) const
 Checks whether this class is or inherits from a class with the handle. More...
 
bool isOfClass (const DtString &name) const
 Checks whether this class is or inherits from a class with the name. More...
 
bool isOfClass (const DtBaseHlaClass &baseClass) const
 Checks whether this class is or inherits from the class (via ptr) More...
 
void addValue (const DtBaseAttrDesc &value)
 Add a value to the class. More...
 
void clearValues ()
 Clears all values added. More...
 
int valueCount (bool thisClassOnly) const
 Get the number of values in this class. More...
 
int minHandle (bool thisClassOnly) const
 Get the minum handle of its values; If thisClassOnly = true, only this class will be checked. More...
 
int maxHandle (bool thisClassOnly) const
 Get the maximum handle of its values; If thisClassOnly = true, only this class will be checked. More...
 
DtBaseHlaClass< DtBaseAttrDesc > * baseClass ()
 Get the base class. More...
 
const DtBaseHlaClass
< DtBaseAttrDesc > * 
baseClass () const
 Get the base class. More...
 
iterator begin ()
 Get iterator to first value. More...
 
const_iterator begin () const
 Get iterator to first value. More...
 
iterator end ()
 Get iterator past last value. More...
 
const_iterator end () const
 Get iterator past last value. More...
 
DtBaseAttrDescfindValueByName (const DtString &name, bool thisClassOnly)
 Look up a value by its name. More...
 
const DtBaseAttrDescfindValueByName (const DtString &name, bool thisClassOnly) const
 Look up a value by its name. More...
 
DtBaseAttrDescfindValueByHandle (DtLgrHlaHandle handle, bool thisClassOnly)
 Look up a value by its handle. More...
 
const DtBaseAttrDescfindValueByHandle (DtLgrHlaHandle handle, bool thisClassOnly) const
 Look up a value by its handle. More...
 
- Public Member Functions inherited from MAKLogger::DtBaseHlaValue
 DtBaseHlaValue (const DtString &name, DtLgrHlaHandle handle)
 
virtual ~DtBaseHlaValue ()
 
 DtBaseHlaValue (const DtBaseHlaValue &value)
 
DtBaseHlaValueoperator= (const DtBaseHlaValue &value)
 
DtU32 flags () const
 Get the encoded flags. More...
 
void setFlags (DtU32)
 Set the encoded flags. More...
 
const DtStringname () const
 
void setName (const DtString &name)
 
const char * name2print () const
 
DtLgrHlaHandle handle () const
 
void setHandle (DtLgrHlaHandle handle)
 
- Public Member Functions inherited from MAKLogger::DtBaseHla1516Value
 DtBaseHla1516Value (const DtString &name, DtU32 handle, const DtLgrVariableLengthData &code)
 Main constructor. More...
 
virtual ~DtBaseHla1516Value ()
 Destructor. More...
 
 DtBaseHla1516Value (const DtBaseHla1516Value &src)
 Copy constructor. More...
 
DtBaseHla1516Valueoperator= (const DtBaseHla1516Value &src)
 Assignment operator. More...
 
const DtLgrVariableLengthDataencodedHandle () const
 Get the encoded handle. More...
 
const void * code () const
 Return the encoded handle data.. More...
 
int codeLength () const
 Return the encoded handle size. More...
 
void setCode (const DtLgrVariableLengthData &code)
 Set the encoded handle. More...
 
void setCode (const void *data, int size)
 Set the encoded handle. More...
 

Protected Member Functions

void resetAll ()
 Called from the constructors. More...
 
int unserializeAttributes (char *bfr, int bsz, int num)
 

Additional Inherited Members

- Public Types inherited from MAKLogger::DtBaseHlaClass< DtBaseAttrDesc >
typedef std::vector
< DtBaseAttrDesc
ValueVector
 
typedef ValueVector::iterator iterator
 
typedef ValueVector::const_iterator const_iterator
 

Detailed Description

An Fom Object Class descriptions.

Constructor & Destructor Documentation

MAKLogger::DtBaseObjClassDesc::DtBaseObjClassDesc ( const DtString className,
const DtString baseClassName,
unsigned int  hand,
const void *  handCode,
int  codeSize 
)

Incomplete constructor (from names only, with delayed initialization)

MAKLogger::DtBaseObjClassDesc::DtBaseObjClassDesc ( char *&  bfr,
int &  bsz 
)

Incomplete constructor (from serial form, with delayed initialization)

virtual MAKLogger::DtBaseObjClassDesc::~DtBaseObjClassDesc ( )
virtual

Destructor.

MAKLogger::DtBaseObjClassDesc::DtBaseObjClassDesc ( const DtBaseObjClassDesc src)

Copy constructor.

Member Function Documentation

bool MAKLogger::DtBaseObjClassDesc::isBaseClass ( ) const
inline

Is this object class a base class for other object classes.

References MAKLogger::DtLgrFomDesc_IsBaseClass, and MAKLogger::DtBaseHlaValue::flags().

bool MAKLogger::DtBaseObjClassDesc::isFilteredClass ( ) const
inline

Is this object class filtered out.

References MAKLogger::DtLgrFomDesc_IsFiltered, and MAKLogger::DtBaseHlaValue::flags().

bool MAKLogger::DtBaseObjClassDesc::isSubscribedTo ( ) const
inline

Is this object class subscribed to.

References MAKLogger::DtLgrFomDesc_IsSubscribed, and MAKLogger::DtBaseHlaValue::flags().

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

Assignment operator.

void MAKLogger::DtBaseObjClassDesc::resetAll ( )
protected

Called from the constructors.

RTI::ObjectClassHandle MAKLogger::DtBaseObjClassDesc::rtiHandle ( const DtLgrOnlineFomDesc fomDesc) const

Return the corresponding RTI ParameterHandle.

int MAKLogger::DtBaseObjClassDesc::serialize ( char *&  bfr,
int &  bsz 
) const

This method serializes the entire information contained in the current object class 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 object class.


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::DtBaseObjClassDesc::setIsBaseClass ( bool  isBaseClass)
inline
void MAKLogger::DtBaseObjClassDesc::setIsFilteredClass ( bool  onOff)
inline

Toggle on/off the filtering of this object class.

References MAKLogger::DtLgrFomDesc_IsFiltered, MAKLogger::DtBaseHlaValue::flags(), and MAKLogger::DtBaseHlaValue::setFlags().

void MAKLogger::DtBaseObjClassDesc::setIsSubscribedTo ( bool  onOff)
inline

Toggle on/off the subscription to this object class.

References MAKLogger::DtLgrFomDesc_IsSubscribed, MAKLogger::DtBaseHlaValue::flags(), and MAKLogger::DtBaseHlaValue::setFlags().

int MAKLogger::DtBaseObjClassDesc::unserializeAttributes ( char *  bfr,
int  bsz,
int  num 
)
protected

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)