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
DtAdditionalPassiveActivitiesEncoder Class Reference

class DtAdditionalPassiveActivitiesEncoder More...

+ Inheritance diagram for DtAdditionalPassiveActivitiesEncoder:
+ Collaboration diagram for DtAdditionalPassiveActivitiesEncoder:

Public Member Functions

 DtAdditionalPassiveActivitiesEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Default constructor. More...
 
virtual ~DtAdditionalPassiveActivitiesEncoder ()
 Destructor. More...
 
 DtAdditionalPassiveActivitiesEncoder (const DtAdditionalPassiveActivitiesEncoder &orig)
 Copy constructor. More...
 
DtAdditionalPassiveActivitiesEncoderoperator= (const DtAdditionalPassiveActivitiesEncoder &orig)
 Assignment operator. More...
 
- Public Member Functions inherited from DtUnderwaterAcousticsEmissionEncoder
 DtUnderwaterAcousticsEmissionEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Default constructor. More...
 
virtual ~DtUnderwaterAcousticsEmissionEncoder ()
 Destructor. More...
 
 DtUnderwaterAcousticsEmissionEncoder (const DtUnderwaterAcousticsEmissionEncoder &orig)
 Copy constructor. More...
 
DtUnderwaterAcousticsEmissionEncoderoperator= (const DtUnderwaterAcousticsEmissionEncoder &orig)
 Assignment operator. More...
 
- Public Member Functions inherited from DtBaseEmbeddedSystemEncoder
 DtBaseEmbeddedSystemEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 default constructor More...
 
virtual ~DtBaseEmbeddedSystemEncoder ()
 destructor More...
 
 DtBaseEmbeddedSystemEncoder (const DtBaseEmbeddedSystemEncoder &orig)
 copy constructor More...
 
DtBaseEmbeddedSystemEncoderoperator= (const DtBaseEmbeddedSystemEncoder &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 DtAdditionalPassiveActivitiesEncoder. More...
 
- Static Public Member Functions inherited from DtUnderwaterAcousticsEmissionEncoder
static DtHlaStateEncodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Function that creates a DtUnderwaterAcousticsEmissionEncoder. More...
 
- Static Public Member Functions inherited from DtBaseEmbeddedSystemEncoder
static DtHlaStateEncodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Create a DtBaseEntityEncoder. Caller is responsible for deletion. 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 Protected Member Functions

static bool needActivityCode (const DtAdditionalPassiveActivitiesRepository &stateRep, const DtAdditionalPassiveActivitiesRepository &asSeenByRemote)
 Return true if ActivityCode needs to be sent to the network, false otherwise. More...
 
static bool needActivityParameter (const DtAdditionalPassiveActivitiesRepository &stateRep, const DtAdditionalPassiveActivitiesRepository &asSeenByRemote)
 Return true if ActivityParameter needs to be sent to the network, false otherwise. More...
 
static bool needIsSilent (const DtAdditionalPassiveActivitiesRepository &stateRep, const DtAdditionalPassiveActivitiesRepository &asSeenByRemote)
 Return true if IsSilent needs to be sent to the network, false otherwise. More...
 
static void encodeActivityCode (const DtAdditionalPassiveActivitiesRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes ActivityCode from rep into attrs. More...
 
static void encodeActivityParameter (const DtAdditionalPassiveActivitiesRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes ActivityParameter from rep into attrs. More...
 
static void encodeIsSilent (const DtAdditionalPassiveActivitiesRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes IsSilent from rep into attrs. More...
 
- Static Protected Member Functions inherited from DtUnderwaterAcousticsEmissionEncoder
static bool needEventIdentifier (const DtUnderwaterAcousticsEmissionRepository &stateRep, const DtUnderwaterAcousticsEmissionRepository &asSeenByRemote)
 Return true if EventIdentifier needs to be sent to the network, false otherwise. More...
 
static void encodeEventIdentifier (const DtUnderwaterAcousticsEmissionRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes EventIdentifier 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 Member Functions inherited from DtBaseEmbeddedSystemEncoder
 DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (RelativePosition)
 
 DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (EntityID)
 for version <= 0.8 More...
 
 DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (HostObjectID)
 
 DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (EntityIdentifier)
 for version > 0.8 More...
 
 DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (HostObjectIdentifier)
 
 DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (RelativePosition)
 
 DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (EntityID)
 for version <= 0.8 More...
 
 DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (HostObjectID)
 
 DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (EntityIdentifier)
 for version > 0.8 More...
 
 DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (HostObjectIdentifier)
 
- 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 varaible 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

class DtAdditionalPassiveActivitiesEncoder

Instances of DtAdditionalPassiveActivitiesEncoder encode data from DtAdditionalPassiveActivitiesStateRepository objects to the net structures to be sent to the network.

Constructor & Destructor Documentation

DtAdditionalPassiveActivitiesEncoder::DtAdditionalPassiveActivitiesEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

Default constructor.

virtual DtAdditionalPassiveActivitiesEncoder::~DtAdditionalPassiveActivitiesEncoder ( )
virtual

Destructor.

DtAdditionalPassiveActivitiesEncoder::DtAdditionalPassiveActivitiesEncoder ( const DtAdditionalPassiveActivitiesEncoder orig)

Copy constructor.

Member Function Documentation

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

Function that creates a DtAdditionalPassiveActivitiesEncoder.

static void DtAdditionalPassiveActivitiesEncoder::encodeActivityCode ( const DtAdditionalPassiveActivitiesRepository rep,
RTI::AttributeHandleValuePairSet attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes ActivityCode from rep into attrs.

static void DtAdditionalPassiveActivitiesEncoder::encodeActivityParameter ( const DtAdditionalPassiveActivitiesRepository rep,
RTI::AttributeHandleValuePairSet attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes ActivityParameter from rep into attrs.

static void DtAdditionalPassiveActivitiesEncoder::encodeIsSilent ( const DtAdditionalPassiveActivitiesRepository rep,
RTI::AttributeHandleValuePairSet attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes IsSilent from rep into attrs.

static bool DtAdditionalPassiveActivitiesEncoder::needActivityCode ( const DtAdditionalPassiveActivitiesRepository stateRep,
const DtAdditionalPassiveActivitiesRepository asSeenByRemote 
)
staticprotected

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

static bool DtAdditionalPassiveActivitiesEncoder::needActivityParameter ( const DtAdditionalPassiveActivitiesRepository stateRep,
const DtAdditionalPassiveActivitiesRepository asSeenByRemote 
)
staticprotected

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

static bool DtAdditionalPassiveActivitiesEncoder::needIsSilent ( const DtAdditionalPassiveActivitiesRepository stateRep,
const DtAdditionalPassiveActivitiesRepository asSeenByRemote 
)
staticprotected

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

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

Assignment operator.


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

Document ID: Generated on Tue Aug 10 00:12:31 EDT 2021 from SVN revision 232765
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)