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 | Protected Member Functions
TestEncoder Class Reference

This class encodes a Test interaction from a TestInteraction object. More...

+ Inheritance diagram for TestEncoder:
+ Collaboration diagram for TestEncoder:

Public Member Functions

 TestEncoder (DtExerciseConn *exConn, DtInterClassDesc *classDesc)
 Constructor. More...
 
virtual ~TestEncoder ()
 Destructor. More...
 
 TestEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 default constructor More...
 
virtual ~TestEncoder ()
 destructor More...
 
- Public Member Functions inherited from DtHlaStateEncoder
 DtHlaStateEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 constructor More...
 
virtual ~DtHlaStateEncoder ()
 destructor More...
 
 DtHlaStateEncoder (const DtHlaStateEncoder &orig)
 copy constructor More...
 
DtHlaStateEncoderoperator= (const DtHlaStateEncoder &orig)
 assignment operator More...
 
DtAttributeEncoder addEncoder (RTI::AttributeHandle hand, DtAttributeEncoder func)
 Add/Remove an encoding function for the attribute specified by handle. More...
 
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. More...
 
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. More...
 
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. More...
 
DtAttributeChecker removeChecker (char *name, bool complain=true)
 
DtAttributeEncoder encoder (const RTI::AttributeHandle &handle)
 Get the attribute encoder for the specified handle. More...
 
DtAttributeChecker checker (const RTI::AttributeHandle &handle)
 Get the attribute checker for the specified handle. More...
 
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. More...
 
virtual RTI::ObjectClassHandle objectClassHandle ()
 Get the object's class handle. More...
 
virtual DtHlaStateEncoderclone (DtObjClassDesc *classDesc) const
 Returns a new-ed clone of this object which corresponds to the class description classDesc. More...
 
virtual DtHlaStateEncoderclone () const
 Returns a new-ed clone of this object. More...
 
virtual void preCalculateEligible (const RTI::AttributeHandleSet &neededAttrs)
 
- Public Member Functions inherited from DtInteractionEncoder
 DtInteractionEncoder (DtExerciseConn *exConn, DtInterClassDesc *classDesc)
 constructor More...
 
virtual ~DtInteractionEncoder ()
 destructor More...
 
 DtInteractionEncoder (const DtInteractionEncoder &orig)
 copy constructor More...
 
DtInteractionEncoderoperator= (const DtInteractionEncoder &orig)
 assignment operator More...
 
virtual DtParameterEncoder addEncoder (RTI::ParameterHandle hand, DtParameterEncoder func)
 Add a parameter encoder function by parameter handle. More...
 
virtual DtParameterEncoder addEncoder (char *name, DtParameterEncoder proc)
 Add a parameter encoder function by parameter name. More...
 
virtual DtParameterEncoder encoder (RTI::ParameterHandle hand)
 Get the parameter encoder for the specified handle. More...
 
virtual void encode (const DtInteractionRep &inter, RTI::ParameterHandleValueMap &pvMap)
 Encode necessary values from the protocol-independent interaction. More...
 
virtual RTI::InteractionClassHandle interClassHandle ()
 Get the object's class handle. More...
 
virtual DtInteractionEncoderclone () const
 Returns a new-ed clone of this object. More...
 
virtual DtInteractionEncoderclone (DtInterClassDesc *interDesc) const
 Returns a new-ed clone of this object which corresponds to the inter description interDesc. More...
 

Protected Member Functions

 DtDECLARE_TEST_PARAM_ENCODER (Number)
 Individual parameter encoding functions - one for each parameter. More...
 
 DtDECLARE_TEST_PARAM_ENCODER (Vector)
 Individual parameter encoding functions - one for each parameter. More...
 
 DtDECLARE_TEST_ATTR_ENCODER (Number)
 Individual attribute encoding functions - one for each attribute. More...
 
 DtDECLARE_TEST_ATTR_ENCODER (Vector)
 
 DtDECLARE_TEST_ATTR_CHECKER (Number)
 Individual attribute checking functions - one for each attribute. More...
 
 DtDECLARE_TEST_ATTR_CHECKER (Vector)
 

