VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtBaseEmbeddedSystemEncoder Class Reference

Instances of DtBaseEmbeddedSystemEncoder are used to encode a base embedded system state repository into a state message in an HLA environment. More...

+ Inheritance diagram for DtBaseEmbeddedSystemEncoder:
+ Collaboration diagram for DtBaseEmbeddedSystemEncoder:

Public Member Functions

 DtBaseEmbeddedSystemEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 default constructor
virtual ~DtBaseEmbeddedSystemEncoder ()
 destructor
 DtBaseEmbeddedSystemEncoder (const DtBaseEmbeddedSystemEncoder &orig)
 copy constructor
DtBaseEmbeddedSystemEncoderoperator= (const DtBaseEmbeddedSystemEncoder &orig)
 assignment operator
- Public Member Functions inherited from DtHlaStateEncoder
 DtHlaStateEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 constructor
virtual ~DtHlaStateEncoder ()
 destructor
 DtHlaStateEncoder (const DtHlaStateEncoder &orig)
 copy constructor
DtHlaStateEncoderoperator= (const DtHlaStateEncoder &orig)
 assignment operator
DtAttributeEncoder addEncoder (RTI::AttributeHandle hand, DtAttributeEncoder func)
 Add/Remove an encoding function for the attribute specified by handle.
DtAttributeEncoder removeEncoder (RTI::AttributeHandle hand)
DtAttributeEncoder addEncoder (char *name, DtAttributeEncoder func, bool complain=true)
 Add/Remove an encoding function for the attribute specified by name.
DtAttributeEncoder removeEncoder (char *name, bool complain=true)
DtAttributeChecker addChecker (RTI::AttributeHandle hand, DtAttributeChecker func)
 Add/Remove a checker function for the attribute specified by handle.
DtAttributeChecker removeChecker (RTI::AttributeHandle hand)
DtAttributeChecker addChecker (char *name, DtAttributeChecker func, bool complain=true)
 Add/Remove a checker function for the attribute specified by name.
DtAttributeChecker removeChecker (char *name, bool complain=true)
DtAttributeEncoder encoder (const RTI::AttributeHandle &handle)
 Get the attribute encoder for the specified handle.
DtAttributeChecker checker (const RTI::AttributeHandle &handle)
 Get the attribute checker for the specified handle.
virtual void encode (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote, const RTI::AttributeHandleSet &neededAttrs, const RTI::AttributeHandleSet &includeThese, DtStateMsg *msg)
 Encode necessary values from the state repository.
virtual RTI::ObjectClassHandle objectClassHandle ()
 Get the object's class handle.
virtual DtHlaStateEncoderclone (DtObjClassDesc *classDesc) const
 Returns a new-ed clone of this object which corresponds to the class description classDesc.
virtual DtHlaStateEncoderclone () const
 Returns a new-ed clone of this object.
virtual void preCalculateEligible (const RTI::AttributeHandleSet &neededAttrs)

Static Public Member Functions

static DtHlaStateEncodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Create a DtBaseEntityEncoder. Caller is responsible for deletion.
- Static Public Member Functions inherited from DtHlaStateEncoder
static bool trueChecker (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 A checker function that always returns 1, meaning that the attribute for which it is being used will be deemed necessary to send on every tick.
static bool falseChecker (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 A checker function that always returns 0, meaning that the attribute for which it is being used will never be deemed necessary to send.

Protected Member Functions

 DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (RelativePosition)
 DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (EntityID)
 for version <= 0.8
 DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (HostObjectID)
 DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (EntityIdentifier)
 for version > 0.8
 DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (HostObjectIdentifier)
 DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (RelativePosition)
 DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (EntityID)
 for version <= 0.8
 DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (HostObjectID)
 DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (EntityIdentifier)
 for version > 0.8
 DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (HostObjectIdentifier)

Additional Inherited Members

- Public Types inherited from DtHlaStateEncoder
typedef void(* DtAttributeEncoder )(const DtStateRepository &stateRep, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle handle)
 Attribute encoding function declaration.
typedef bool(* DtAttributeChecker )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 Attribute checking function declaration.
typedef bool(* DtAttributeCheckerWithHandle )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote, RTI::AttributeHandle handle)
 Attribute checking function declaration that takes a handle and checks the specific attribute pointed to by that handle.
- Protected Attributes inherited from DtHlaStateEncoder
DtExerciseConnmyExConn
DtObjClassDescmyClassDesc
RTI::ObjectClassHandle myHandle
std::map< RTI::AttributeHandle,
DtAttributeEncoder
myEncoderList
 myEncoderList and myCheckerList are arrays of classDesc->maxAttrHandle() items.
std::map< RTI::AttributeHandle,
DtAttributeChecker
myCheckerList
std::vector< DtAttributeCheckermyCheckerCache
 This is a helper varaible that pre-lookups decoder functions in order to avoid making map calls on every update.
const RTI::AttributeHandleSet * myCachedSet
std::map< RTI::AttributeHandle,
bool
myReportedWarning
 myReportedWarning is an array for keeping track of which warnings have already been reported

Detailed Description

Instances of DtBaseEmbeddedSystemEncoder are used to encode a base embedded system state repository into a state message in an HLA environment.

Constructor & Destructor Documentation

DtBaseEmbeddedSystemEncoder::DtBaseEmbeddedSystemEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

default constructor

virtual DtBaseEmbeddedSystemEncoder::~DtBaseEmbeddedSystemEncoder ( )
virtual

destructor

DtBaseEmbeddedSystemEncoder::DtBaseEmbeddedSystemEncoder ( const DtBaseEmbeddedSystemEncoder orig)

copy constructor

Member Function Documentation

static DtHlaStateEncoder* DtBaseEmbeddedSystemEncoder::create ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)
static
DtBaseEmbeddedSystemEncoder::DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER ( RelativePosition  )
protected
DtBaseEmbeddedSystemEncoder::DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER ( EntityID  )
protected

for version <= 0.8

DtBaseEmbeddedSystemEncoder::DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER ( HostObjectID  )
protected
DtBaseEmbeddedSystemEncoder::DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER ( EntityIdentifier  )
protected

for version > 0.8

DtBaseEmbeddedSystemEncoder::DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER ( HostObjectIdentifier  )
protected
DtBaseEmbeddedSystemEncoder::DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER ( RelativePosition  )
protected
DtBaseEmbeddedSystemEncoder::DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER ( EntityID  )
protected

for version <= 0.8

DtBaseEmbeddedSystemEncoder::DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER ( HostObjectID  )
protected
DtBaseEmbeddedSystemEncoder::DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER ( EntityIdentifier  )
protected

for version > 0.8

DtBaseEmbeddedSystemEncoder::DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER ( HostObjectIdentifier  )
protected
DtBaseEmbeddedSystemEncoder& DtBaseEmbeddedSystemEncoder::operator= ( const DtBaseEmbeddedSystemEncoder orig)

assignment operator


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

Document ID: Generated on Wed Jan 7 13:31:29 EST 2015 from SVN revision 149162
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)