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

Instances of DtTimeAndDateEncoder encode data from DtTimeAndDateStateRepository objects to the net structures to be sent to the network. More...

+ Inheritance diagram for DtTimeAndDateEncoder:
+ Collaboration diagram for DtTimeAndDateEncoder:

Public Member Functions

 DtTimeAndDateEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Default constructor. More...
 
virtual ~DtTimeAndDateEncoder ()
 Destructor. More...
 
 DtTimeAndDateEncoder (const DtTimeAndDateEncoder &orig)
 Copy constructor. More...
 
DtTimeAndDateEncoderoperator= (const DtTimeAndDateEncoder &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 DtTimeAndDateEncoder. 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 needDateAndTimeOfDay (const DtTimeAndDateStateRepository &stateRep, const DtTimeAndDateStateRepository &asSeenByRemote)
 Return true if DateAndTimeOfDay needs to be sent to the network, false otherwise. More...
 
static void encodeDateAndTimeOfDay (const DtTimeAndDateStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes DateAndTimeOfDay from rep into attrs. More...
 
static bool needTimeOfDayAdvancementSpeed (const DtTimeAndDateStateRepository &stateRep, const DtTimeAndDateStateRepository &asSeenByRemote)
 Return true if TimeOfDayAdvancementSpeed needs to be sent to the network, false otherwise. More...
 
static void encodeTimeOfDayAdvancementSpeed (const DtTimeAndDateStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes TimeOfDayAdvancementSpeed from rep into attrs. More...
 
static bool needSunPositionLockedToObserver (const DtTimeAndDateStateRepository &stateRep, const DtTimeAndDateStateRepository &asSeenByRemote)
 Return true if SunPositionLockedToObserver needs to be sent to the network, false otherwise. More...
 
static void encodeSunPositionLockedToObserver (const DtTimeAndDateStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes SunPositionLockedToObserver 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 DtTimeAndDateEncoder encode data from DtTimeAndDateStateRepository objects to the net structures to be sent to the network.

Constructor & Destructor Documentation

DtTimeAndDateEncoder::DtTimeAndDateEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

Default constructor.

virtual DtTimeAndDateEncoder::~DtTimeAndDateEncoder ( )
virtual

Destructor.

DtTimeAndDateEncoder::DtTimeAndDateEncoder ( const DtTimeAndDateEncoder orig)

Copy constructor.

Member Function Documentation

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

Function that creates a DtTimeAndDateEncoder.

static void DtTimeAndDateEncoder::encodeDateAndTimeOfDay ( const DtTimeAndDateStateRepository rep,
RTI::AttributeHandleValuePairSet attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes DateAndTimeOfDay from rep into attrs.

static void DtTimeAndDateEncoder::encodeSunPositionLockedToObserver ( const DtTimeAndDateStateRepository rep,
RTI::AttributeHandleValuePairSet attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes SunPositionLockedToObserver from rep into attrs.

static void DtTimeAndDateEncoder::encodeTimeOfDayAdvancementSpeed ( const DtTimeAndDateStateRepository rep,
RTI::AttributeHandleValuePairSet attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes TimeOfDayAdvancementSpeed from rep into attrs.

static bool DtTimeAndDateEncoder::needDateAndTimeOfDay ( const DtTimeAndDateStateRepository stateRep,
const DtTimeAndDateStateRepository asSeenByRemote 
)
staticprotected

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

static bool DtTimeAndDateEncoder::needSunPositionLockedToObserver ( const DtTimeAndDateStateRepository stateRep,
const DtTimeAndDateStateRepository asSeenByRemote 
)
staticprotected

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

static bool DtTimeAndDateEncoder::needTimeOfDayAdvancementSpeed ( const DtTimeAndDateStateRepository stateRep,
const DtTimeAndDateStateRepository asSeenByRemote 
)
staticprotected

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

DtTimeAndDateEncoder& DtTimeAndDateEncoder::operator= ( const DtTimeAndDateEncoder 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)