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

Instances of DtCulturalFeatureDecoder are used to decode a military platform entity state message into a state repository in an HLA (as opposed to DIS) environment. More...

+ Inheritance diagram for DtCulturalFeatureDecoder:
+ Collaboration diagram for DtCulturalFeatureDecoder:

Public Member Functions

 DtCulturalFeatureDecoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 constructor More...
 
virtual ~DtCulturalFeatureDecoder ()
 destructor More...
 
 DtCulturalFeatureDecoder (const DtCulturalFeatureDecoder &orig)
 copy constructor More...
 
DtCulturalFeatureDecoderoperator= (const DtCulturalFeatureDecoder &orig)
 assignment operator More...
 
- Public Member Functions inherited from DtPhysicalEntityDecoder
 DtPhysicalEntityDecoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 constructor More...
 
virtual ~DtPhysicalEntityDecoder ()
 destructor More...
 
 DtPhysicalEntityDecoder (const DtPhysicalEntityDecoder &orig)
 copy constructor More...
 
DtPhysicalEntityDecoderoperator= (const DtPhysicalEntityDecoder &orig)
 assignment operator More...
 
- Public Member Functions inherited from DtBaseEntityDecoder
 DtBaseEntityDecoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 constructor More...
 
virtual ~DtBaseEntityDecoder ()
 destructor More...
 
 DtBaseEntityDecoder (const DtBaseEntityDecoder &orig)
 copy constructor More...
 
DtBaseEntityDecoderoperator= (const DtBaseEntityDecoder &orig)
 assignment operator More...
 
virtual DtHlaStateDecoderclone () const
 Virtual function override. Return a new instance of this class. More...
 
virtual DtHlaStateDecoderclone (DtObjClassDesc *classDesc) const
 Returns a new-ed clone of this object which corresponds to the class description classDesc. More...
 
- Public Member Functions inherited from DtHlaStateDecoder
 DtHlaStateDecoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 constructor More...
 
virtual ~DtHlaStateDecoder ()
 destructor More...
 
 DtHlaStateDecoder (const DtHlaStateDecoder &orig)
 copy constructor More...
 
DtHlaStateDecoderoperator= (const DtHlaStateDecoder &orig)
 assignment operator More...
 
DtAttributeDecoder addDecoder (RTI::AttributeHandle h, DtAttributeDecoder func)
 Add/Remove a decoding function for the attribute specified by handle. More...
 
DtAttributeDecoder removeDecoder (RTI::AttributeHandle h)
 
DtAttributeDecoder addDecoder (char *attrName, DtAttributeDecoder func, bool complain=true)
 Add/Remove a decoding function for the attribute specified by name. More...
 
DtAttributeDecoder removeDecoder (char *attrName, bool complain=true)
 
virtual DtAttributeDecoder decoder (const RTI::AttributeHandle &handle) const
 Get the attribute decoder for the specified handle. More...
 
virtual RTI::ObjectClassHandle objectClassHandle () const
 Get the object's class handle. More...
 

Static Public Member Functions

static DtHlaStateDecodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Create a DtCulturalFeatureDecoder. More...
 
- Static Public Member Functions inherited from DtPhysicalEntityDecoder
static DtHlaStateDecodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Create a DtPhysicalEntityDecoder. More...
 
- Static Public Member Functions inherited from DtBaseEntityDecoder
static DtHlaStateDecodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Create a DtBaseEntityDecoder. Caller is responsible for deletion. More...
 
- Static Public Member Functions inherited from DtHlaStateDecoder
static char * decodingBuffer (int length)
 Returns a pointer to a buffer that can be used to copy data obtained from a phvps. More...
 
static char * attributeData (const RTI::AttributeHandleValuePairSet &attrs, int index, RTI::ULong &length)
 Returns a pointer to the attribute data. More...
 
static char * attributeData (const RTI::AttributeHandleValuePairSet &attrs, int index, RTI::ULong &length, unsigned int expectedDataSize, char *attrName)
 Gets the attribute data and checks the expected size. More...
 
static DtNetEventIdeventIdAttributeData (const RTI::AttributeHandleValuePairSet &attrs, int index)
 Get the attribute data as a DtNetEventId (adds defensive null terminator) Returns a pointer to the attribute data. More...
 
static std::wstring wideStringFromHlaUnicodeString (char *buffer, int size, bool *error=nullptr)
 Gets data from an incoming buffer as a HlaUnicodeString and decodes it as a wide string. More...
 
static bool getVectorFromArrayOfUuid (char *buffer, int size, std::vector< DtVrlUuid > &uuids)
 Gets data from an incoming buffer as an ArrayOfUuid and decodes it as a vector of type DtVrlUuid. More...
 

