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

Instances of DtWindCorridorEncoder encode data from DtWindCorridorStateRepository objects to the net structures to be sent to the network. More...

+ Inheritance diagram for DtWindCorridorEncoder:
+ Collaboration diagram for DtWindCorridorEncoder:

Public Member Functions

 DtWindCorridorEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Default constructor. More...
 
virtual ~DtWindCorridorEncoder ()
 Destructor. More...
 
 DtWindCorridorEncoder (const DtWindCorridorEncoder &orig)
 Copy constructor. More...
 
DtWindCorridorEncoderoperator= (const DtWindCorridorEncoder &orig)
 Assignment operator. More...
 
- Public Member Functions inherited from DtMetocRootEncoder
 DtMetocRootEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Default constructor. More...
 
virtual ~DtMetocRootEncoder ()
 Destructor. More...
 
 DtMetocRootEncoder (const DtMetocRootEncoder &orig)
 Copy constructor. More...
 
DtMetocRootEncoderoperator= (const DtMetocRootEncoder &orig)
 Assignment operator. 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)
 

Static Public Member Functions

static DtHlaStateEncodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Function that creates a DtWindCorridorEncoder. More...
 
- Static Public Member Functions inherited from DtMetocRootEncoder
static DtHlaStateEncodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Function that creates a DtMetocRootEncoder. 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 Protected Member Functions

static bool needPath (const DtWindCorridorStateRepository &stateRep, const DtWindCorridorStateRepository &asSeenByRemote)
 Return true if Path needs to be sent to the network, false otherwise. More...
 
static void encodePath (const DtWindCorridorStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Path from rep into attrs. More...
 
static bool needWidth (const DtWindCorridorStateRepository &stateRep, const DtWindCorridorStateRepository &asSeenByRemote)
 Return true if Width needs to be sent to the network, false otherwise. More...
 
static void encodeWidth (const DtWindCorridorStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Width from rep into attrs. More...
 
static bool needHeight (const DtWindCorridorStateRepository &stateRep, const DtWindCorridorStateRepository &asSeenByRemote)
 Return true if Height needs to be sent to the network, false otherwise. More...
 
static void encodeHeight (const DtWindCorridorStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Height from rep into attrs. More...
 
static bool needWindSpeed (const DtWindCorridorStateRepository &stateRep, const DtWindCorridorStateRepository &asSeenByRemote)
 Return true if WindSpeed needs to be sent to the network, false otherwise. More...
 
static void encodeWindSpeed (const DtWindCorridorStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes WindSpeed from rep into attrs. More...
 
static bool needPriority (const DtWindCorridorStateRepository &stateRep, const DtWindCorridorStateRepository &asSeenByRemote)
 Return true if Priority needs to be sent to the network, false otherwise. More...
 
static void encodePriority (const DtWindCorridorStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Priority from rep into attrs. More...
 
static bool needVrfWeatherAreaIdentifier (const DtWindCorridorStateRepository &stateRep, const DtWindCorridorStateRepository &asSeenByRemote)
 Return true if VrfWeatherAreaIdentifier needs to be sent to the network, false otherwise. More...
 
static void encodeVrfWeatherAreaIdentifier (const DtWindCorridorStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes VrfWeatherAreaIdentifier from rep into attrs. More...
 
- Static Protected Member Functions inherited from DtMetocRootEncoder
static bool needUniqueId (const DtMetocRootStateRepository &stateRep, const DtMetocRootStateRepository &asSeenByRemote)
 Return true if UniqueId needs to be sent to the network, false otherwise. More...
 
static void encodeUniqueId (const DtMetocRootStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes UniqueId from rep into attrs. More...
 
static bool needName (const DtMetocRootStateRepository &stateRep, const DtMetocRootStateRepository &asSeenByRemote)
 Return true if Name needs to be sent to the network, false otherwise. More...
 
static void encodeName (const DtMetocRootStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Name from rep into attrs. More...
 

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...
 
- 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...
 

Detailed Description

Instances of DtWindCorridorEncoder encode data from DtWindCorridorStateRepository objects to the net structures to be sent to the network.

Constructor & Destructor Documentation

DtWindCorridorEncoder::DtWindCorridorEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

Default constructor.

virtual DtWindCorridorEncoder::~DtWindCorridorEncoder ( )
virtual

Destructor.

DtWindCorridorEncoder::DtWindCorridorEncoder ( const DtWindCorridorEncoder orig)

Copy constructor.

Member Function Documentation

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

Function that creates a DtWindCorridorEncoder.

static void DtWindCorridorEncoder::encodeHeight ( const DtWindCorridorStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Height from rep into attrs.

static void DtWindCorridorEncoder::encodePath ( const DtWindCorridorStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Path from rep into attrs.

static void DtWindCorridorEncoder::encodePriority ( const DtWindCorridorStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Priority from rep into attrs.

static void DtWindCorridorEncoder::encodeVrfWeatherAreaIdentifier ( const DtWindCorridorStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes VrfWeatherAreaIdentifier from rep into attrs.

static void DtWindCorridorEncoder::encodeWidth ( const DtWindCorridorStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Width from rep into attrs.

static void DtWindCorridorEncoder::encodeWindSpeed ( const DtWindCorridorStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes WindSpeed from rep into attrs.

static bool DtWindCorridorEncoder::needHeight ( const DtWindCorridorStateRepository stateRep,
const DtWindCorridorStateRepository asSeenByRemote 
)
staticprotected

Return true if Height needs to be sent to the network, false otherwise.

static bool DtWindCorridorEncoder::needPath ( const DtWindCorridorStateRepository stateRep,
const DtWindCorridorStateRepository asSeenByRemote 
)
staticprotected

Return true if Path needs to be sent to the network, false otherwise.

static bool DtWindCorridorEncoder::needPriority ( const DtWindCorridorStateRepository stateRep,
const DtWindCorridorStateRepository asSeenByRemote 
)
staticprotected

Return true if Priority needs to be sent to the network, false otherwise.

static bool DtWindCorridorEncoder::needVrfWeatherAreaIdentifier ( const DtWindCorridorStateRepository stateRep,
const DtWindCorridorStateRepository asSeenByRemote 
)
staticprotected

Return true if VrfWeatherAreaIdentifier needs to be sent to the network, false otherwise.

static bool DtWindCorridorEncoder::needWidth ( const DtWindCorridorStateRepository stateRep,
const DtWindCorridorStateRepository asSeenByRemote 
)
staticprotected

Return true if Width needs to be sent to the network, false otherwise.

static bool DtWindCorridorEncoder::needWindSpeed ( const DtWindCorridorStateRepository stateRep,
const DtWindCorridorStateRepository asSeenByRemote 
)
staticprotected

Return true if WindSpeed needs to be sent to the network, false otherwise.

DtWindCorridorEncoder& DtWindCorridorEncoder::operator= ( const DtWindCorridorEncoder orig)

Assignment operator.


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

Document ID: Generated on Thu Oct 16 00:12:25 EDT 2025 from SVN revision 280738
Copyright © 1992-2025 MAK Technologies. All Rights Reserved (www.mak.com)