VR-Link API Documentation for HLA Evolved
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtEnvironmentProcessEncoder Class Reference

class DtEnvironmentProcessEncoder More...

+ Inheritance diagram for DtEnvironmentProcessEncoder:
+ Collaboration diagram for DtEnvironmentProcessEncoder:

Public Member Functions

 DtEnvironmentProcessEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
virtual ~DtEnvironmentProcessEncoder ()
 destructor
 DtEnvironmentProcessEncoder (const DtEnvironmentProcessEncoder &orig)
- 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)
virtual DtAttributeEncoder encoder (const RTI::AttributeHandle &handle)
 Get the attribute encoder for the specified handle.
virtual 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.

Static Public Member Functions

static DtHlaStateEncodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Create a DtBaseEntityEncoder. Caller is responsible for deletion.
static int recordSize_RPR_20014 (unsigned long theType)
 get the size of the Rec Data for RPR Fom 2.0
- 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_ENVPROC_ATTR_CHECKER (ProcessIdentifier)
 DtDECLARE_ENVPROC_ATTR_CHECKER (Type)
 DtDECLARE_ENVPROC_ATTR_CHECKER (ModelType)
 DtDECLARE_ENVPROC_ATTR_CHECKER (EnvironmentProcessActive)
 DtDECLARE_ENVPROC_ATTR_CHECKER (SequenceNumber)
 DtDECLARE_ENVPROC_ATTR_CHECKER (EnvironmentRecData)
 DtDECLARE_ENVPROC_ATTR_ENCODER (ProcessIdentifier)
 DtDECLARE_ENVPROC_ATTR_ENCODER (Type)
 DtDECLARE_ENVPROC_ATTR_ENCODER (ModelType)
 DtDECLARE_ENVPROC_ATTR_ENCODER (EnvironmentProcessActive)
 DtDECLARE_ENVPROC_ATTR_ENCODER (SequenceNumber)
 DtDECLARE_ENVPROC_ATTR_ENCODER (EnvironmentRecData)
 DtDECLARE_ENVPROC_ATTR_ENCODER (EnvironmentRecData_RPR_20014)
 DtDECLARE_ENVPROC_ATTR_ENCODER (EnvironmentRecData_RPR_20017)
 DtDECLARE_ENVPROC_ATTR_ENCODER (EnvironmentRecData_RPR_20017_Rev4)

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.
- 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::map< RTI::AttributeHandle,
bool > 
myReportedWarning
 myReportedWarning is an array for keeping track of which warnings have already been reported

Detailed Description

class DtEnvironmentProcessEncoder

Instances of DtEnvironmentProcessEncoder are used to encode environment process state messages from a state repository in an HLA environment.

Constructor & Destructor Documentation

DtEnvironmentProcessEncoder::DtEnvironmentProcessEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)
virtual DtEnvironmentProcessEncoder::~DtEnvironmentProcessEncoder ( )
virtual

destructor

DtEnvironmentProcessEncoder::DtEnvironmentProcessEncoder ( const DtEnvironmentProcessEncoder orig)

Member Function Documentation

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

Create a DtBaseEntityEncoder. Caller is responsible for deletion.

DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_CHECKER ( ProcessIdentifier  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_CHECKER ( Type  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_CHECKER ( ModelType  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_CHECKER ( EnvironmentProcessActive  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_CHECKER ( SequenceNumber  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_CHECKER ( EnvironmentRecData  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_ENCODER ( ProcessIdentifier  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_ENCODER ( Type  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_ENCODER ( ModelType  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_ENCODER ( EnvironmentProcessActive  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_ENCODER ( SequenceNumber  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_ENCODER ( EnvironmentRecData  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_ENCODER ( EnvironmentRecData_RPR_20014  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_ENCODER ( EnvironmentRecData_RPR_20017  )
protected
DtEnvironmentProcessEncoder::DtDECLARE_ENVPROC_ATTR_ENCODER ( EnvironmentRecData_RPR_20017_Rev4  )
protected
static int DtEnvironmentProcessEncoder::recordSize_RPR_20014 ( unsigned long  theType)
static

get the size of the Rec Data for RPR Fom 2.0


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

Document ID: Generated on Wed Oct 23 22:25:48 EDT 2013 from SVN revision 132765
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)