Additional Inherited Members

- Public Types inherited from DtHlaStateEncoder
typedef void(* DtAttributeEncoder )(const DtStateRepository &stateRep, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle handle)
 Attribute encoding function declaration. More...
 
typedef bool(* DtAttributeChecker )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 Attribute checking function declaration. More...
 
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. More...
 
- Public Types inherited from DtInteractionEncoder
typedef void(* DtParameterEncoder )(const DtInteractionRep &inter, RTI::ParameterHandleValuePairSet *avlist, RTI::ParameterHandle handle)
 Attribute encoding function declaration. More...
 
- 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. More...
 
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. More...
 
static void wideStringToHlaUnicodeString (const std::wstring &wideString, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle attrHandle)
 Puts a unicode widestring into a buffer of the appropriate size and adds it to the attribute value list with it's attribute handle. More...
 
- Static Public Member Functions inherited from DtInteractionEncoder
static void encodeGenericParameter (const DtInteractionWithEncDec &inter, RTI::ParameterHandleValuePairSet *avlist, RTI::ParameterHandle 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. More...
 
std::map< RTI::AttributeHandle,
DtAttributeChecker
myCheckerList
 
std::vector< DtAttributeCheckermyCheckerCache
 This is a helper variable that pre-lookups decoder functions in order to avoid making map calls on every update. More...
 
const RTI::AttributeHandleSet * myCachedSet
 
std::map< RTI::AttributeHandle,
bool
myReportedWarning
 myReportedWarning is an array for keeping track of which warnings have already been reported More...
 
- Protected Attributes inherited from DtInteractionEncoder
DtExerciseConnmyExConn
 
DtInterClassDescmyClassDesc
 
RTI::RTIambassador * myRtiAmb
 
RTI::InteractionClassHandle myHandle
 
std::map< RTI::ParameterHandle,
DtParameterEncoder
myList
 myList is an array of classDesc->maxParamHandle() items. More...
 

Detailed Description

This class encodes a Test interaction from a TestInteraction object.

The TestEncoder class.

Constructor & Destructor Documentation

TestEncoder::TestEncoder ( DtExerciseConn exConn,
DtInterClassDesc classDesc 
)

Constructor.

virtual TestEncoder::~TestEncoder ( )
virtual

Destructor.

TestEncoder::TestEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

default constructor

virtual TestEncoder::~TestEncoder ( )
virtual

destructor

Member Function Documentation

TestEncoder::DtDECLARE_TEST_ATTR_CHECKER ( Number  )
protected

Individual attribute checking functions - one for each attribute.

This macro expands to look like this: static bool needNumber(const TestStateRepository& rep, const TestStateRepository& asSeenByRemote);

TestEncoder::DtDECLARE_TEST_ATTR_CHECKER ( Vector  )
protected
TestEncoder::DtDECLARE_TEST_ATTR_ENCODER ( Number  )
protected

Individual attribute encoding functions - one for each attribute.

This macro expands to look like this: static void encodeNumber(const TestStateRepository& rep, RTI::AttributeHandleValuePairSet* attrs, RTI::AttributeHandle attrHandle)

TestEncoder::DtDECLARE_TEST_ATTR_ENCODER ( Vector  )
protected
TestEncoder::DtDECLARE_TEST_PARAM_ENCODER ( Number  )
protected

Individual parameter encoding functions - one for each parameter.

These macros expand to look like this: static void encodeNumber(const TestInteraction& inter, RTI::ParameterHandleValuePairSet* params, RTI::ParameterHandle paramHandle);

TestEncoder::DtDECLARE_TEST_PARAM_ENCODER ( Vector  )
protected

Individual parameter encoding functions - one for each parameter.

These macros expand to look like this: static void encodeNumber(const TestInteraction& inter, RTI::ParameterHandleValuePairSet* params, RTI::ParameterHandle paramHandle);


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

Document ID: Generated on Wed Mar 27 02:04:30 EDT 2024 from SVN revision 264570
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)