Protected Member Functions

void addMyDecoders ()
 Add decoding functions for the attributes. More...
 
 DtDECLARE_ENTITY_ATTR_DECODER (ExternalLightsOn)
 Static decode<AttributeName> member functions. More...
 
 DtDECLARE_ENTITY_ATTR_DECODER (InternalHeatSourceOn)
 
 DtDECLARE_ENTITY_ATTR_DECODER (InternalLightsOn)
 
- Protected Member Functions inherited from DtPhysicalEntityDecoder
void addMyDecoders (DtObjClassDesc *classDesc)
 Add decoding functions for the attributes. More...
 
virtual void decode (const DtStateMsg &msg, DtStateRepository *rep) const
 Virtual function override that sets some timestamping info, then calls down to the base class to perform decoding of attributes. More...
 
 DtDECLARE_ENTITY_ATTR_DECODER (DamageState)
 Static decode<AttributeName> member functions. More...
 
 DtDECLARE_ENTITY_ATTR_DECODER (EngineSmokeOn)
 
 DtDECLARE_ENTITY_ATTR_DECODER (FlamesPresent)
 
 DtDECLARE_ENTITY_ATTR_DECODER (HasFuelSupplyCap)
 
 DtDECLARE_ENTITY_ATTR_DECODER (HasRecoveryCap)
 
 DtDECLARE_ENTITY_ATTR_DECODER (HasRepairCap)
 
 DtDECLARE_ENTITY_ATTR_DECODER (Immobilized)
 
 DtDECLARE_ENTITY_ATTR_DECODER (Marking)
 
 DtDECLARE_ENTITY_ATTR_DECODER (PowerPlantOn)
 
 DtDECLARE_ENTITY_ATTR_DECODER (SmokePlumePresent)
 
 DtDECLARE_ENTITY_ATTR_DECODER (TentDeployed)
 
 DtDECLARE_ENTITY_ATTR_DECODER (ArticulatedParametersArrayPre09)
 For versions <= 0.8. More...
 
 DtDECLARE_ENTITY_ATTR_DECODER (TrailState)
 
 DtDECLARE_ENTITY_ATTR_DECODER (HatchState)
 
 DtDECLARE_ENTITY_ATTR_DECODER (LifeformState)
 
 DtDECLARE_ENTITY_ATTR_DECODER (LightsState)
 
 DtDECLARE_ENTITY_ATTR_DECODER (RampDeployed)
 
 DtDECLARE_ENTITY_ATTR_DECODER (ArticulatedParametersArray)
 For versions > 0.8. More...
 
 DtDECLARE_ENTITY_ATTR_DECODER (TrailingEffectsCode)
 
 DtDECLARE_ENTITY_ATTR_DECODER (AlternateEntityType)
 
 DtDECLARE_ENTITY_ATTR_DECODER (CamouflageType)
 
 DtDECLARE_ENTITY_ATTR_DECODER (FirePowerDisabled)
 
 DtDECLARE_ENTITY_ATTR_DECODER (ForceIdentifier)
 
 DtDECLARE_ENTITY_ATTR_DECODER (IsConcealed)
 
 DtDECLARE_ENTITY_ATTR_DECODER (HasAmmunitionSupplyCap)
 
 DtDECLARE_ENTITY_ATTR_DECODER (AcousticSignatureIndex)
 For Versions >= 2.0007. More...
 
 DtDECLARE_ENTITY_ATTR_DECODER (InfraredSignatureIndex)
 
 DtDECLARE_ENTITY_ATTR_DECODER (PropulsionSystemsData)
 
 DtDECLARE_ENTITY_ATTR_DECODER (RadarCrossSectionSignatureIndex)
 
 DtDECLARE_ENTITY_ATTR_DECODER (VectoringNozzleSystemData)
 
 DtDECLARE_ENTITY_ATTR_DECODER (LiveEntityMeasuredSpeed)
 
 DtDECLARE_ENTITY_ATTR_DECODER (DIGuyAction)
 For DI Guy only. More...
 
 DtDECLARE_ENTITY_ATTR_DECODER (DIGuyAppearance)
 
 DtDECLARE_ENTITY_ATTR_DECODER (DIGuyArc)
 
 DtDECLARE_ENTITY_ATTR_DECODER (DIGuyType)
 
 DtDECLARE_ENTITY_ATTR_DECODER (DIGuyParent)
 
 DtDECLARE_ENTITY_ATTR_DECODER (Status)
 For Netn Only. More...
 
 DtDECLARE_ENTITY_ATTR_DECODER (UniqueId)
 
 DtDECLARE_ENTITY_ATTR_DECODER (SourceUnit)
 
 DtDECLARE_ENTITY_ATTR_DECODER (Callsign)
 
 DtDECLARE_ENTITY_ATTR_DECODER (Activity)
 
 DtDECLARE_ENTITY_ATTR_DECODER (EmbeddedUnitList)
 
 DtDECLARE_ENTITY_ATTR_DECODER (SymbolId)
 
 DtDECLARE_ENTITY_ATTR_DECODER (Destination)
 
 DtDECLARE_ENTITY_ATTR_DECODER (Route)
 
