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
DtPropulsionNoiseEncoder Class Reference
The VR-Link Simulation Library (vlProt)

class DtPropulsionNoiseEncoder More...

+ Inheritance diagram for DtPropulsionNoiseEncoder:
+ Collaboration diagram for DtPropulsionNoiseEncoder:

Public Member Functions

 DtPropulsionNoiseEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Default constructor. More...
 
virtual ~DtPropulsionNoiseEncoder ()
 Destructor. More...
 
 DtPropulsionNoiseEncoder (const DtPropulsionNoiseEncoder &orig)
 Copy constructor. More...
 
DtPropulsionNoiseEncoder & operator= (const DtPropulsionNoiseEncoder &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...
 
DtUnderwaterAcousticsEmissionEncoder & operator= (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...
 
DtBaseEmbeddedSystemEncoder & operator= (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...
 
DtHlaStateEncoder & operator= (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 DtHlaStateEncoder * clone (DtObjClassDesc *classDesc) const
 Returns a new-ed clone of this object which corresponds to the class description classDesc. More...
 
virtual DtHlaStateEncoder * clone () const
 Returns a new-ed clone of this object. More...
 
virtual void preCalculateEligible (const RTI::AttributeHandleSet &neededAttrs)
 

Static Public Member Functions

static DtHlaStateEncoder * create (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Function that creates a DtPropulsionNoiseEncoder. More...
 
- Static Public Member Functions inherited from DtUnderwaterAcousticsEmissionEncoder
static DtHlaStateEncoder * create (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Function that creates a DtUnderwaterAcousticsEmissionEncoder. More...
 
- Static Public Member Functions inherited from DtBaseEmbeddedSystemEncoder
static DtHlaStateEncoder * create (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 needHullMaskerOn (const DtPropulsionNoiseStateRepository &stateRep, const DtPropulsionNoiseStateRepository &asSeenByRemote)
 Return true if HullMaskerOn needs to be sent to the network, false otherwise. More...
 
static bool needPassiveParameterIndex (const DtPropulsionNoiseStateRepository &stateRep, const DtPropulsionNoiseStateRepository &asSeenByRemote)
 Return true if PassiveParameterIndex needs to be sent to the network, false otherwise. More...
 
static bool needPropulsionPlantConfiguration (const DtPropulsionNoiseStateRepository &stateRep, const DtPropulsionNoiseStateRepository &asSeenByRemote)
 Return true if PropulsionPlantConfiguration needs to be sent to the network, false otherwise. More...
 
static bool needShaftRateData (const DtPropulsionNoiseStateRepository &stateRep, const DtPropulsionNoiseStateRepository &asSeenByRemote)
 Return true if ShaftRateData needs to be sent to the network, false otherwise. More...
 
static void encodeHullMaskerOn (const DtPropulsionNoiseStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes HullMaskerOn from rep into attrs. More...
 
static void encodePassiveParameterIndex (const DtPropulsionNoiseStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes PassiveParameterIndex from rep into attrs. More...
 
static void encodePropulsionPlantConfiguration (const DtPropulsionNoiseStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes PropulsionPlantConfiguration from rep into attrs. More...
 
static void encodeShaftRateData16 (const DtPropulsionNoiseStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 Encodes ShaftRateData from rep into attrs. More...
 
static void encodeShaftRateData32 (const DtPropulsionNoiseStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
 
- 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
DtExerciseConn * myExConn
 
DtObjClassDesc * myClassDesc
 
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< DtAttributeChecker > myCheckerCache
 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 DtPropulsionNoiseEncoder

Instances of DtPropulsionNoiseEncoder encode data from DtPropulsionNoiseStateRepository objects to the net structures to be sent to the network.

Constructor & Destructor Documentation

DtPropulsionNoiseEncoder::DtPropulsionNoiseEncoder ( DtExerciseConn *  exConn,
DtObjClassDesc *  classDesc 
)

Default constructor.

virtual DtPropulsionNoiseEncoder::~DtPropulsionNoiseEncoder ( )
virtual

Destructor.

DtPropulsionNoiseEncoder::DtPropulsionNoiseEncoder ( const DtPropulsionNoiseEncoder &  orig)

Copy constructor.

Member Function Documentation

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

Function that creates a DtPropulsionNoiseEncoder.

static void DtPropulsionNoiseEncoder::encodeHullMaskerOn ( const DtPropulsionNoiseStateRepository &  rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes HullMaskerOn from rep into attrs.

static void DtPropulsionNoiseEncoder::encodePassiveParameterIndex ( const DtPropulsionNoiseStateRepository &  rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes PassiveParameterIndex from rep into attrs.

static void DtPropulsionNoiseEncoder::encodePropulsionPlantConfiguration ( const DtPropulsionNoiseStateRepository &  rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes PropulsionPlantConfiguration from rep into attrs.

static void DtPropulsionNoiseEncoder::encodeShaftRateData16 ( const DtPropulsionNoiseStateRepository &  rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected

Encodes ShaftRateData from rep into attrs.

static void DtPropulsionNoiseEncoder::encodeShaftRateData32 ( const DtPropulsionNoiseStateRepository &  rep,
RTI::AttributeHandleValuePairSet *  attrs,
RTI::AttributeHandle  attrHandle 
)
staticprotected
static bool DtPropulsionNoiseEncoder::needHullMaskerOn ( const DtPropulsionNoiseStateRepository &  stateRep,
const DtPropulsionNoiseStateRepository &  asSeenByRemote 
)
staticprotected

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

static bool DtPropulsionNoiseEncoder::needPassiveParameterIndex ( const DtPropulsionNoiseStateRepository &  stateRep,
const DtPropulsionNoiseStateRepository &  asSeenByRemote 
)
staticprotected

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

static bool DtPropulsionNoiseEncoder::needPropulsionPlantConfiguration ( const DtPropulsionNoiseStateRepository &  stateRep,
const DtPropulsionNoiseStateRepository &  asSeenByRemote 
)
staticprotected

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

static bool DtPropulsionNoiseEncoder::needShaftRateData ( const DtPropulsionNoiseStateRepository &  stateRep,
const DtPropulsionNoiseStateRepository &  asSeenByRemote 
)
staticprotected

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

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

Assignment operator.

The documentation for this class was generated from the following file:
Document ID: Generated on Mon Apr 25 03:39:01 EDT 2022 from SVN revision 242502
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)