VR-Link API Documentation for HLA Evolved
 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
DtPointObjectEncoder Class Reference

Instances of DtPointObjectEncoder are used to encode point object state messages from a state repository in an HLA environment. More...

+ Inheritance diagram for DtPointObjectEncoder:
+ Collaboration diagram for DtPointObjectEncoder:

Public Member Functions

 DtPointObjectEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 default constructor
 DtPointObjectEncoder (const DtPointObjectEncoder &orig)
 copy constructor
virtual ~DtPointObjectEncoder ()
 destructor
DtPointObjectEncoderoperator= (const DtPointObjectEncoder &orig)
 assignment operator
- Public Member Functions inherited from DtEnvironmentObjectEncoder
 DtEnvironmentObjectEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 default constructor
virtual ~DtEnvironmentObjectEncoder ()
 destructor
 DtEnvironmentObjectEncoder (const DtEnvironmentObjectEncoder &orig)
 copy constructor
DtEnvironmentObjectEncoderoperator= (const DtEnvironmentObjectEncoder &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.

Protected Member Functions

 DtDECLARE_POINT_OBJ_ATTR_CHECKER (Location)
 Used for RPR > 2.0002.
 DtDECLARE_POINT_OBJ_ATTR_CHECKER (Orientation)
 DtDECLARE_POINT_OBJ_ATTR_CHECKER (PercentComplete)
 DtDECLARE_POINT_OBJ_ATTR_CHECKER (DamagedAppearance)
 DtDECLARE_POINT_OBJ_ATTR_CHECKER (ObjectPreDistributed)
 DtDECLARE_POINT_OBJ_ATTR_CHECKER (Deactivated)
 DtDECLARE_POINT_OBJ_ATTR_CHECKER (Smoking)
 DtDECLARE_POINT_OBJ_ATTR_CHECKER (Flaming)
 DtDECLARE_POINT_OBJ_ATTR_ENCODER (Location)
 DtDECLARE_POINT_OBJ_ATTR_ENCODER (Orientation)
 DtDECLARE_POINT_OBJ_ATTR_ENCODER (PercentComplete)
 DtDECLARE_POINT_OBJ_ATTR_ENCODER (DamagedAppearance)
 DtDECLARE_POINT_OBJ_ATTR_ENCODER (ObjectPreDistributed)
 DtDECLARE_POINT_OBJ_ATTR_ENCODER (Deactivated)
 DtDECLARE_POINT_OBJ_ATTR_ENCODER (Smoking)
 DtDECLARE_POINT_OBJ_ATTR_ENCODER (Flaming)
- Protected Member Functions inherited from DtEnvironmentObjectEncoder
 DtDECLARE_ENVIRONMENTOBJ_ATTR_CHECKER (ObjectIdentifier)
 Used for RPR > 2.0002.
 DtDECLARE_ENVIRONMENTOBJ_ATTR_CHECKER (ReferencedObjectIdentifier)
 DtDECLARE_ENVIRONMENTOBJ_ATTR_CHECKER (ForceIdentifier)
 DtDECLARE_ENVIRONMENTOBJ_ATTR_CHECKER (ObjectType)
 DtDECLARE_ENVIRONMENTOBJ_ATTR_ENCODER (ObjectIdentifier)
 DtDECLARE_ENVIRONMENTOBJ_ATTR_ENCODER (ReferencedObjectIdentifier)
 DtDECLARE_ENVIRONMENTOBJ_ATTR_ENCODER (ForceIdentifier)
 DtDECLARE_ENVIRONMENTOBJ_ATTR_ENCODER (ObjectType)

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 DtPointObjectEncoder are used to encode point object state messages from a state repository in an HLA environment.

Constructor & Destructor Documentation

DtPointObjectEncoder::DtPointObjectEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

default constructor

DtPointObjectEncoder::DtPointObjectEncoder ( const DtPointObjectEncoder orig)

copy constructor

virtual DtPointObjectEncoder::~DtPointObjectEncoder ( )
virtual

destructor

Member Function Documentation

static DtHlaStateEncoder* DtPointObjectEncoder::create ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)
static

Create a DtBaseEntityEncoder. Caller is responsible for deletion.

Reimplemented from DtEnvironmentObjectEncoder.

Reimplemented in DtRibbonBridgeEncoder, DtBreachPointObjectEncoder, DtBurstPointObjectEncoder, and DtCraterObjectEncoder.

DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_CHECKER ( Location  )
protected

Used for RPR > 2.0002.

DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_CHECKER ( Orientation  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_CHECKER ( PercentComplete  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_CHECKER ( DamagedAppearance  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_CHECKER ( ObjectPreDistributed  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_CHECKER ( Deactivated  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_CHECKER ( Smoking  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_CHECKER ( Flaming  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_ENCODER ( Location  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_ENCODER ( Orientation  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_ENCODER ( PercentComplete  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_ENCODER ( DamagedAppearance  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_ENCODER ( ObjectPreDistributed  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_ENCODER ( Deactivated  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_ENCODER ( Smoking  )
protected
DtPointObjectEncoder::DtDECLARE_POINT_OBJ_ATTR_ENCODER ( Flaming  )
protected
DtPointObjectEncoder& DtPointObjectEncoder::operator= ( const DtPointObjectEncoder 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)