- Protected Member Functions inherited from DtBaseEntityDecoder
void addMyDecoders ()
 Add decoding functions for the attributes. More...
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (Spatial)
 Static decode<AttributeName> member functions. More...
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (RelativeSpatial)
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (IsPartOf)
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (IsPartOf_RPR_20014)
 For RPR FOM Version > 2.0014. More...
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (AccelerationVector)
 For RPR FOM versions <= 1.0. More...
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (AngularVelocityVector)
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (EntityType)
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (IsFrozen)
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (Orientation)
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (VelocityVector)
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (DRAlgorithm)
 For RPR FOM versions <= 0.8. More...
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (Position)
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (EntityID)
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (DeadReckoningAlgorithm)
 For RPR FOM versions > 0.8. More...
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (WorldLocation)
 
 DtDECLARE_BASE_ENTITY_ATTR_DECODER (EntityIdentifier)
 
- Protected Member Functions inherited from DtHlaStateDecoder
virtual void decodeAttribute (DtStateRepository *stateRep, const RTI::AttributeHandleValuePairSet &attrs, unsigned long pairSetIndex) const
 Decode the attribute at the specified index in the attribute handle pair set. More...
 
virtual void copyDecFuncs (const DtHlaStateDecoder &orig)
 

Additional Inherited Members

- Public Types inherited from DtHlaStateDecoder
typedef void(* DtAttributeDecoder )(DtStateRepository *stateRep, const RTI::AttributeHandleValuePairSet &avlist, unsigned long pairSetIndex)
 Attribute decoding function declaration. More...
 
- Static Public Attributes inherited from DtHlaStateDecoder
static bool theUseGetValuePointer
 
- Protected Types inherited from DtHlaStateDecoder
typedef std::map
< RTI::AttributeHandle,
DtAttributeDecoder
AttributeHandleDecoderMap
 
typedef std::map
< RTI::AttributeHandle, bool
AttributeHandleBoolMap
 
- Static Protected Member Functions inherited from DtPhysicalEntityDecoder
static void decodeAttParts (int numParams, DtNetAttachedPart *netParams, DtAttachedPartCollection *attList)
 Called by the decoder for the ArticulatedParametersArray attribute. More...
 
static void convertFromRPR1_0 (DtNetArtParamRecord *netParams, DtNetArtParamRecordRPR1 *netParamsRPR1, int numRecords)
 helper function More...
 
- Protected Attributes inherited from DtHlaStateDecoder
DtExerciseConnmyExConn
 
DtObjClassDescmyClassDesc
 
RTI::ObjectClassHandle myHandle
 
AttributeHandleDecoderMap myDecoderList
 myDecoderList is a map of decoders for each attribute registered to this state. More...
 

Detailed Description

Instances of DtCulturalFeatureDecoder are used to decode a military platform entity state message into a state repository in an HLA (as opposed to DIS) environment.

Constructor & Destructor Documentation

DtCulturalFeatureDecoder::DtCulturalFeatureDecoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

constructor

virtual DtCulturalFeatureDecoder::~DtCulturalFeatureDecoder ( )
virtual

destructor

DtCulturalFeatureDecoder::DtCulturalFeatureDecoder ( const DtCulturalFeatureDecoder orig)

copy constructor

Member Function Documentation

void DtCulturalFeatureDecoder::addMyDecoders ( )
protected

Add decoding functions for the attributes.

Note: Non-virtual since meant to be called from constructors to add decoders.

static DtHlaStateDecoder* DtCulturalFeatureDecoder::create ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)
static

Create a DtCulturalFeatureDecoder.

User is responsible for deletion.

DtCulturalFeatureDecoder::DtDECLARE_ENTITY_ATTR_DECODER ( ExternalLightsOn  )
protected

Static decode<AttributeName> member functions.

DtCulturalFeatureDecoder::DtDECLARE_ENTITY_ATTR_DECODER ( InternalHeatSourceOn  )
protected
DtCulturalFeatureDecoder::DtDECLARE_ENTITY_ATTR_DECODER ( InternalLightsOn  )
protected
DtCulturalFeatureDecoder& DtCulturalFeatureDecoder::operator= ( const DtCulturalFeatureDecoder 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)