MAK Data Logger API Documentation for HLA
List of all members | Public Member Functions
MAKLogger::DtBaseAttrDesc Class Reference

DtBaseAttrDesc is a descriptor of an HLA object attribute. More...

+ Inheritance diagram for MAKLogger::DtBaseAttrDesc:
+ Collaboration diagram for MAKLogger::DtBaseAttrDesc:

Public Member Functions

 DtBaseAttrDesc (const DtString &name, DtLgrHlaHandle handle, const void *handCode, int codeSize)
 Main constructor.
virtual ~DtBaseAttrDesc ()
 Destructor.
 DtBaseAttrDesc (const DtBaseAttrDesc &src)
 Copy constructor.
DtBaseAttrDescoperator= (const DtBaseAttrDesc &src)
 Assignment operator.
RTI::AttributeHandle rtiHandle (const DtLgrOnlineFomDesc &) const
 Return the corresponding RTI AttributeHandle.
bool isSubscribedTo () const
 Is this object attribute subscribed to.
void setIsSubscribedTo (bool onOff)
 Toggle on/off the subscription to this object attribute.
bool isReliable () const
void setIsReliable (bool reliable)
bool isTimeStamped () const
void setTimeStamped (bool timeStamped)
DtLgrFomTransportType transportType () const
 Returns the transport type (i.e., "best effort", "reliable") for this attribute.
DtLgrFomOrderType orderType () const
 Returns the order type (i.e., "receive order", "time stamp order") for this attribute.
- Public Member Functions inherited from MAKLogger::DtBaseHla1516Value
 DtBaseHla1516Value (const DtString &name, DtU32 handle, const DtLgrVariableLengthData &code)
 Main constructor.
virtual ~DtBaseHla1516Value ()
 Destructor.
 DtBaseHla1516Value (const DtBaseHla1516Value &src)
 Copy constructor.
DtBaseHla1516Valueoperator= (const DtBaseHla1516Value &src)
 Assignment operator.
const DtLgrVariableLengthDataencodedHandle () const
 Get the encoded handle.
const void * code () const
 Return the encoded handle data..
int codeLength () const
 Return the encoded handle size.
void setCode (const DtLgrVariableLengthData &code)
 Set the encoded handle.
void setCode (const void *data, int size)
 Set the encoded handle.
- 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.
void setFlags (DtU32)
 Set the encoded flags.
const DtStringname () const
void setName (const DtString &name)
const char * name2print () const
DtLgrHlaHandle handle () const
void setHandle (DtLgrHlaHandle handle)

Detailed Description

DtBaseAttrDesc is a descriptor of an HLA object attribute.

Constructor & Destructor Documentation

MAKLogger::DtBaseAttrDesc::DtBaseAttrDesc ( const DtString name,
DtLgrHlaHandle  handle,
const void *  handCode,
int  codeSize 
)

Main constructor.

virtual MAKLogger::DtBaseAttrDesc::~DtBaseAttrDesc ( )
virtual

Destructor.

MAKLogger::DtBaseAttrDesc::DtBaseAttrDesc ( const DtBaseAttrDesc src)

Copy constructor.

Member Function Documentation

bool MAKLogger::DtBaseAttrDesc::isReliable ( ) const
inline
bool MAKLogger::DtBaseAttrDesc::isSubscribedTo ( ) const
inline

Is this object attribute subscribed to.

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

bool MAKLogger::DtBaseAttrDesc::isTimeStamped ( ) const
inline
DtBaseAttrDesc& MAKLogger::DtBaseAttrDesc::operator= ( const DtBaseAttrDesc src)

Assignment operator.

DtLgrFomOrderType MAKLogger::DtBaseAttrDesc::orderType ( ) const
inline

Returns the order type (i.e., "receive order", "time stamp order") for this attribute.

References MAKLogger::DtLgr_Receive, MAKLogger::DtLgr_TimeStamp, MAKLogger::DtLgrFomDesc_TimeStamp, and MAKLogger::DtBaseHlaValue::flags().

RTI::AttributeHandle MAKLogger::DtBaseAttrDesc::rtiHandle ( const DtLgrOnlineFomDesc ) const

Return the corresponding RTI AttributeHandle.

void MAKLogger::DtBaseAttrDesc::setIsReliable ( bool  reliable)
inline
void MAKLogger::DtBaseAttrDesc::setIsSubscribedTo ( bool  onOff)
inline

Toggle on/off the subscription to this object attribute.

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

void MAKLogger::DtBaseAttrDesc::setTimeStamped ( bool  timeStamped)
inline
DtLgrFomTransportType MAKLogger::DtBaseAttrDesc::transportType ( ) const
inline

Returns the transport type (i.e., "best effort", "reliable") for this attribute.

References MAKLogger::DtLgr_BestEffort, MAKLogger::DtLgr_Reliable, MAKLogger::DtLgrFomDesc_Reliable, and MAKLogger::DtBaseHlaValue::flags().


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

Document ID: Generated on Sun Dec 15 18:04:30 EST 2013 from SVN revision 134418
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)