![]() |
MAK Data Logger API Documentation for HLA
|
Represents a HLA 1516 Fom Interaction class descriptions. More...
Inheritance diagram for MAKLogger::DtBaseInterClassDesc:
Collaboration diagram for MAKLogger::DtBaseInterClassDesc:Public Member Functions | |
| DtBaseInterClassDesc (const DtString &className, DtBaseInterClassDesc *baseClass, DtLgrHlaHandle handle, const void *handCode, int codeSize) | |
| Main constructor. More... | |
| DtBaseInterClassDesc (const DtString &className, const DtString &baseClassName, DtLgrHlaHandle hand, const void *handCode, int codeSize) | |
| Incomplete constructor (from names only, with delayed initialization) More... | |
| DtBaseInterClassDesc (char *&bfr, int &bsz) | |
| Incomplete constructor (from serial form, with delayed initialization) More... | |
| virtual | ~DtBaseInterClassDesc () |
| Destructor. More... | |
| DtBaseInterClassDesc (const DtBaseInterClassDesc &src) | |
| Copy constructor. More... | |
| DtBaseInterClassDesc & | operator= (const DtBaseInterClassDesc &src) |
| Assignment operator. More... | |
| RTI::InteractionClassHandle | rtiHandle (const DtLgrOnlineFomDesc &fomDesc) const |
| Return the corresponding RTI ParameterHandle. More... | |
| bool | isBaseClass () const |
| Is this interaction class a base class for other interaction classes. More... | |
| void | setIsBaseClass (bool) |
| Set whether this class is a base class. More... | |
| bool | isSubscribedTo () const |
| Is this interaction class subscribed to. More... | |
| void | setIsSubscribedTo (bool onOff) |
| Toggle on/off the subscription to this interaction class. More... | |
| bool | isFilteredClass () const |
| Is this interaction class filtered out. More... | |
| void | setIsFilteredClass (bool onOff) |
| Toggle on/off the filtering of this interaction class. More... | |
| DtLgrFomTransportType | transportType () const |
| Returns the transport type (i.e., "best effort", "reliable") for this interaction class. More... | |
| void | setTransportType (DtLgrFomTransportType type) |
| Sets the transport type. More... | |
| DtLgrFomOrderType | orderType () const |
| Returns the order type (i.e., "receive order", "time stamp order") for this interaction class. More... | |
| void | setOrderType (DtLgrFomOrderType type) |
| Sets the ordertype. More... | |
| int | serialize (char *&bfr, int &bsz) const |
| This method serializes the entire information contained in the current interaction class in a preallocated buffer (pointed to by 'bfr') of (remaining) free size 'bsz'. More... | |
Public Member Functions inherited from MAKLogger::DtBaseHla1516Class< DtBaseParamDesc > | |
| DtBaseHla1516Class (const DtString &name, DtBaseHlaClass< DtBaseParamDesc > *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< DtBaseParamDesc > &src) | |
| Copy constructor. More... | |
| DtBaseHla1516Class < DtBaseParamDesc > & | operator= (const DtBaseHla1516Class< DtBaseParamDesc > &src) |
| Assignment operator. More... | |
| virtual | ~DtBaseHla1516Class () |
| DTOR. More... | |
| DtBaseParamDesc * | findValueByCode (const DtLgrVariableLengthData &code, bool thisClassOnly) |
| Look up a value by its encoded handle. More... | |
| const DtBaseParamDesc * | findValueByCode (const DtLgrVariableLengthData &code, bool thisClassOnly) const |
| Look up a value by its encoded handle. More... | |
Public Member Functions inherited from MAKLogger::DtBaseHlaClass< DtBaseParamDesc > | |
| DtBaseHlaClass (const DtString &name, DtBaseHlaClass< DtBaseParamDesc > *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< DtBaseParamDesc > &src) | |
| Copy constructor. More... | |
| DtBaseHlaClass< DtBaseParamDesc > & | operator= (const DtBaseHlaClass< DtBaseParamDesc > &src) |
| Assignment operator. More... | |
| virtual | ~DtBaseHlaClass () |
| DTOR. More... | |
| const DtString & | baseName () 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< DtBaseParamDesc > *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 DtBaseParamDesc &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< DtBaseParamDesc > * | baseClass () |
| Get the base class. More... | |
| const DtBaseHlaClass < DtBaseParamDesc > * | 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... | |
| DtBaseParamDesc * | findValueByName (const DtString &name, bool thisClassOnly) |
| Look up a value by its name. More... | |
| const DtBaseParamDesc * | findValueByName (const DtString &name, bool thisClassOnly) const |
| Look up a value by its name. More... | |
| DtBaseParamDesc * | findValueByHandle (DtLgrHlaHandle handle, bool thisClassOnly) |
| Look up a value by its handle. More... | |
| const DtBaseParamDesc * | findValueByHandle (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) | |
| DtBaseHlaValue & | operator= (const DtBaseHlaValue &value) |
| DtU32 | flags () const |
| Get the encoded flags. More... | |
| void | setFlags (DtU32) |
| Set the encoded flags. More... | |
| const DtString & | name () 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... | |
| DtBaseHla1516Value & | operator= (const DtBaseHla1516Value &src) |
| Assignment operator. More... | |
| const DtLgrVariableLengthData & | encodedHandle () 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 | unserializeParameters (char *bfr, int bsz, int num) |
Additional Inherited Members | |
Public Types inherited from MAKLogger::DtBaseHlaClass< DtBaseParamDesc > | |
| typedef std::vector < DtBaseParamDesc > | ValueVector |
| typedef ValueVector::iterator | iterator |
| typedef ValueVector::const_iterator | const_iterator |
Represents a HLA 1516 Fom Interaction class descriptions.
| MAKLogger::DtBaseInterClassDesc::DtBaseInterClassDesc | ( | char *& | bfr, |
| int & | bsz | ||
| ) |
Incomplete constructor (from serial form, with delayed initialization)
|
virtual |
Destructor.
| MAKLogger::DtBaseInterClassDesc::DtBaseInterClassDesc | ( | const DtBaseInterClassDesc & | src | ) |
Copy constructor.
|
inline |
Is this interaction class a base class for other interaction classes.
References MAKLogger::DtLgrFomDesc_IsBaseClass, and MAKLogger::DtBaseHlaValue::flags().
|
inline |
Is this interaction class filtered out.
References MAKLogger::DtLgrFomDesc_IsFiltered, and MAKLogger::DtBaseHlaValue::flags().
|
inline |
Is this interaction class subscribed to.
References MAKLogger::DtLgrFomDesc_IsSubscribed, and MAKLogger::DtBaseHlaValue::flags().
| DtBaseInterClassDesc& MAKLogger::DtBaseInterClassDesc::operator= | ( | const DtBaseInterClassDesc & | src | ) |
Assignment operator.
|
inline |
Returns the order type (i.e., "receive order", "time stamp order") for this interaction class.
References MAKLogger::DtLgr_Receive, MAKLogger::DtLgr_TimeStamp, MAKLogger::DtLgrFomDesc_TimeStamp, and MAKLogger::DtBaseHlaValue::flags().
|
protected |
Called from the constructors.
| RTI::InteractionClassHandle MAKLogger::DtBaseInterClassDesc::rtiHandle | ( | const DtLgrOnlineFomDesc & | fomDesc | ) | const |
Return the corresponding RTI ParameterHandle.
| int MAKLogger::DtBaseInterClassDesc::serialize | ( | char *& | bfr, |
| int & | bsz | ||
| ) | const |
This method serializes the entire information contained in the current interaction 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 interaction 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.
|
inline |
Set whether this class is a base class.
References MAKLogger::DtLgrFomDesc_IsBaseClass, MAKLogger::DtBaseHlaValue::flags(), and MAKLogger::DtBaseHlaValue::setFlags().
|
inline |
Toggle on/off the filtering of this interaction class.
References MAKLogger::DtLgrFomDesc_IsFiltered, MAKLogger::DtBaseHlaValue::flags(), and MAKLogger::DtBaseHlaValue::setFlags().
|
inline |
Toggle on/off the subscription to this interaction class.
References MAKLogger::DtLgrFomDesc_IsSubscribed, MAKLogger::DtBaseHlaValue::flags(), and MAKLogger::DtBaseHlaValue::setFlags().
|
inline |
Sets the ordertype.
References MAKLogger::DtLgr_TimeStamp, MAKLogger::DtLgrFomDesc_TimeStamp, MAKLogger::DtBaseHlaValue::flags(), and MAKLogger::DtBaseHlaValue::setFlags().
|
inline |
Sets the transport type.
References MAKLogger::DtLgr_Reliable, MAKLogger::DtLgrFomDesc_Reliable, MAKLogger::DtBaseHlaValue::flags(), and MAKLogger::DtBaseHlaValue::setFlags().
|
inline |
Returns the transport type (i.e., "best effort", "reliable") for this interaction class.
References MAKLogger::DtLgr_BestEffort, MAKLogger::DtLgr_Reliable, MAKLogger::DtLgrFomDesc_Reliable, and MAKLogger::DtBaseHlaValue::flags().
|
protected |