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

Instances of DtWeatherEncoder encode data from DtWeatherStateRepository objects to the net structures to be sent to the network. More...

+ Inheritance diagram for DtWeatherEncoder:
+ Collaboration diagram for DtWeatherEncoder:

Public Member Functions

 DtWeatherEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Default constructor. More...
 
virtual ~DtWeatherEncoder ()
 Destructor. More...
 
 DtWeatherEncoder (const DtWeatherEncoder &orig)
 Copy constructor. More...
 
DtWeatherEncoderoperator= (const DtWeatherEncoder &orig)
 Assignment operator. More...
 
- Public Member Functions inherited from DtEnvironmentConditionEncoder
 DtEnvironmentConditionEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Default constructor. More...
 
virtual ~DtEnvironmentConditionEncoder ()
 Destructor. More...
 
 DtEnvironmentConditionEncoder (const DtEnvironmentConditionEncoder &orig)
 Copy constructor. More...
 
DtEnvironmentConditionEncoderoperator= (const DtEnvironmentConditionEncoder &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 DtWeatherEncoder. More...
 
- Static Public Member Functions inherited from DtEnvironmentConditionEncoder
static DtHlaStateEncodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Function that creates a DtEnvironmentConditionEncoder. 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 needTemperature (const DtWeatherStateRepository &stateRep, const DtWeatherStateRepository &asSeenByRemote)
 Return true if Temperature needs to be sent to the network, false otherwise. More...
 
static void encodeTemperature (const DtWeatherStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Temperature from rep into attrs. More...
 
static bool needWind (const DtWeatherStateRepository &stateRep, const DtWeatherStateRepository &asSeenByRemote)
 Return true if Wind needs to be sent to the network, false otherwise. More...
 
static void encodeWind (const DtWeatherStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Wind from rep into attrs. More...
 
static bool needPrecipitation (const DtWeatherStateRepository &stateRep, const DtWeatherStateRepository &asSeenByRemote)
 Return true if Precipitation needs to be sent to the network, false otherwise. More...
 
static void encodePrecipitation (const DtWeatherStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Precipitation from rep into attrs. More...
 
static bool needHaze (const DtWeatherStateRepository &stateRep, const DtWeatherStateRepository &asSeenByRemote)
 Return true if Haze needs to be sent to the network, false otherwise. More...
 
static void encodeHaze (const DtWeatherStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Haze from rep into attrs. More...
 
static bool needHumidity (const DtWeatherStateRepository &stateRep, const DtWeatherStateRepository &asSeenByRemote)
 Return true if Humidity needs to be sent to the network, false otherwise. More...
 
static void encodeHumidity (const DtWeatherStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes Humidity from rep into attrs. More...
 
static bool needBarometricPressure (const DtWeatherStateRepository &stateRep, const DtWeatherStateRepository &asSeenByRemote)
 Return true if BarometricPressure needs to be sent to the network, false otherwise. More...
 
static void encodeBarometricPressure (const DtWeatherStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes BarometricPressure from rep into attrs. More...
 
static bool needVisibilityRange (const DtWeatherStateRepository &stateRep, const DtWeatherStateRepository &asSeenByRemote)
 Return true if VisibilityRange needs to be sent to the network, false otherwise. More...
 
static void encodeVisibilityRange (const DtWeatherStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes VisibilityRange from rep into attrs. More...
 
- Static Protected Member Functions inherited from DtEnvironmentConditionEncoder
static bool needServiceId (const DtEnvironmentConditionStateRepository &stateRep, const DtEnvironmentConditionStateRepository &asSeenByRemote)
 Return true if ServiceId needs to be sent to the network, false otherwise. More...
 
static void encodeServiceId (const DtEnvironmentConditionStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes ServiceId from rep into attrs. More...
 
static bool needGeoReference (const DtEnvironmentConditionStateRepository &stateRep, const DtEnvironmentConditionStateRepository &asSeenByRemote)
 Return true if GeoReference needs to be sent to the network, false otherwise. More...
 
static void encodeGeoReference (const DtEnvironmentConditionStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes GeoReference 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 DtWeatherEncoder encode data from DtWeatherStateRepository objects to the net structures to be sent to the network.

Constructor & Destructor Documentation

DtWeatherEncoder::DtWeatherEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

Default constructor.

virtual DtWeatherEncoder::~DtWeatherEncoder ( )
virtual

Destructor.

DtWeatherEncoder::DtWeatherEncoder ( const DtWeatherEncoder orig)

Copy constructor.

Member Function Documentation

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

Function that creates a DtWeatherEncoder.

static void DtWeatherEncoder::encodeBarometricPressure ( const DtWeatherStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes BarometricPressure from rep into attrs.

static void DtWeatherEncoder::encodeHaze ( const DtWeatherStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Haze from rep into attrs.

static void DtWeatherEncoder::encodeHumidity ( const DtWeatherStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Humidity from rep into attrs.

static void DtWeatherEncoder::encodePrecipitation ( const DtWeatherStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Precipitation from rep into attrs.

static void DtWeatherEncoder::encodeTemperature ( const DtWeatherStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Temperature from rep into attrs.

static void DtWeatherEncoder::encodeVisibilityRange ( const DtWeatherStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes VisibilityRange from rep into attrs.

static void DtWeatherEncoder::encodeWind ( const DtWeatherStateRepository rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes Wind from rep into attrs.

static bool DtWeatherEncoder::needBarometricPressure ( const DtWeatherStateRepository stateRep,
const DtWeatherStateRepository asSeenByRemote 
)
staticprotected

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

static bool DtWeatherEncoder::needHaze ( const DtWeatherStateRepository stateRep,
const DtWeatherStateRepository asSeenByRemote 
)
staticprotected

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

static bool DtWeatherEncoder::needHumidity ( const DtWeatherStateRepository stateRep,
const DtWeatherStateRepository asSeenByRemote 
)
staticprotected

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

static bool DtWeatherEncoder::needPrecipitation ( const DtWeatherStateRepository stateRep,
const DtWeatherStateRepository asSeenByRemote 
)
staticprotected

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

static bool DtWeatherEncoder::needTemperature ( const DtWeatherStateRepository stateRep,
const DtWeatherStateRepository asSeenByRemote 
)
staticprotected

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

static bool DtWeatherEncoder::needVisibilityRange ( const DtWeatherStateRepository stateRep,
const DtWeatherStateRepository asSeenByRemote 
)
staticprotected

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

static bool DtWeatherEncoder::needWind ( const DtWeatherStateRepository stateRep,
const DtWeatherStateRepository asSeenByRemote 
)
staticprotected

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

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

Assignment operator.


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

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)