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

class DtGriddedDataEncoder More...

+ Inheritance diagram for DtGriddedDataEncoder:
+ Collaboration diagram for DtGriddedDataEncoder:

Public Member Functions

 DtGriddedDataEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 default constructor
virtual ~DtGriddedDataEncoder ()
 destructor
 DtGriddedDataEncoder (const DtGriddedDataEncoder &orig)
 copy constructor
- 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_GRIDDATA_ATTR_CHECKER (GridIdentifier)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (GridID)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (FieldNumber)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (RecordNumber)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (RecordTotal)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (CoordinateSystem)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (NumberOfGridAxes)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (ConstantGrid)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (EnvironmentType)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (Orientation)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (SampleTime)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (TotalValues)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (VectorDimension)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (GridAxisInfo)
 DtDECLARE_GRIDDATA_ATTR_CHECKER (GridDataInfo)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (GridIdentifier)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (GridID)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (FieldNumber)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (RecordNumber)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (RecordTotal)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (CoordinateSystem)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (NumberOfGridAxes)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (ConstantGrid)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (EnvironmentType)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (Orientation)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (SampleTime)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (TotalValues)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (VectorDimension)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (GridAxisInfo)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (GridAxisInfo_RPR_20)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (GridDataInfo)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (GridDataInfo_RPR_20)
 DtDECLARE_GRIDDATA_ATTR_ENCODER (GridDataInfo_RPR2_Rev3)

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

class DtGriddedDataEncoder

Instances of DtGriddedDataEncoder are used to encode gridded data state message data from a state repository in an HLA environment.

Constructor & Destructor Documentation

DtGriddedDataEncoder::DtGriddedDataEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

default constructor

virtual DtGriddedDataEncoder::~DtGriddedDataEncoder ( )
virtual

destructor

DtGriddedDataEncoder::DtGriddedDataEncoder ( const DtGriddedDataEncoder orig)

copy constructor

Member Function Documentation

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

Create a DtBaseEntityEncoder. Caller is responsible for deletion.

DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( GridIdentifier  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( GridID  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( FieldNumber  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( RecordNumber  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( RecordTotal  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( CoordinateSystem  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( NumberOfGridAxes  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( ConstantGrid  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( EnvironmentType  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( Orientation  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( SampleTime  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( TotalValues  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( VectorDimension  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( GridAxisInfo  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_CHECKER ( GridDataInfo  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( GridIdentifier  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( GridID  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( FieldNumber  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( RecordNumber  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( RecordTotal  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( CoordinateSystem  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( NumberOfGridAxes  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( ConstantGrid  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( EnvironmentType  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( Orientation  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( SampleTime  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( TotalValues  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( VectorDimension  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( GridAxisInfo  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( GridAxisInfo_RPR_20  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( GridDataInfo  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( GridDataInfo_RPR_20  )
protected
DtGriddedDataEncoder::DtDECLARE_GRIDDATA_ATTR_ENCODER ( GridDataInfo_RPR2_Rev3  )
protected

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

Document ID: Generated on Fri May 15 06:36:13 EDT 2015 from SVN revision 153263
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)