vrforces5.2/classref/vrf_object_parameters_8h_source.html

 /*******************************************************************************

 ** Copyright (c) 2013 MAK Technologies, Inc.

 ** All rights reserved.

 *******************************************************************************/


 #pragma once


 #include <readerWriter/readerWriter.h>

 #include "vrfobjparam/vrfobjparamDefines.h"

 #include "vrfutil/rwEntityType.h"

 #include "vrfutil/rwEntityTypeList.h"

 #include <vrfutil/rwEntityType.h>

 #include <vrfutil/rwEntityTypeList.h>

 #include "vrfutil/rwBoundingVolume.h"

 #include "vrfobjparam/vrfObjectParameterFactory.h"

 #include "vrfutil/rwFormationType.h"

 #include "vrfutil/rwBoundingGeometryType.h"

 #include "vrfutil/rwForceType.h"

 #include "vrfutil/rwVisualMetaData.h"

 #include <readerWriter/rwReal.h>

 #include <readerWriter/rwBoolean.h>

 #include "vrfutil/rwAppearance.h"

 #include <readerWriter/rwString.h>

 #include "vrfutil/simClock.h"

 #include "vrfutil/rwDeadReckonTypes.h"

 #include "vrfutil/rwNavigationParameters.h"

 #include "vrfobjparam/rwDeadReckonThresholds.h"

 #include "vrfobjparam/componentDescriptorList.h"

 #include "vrfutil/vrfSubObjectParameterList.h"

 #include "vrfobjparam/connectionDescriptorList.h"

 #include "vrfutil/simResourceManager.h"

 #include "vrfutil/rwSensorSignatureList.h"

 #include "vrfobjparam/simSector.h"

 #include "vrfobjparam/radioDescriptorList.h"

 #include "vrfobjparam/componentSystemDescriptorList.h"

 #include <list>

 #include <readerWriter/readerWriterFile.h>

 #include "vrfobjparam/taskExecutionRules.h"

 #include "vrfutil/rwAutoConnection.h"

 #include <readerWriter/rwProperties.h>

 #include "vrfobjparam/simArtPartDescriptorList.h"

 #include "vrfutil/rwTerrainCategoryMask.h"


 class DtSimResource;

 class DtVrfObjectSubComponentTypes;

 class DtFilename;

 class DtVrfStateRepositoryUserExtension;

 class DtRadioDescriptorList;

 class DtSimArtPartDescriptor;

 class DtComponentDescriptor;


 class DT_DLL_vrfobjparam DtVrfObjectParameters : public DtReaderWriter

 {


 public:

    typedef DtRwTemplatedListPtr<DtRwAutoConnection,true> DtAutoConnectionsListPtr;


    DtVrfObjectParameters(const DtString& name = DtString::nullString(),

       DtReaderWriterRegistry* parentRegistry = NULL, DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);

    DtVrfObjectParameters(const DtSymbolString& name,

       DtReaderWriterRegistry* parentRegistry = NULL, DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);


    virtual ~DtVrfObjectParameters() override;


 protected:

    DtVrfObjectParameters(const DtVrfObjectParameters& orig,

       const DtString& name = DtString::nullString(),

       DtReaderWriterRegistry* parentRegistry = NULL);


    DtVrfObjectParameters(const DtVrfObjectParameters& orig,

       const DtSymbolString& name,

       DtReaderWriterRegistry* parentRegistry = NULL);


 public:

    DtVrfObjectParameters& operator=(const DtVrfObjectParameters& orig);


    virtual DtVrfObjectParameters* clone(

       const DtString& name = DtString::nullString(),

       DtReaderWriterRegistry* parentRegistry = NULL) const;


    virtual DtVrfObjectParameters* clone(

       const DtSymbolString& name,

       DtReaderWriterRegistry* parentRegistry = NULL) const;


    virtual bool init();


    virtual DtString type() const;


    virtual bool inheritValues(const DtVrfObjectParameters * benefactor);


    virtual void inheritValuesFromThisType(

       const DtVrfObjectParameters * benefactor);


    virtual bool createLocalSubComponentTypes();


    virtual bool createRemoteSubComponentTypes();


    virtual DtVrfObjectSubComponentTypes * localVrfSubComponentTypes() const;


    virtual DtVrfObjectSubComponentTypes * remoteVrfSubComponentTypes() const;


    virtual void setMinTickPeriod(DtReal minTickPeriod);


    virtual DtReal minTickPeriod() const;


     virtual void setMinTickPeriodVariance(DtReal minTickPeriodVariance);


    virtual DtReal minTickPeriodVariance() const;


    virtual DtForceType forceType() const;

    virtual void setForceType(const DtForceType force);


    virtual bool hasGuiKeyword(const DtString&) const;


    virtual const DtString& category() const;


    virtual void setCategory(const DtString& category);


    virtual bool categorySpecified() const;


    virtual const DtString& echelonLevel() const;


    virtual void setEchelonLevel(const DtString& echelonLevel);


    virtual bool echelonLevelSpecified() const;


    virtual const DtString& callsign() const;


    virtual void setCallsign(const DtString& callsign);


    virtual bool callsignSpecified() const;


    virtual bool organized() const;


    virtual void setOrganized(bool organized);


    virtual const DtString& mainComponent() const;

    virtual void setMainComponent(const DtString&);

    virtual bool mainComponentSpecified() const;


    virtual std::set<std::string> publicData() const;

    virtual void setPublicData(const std::set<std::string>& list);

    virtual bool publicDataSpecified() const;


    virtual const DtComponentSystemDescriptorList& systemDescriptorList() const;

    virtual DtComponentSystemDescriptorList& systemDescriptorList();

    virtual void setSystemDescriptorList(const DtComponentSystemDescriptorList& list);


    virtual const DtRwVisualMetaData& visualMetaData() const;

    virtual void setVisualMetaData(const DtRwVisualMetaData&

       list);


    virtual const DtComponentDescriptorList& sensorDescriptorList() const;

    virtual DtComponentDescriptorList& sensorDescriptorList();

    virtual void setSensorDescriptorList(const DtComponentDescriptorList& list);


    virtual const DtComponentDescriptorList& controllerDescriptorList() const;

    virtual DtComponentDescriptorList& controllerDescriptorList();

    virtual void setControllerDescriptorList(const DtComponentDescriptorList&

       list);


    virtual const DtComponentDescriptorList& actuatorDescriptorList() const;

    virtual DtComponentDescriptorList& actuatorDescriptorList();

    virtual void setActuatorDescriptorList(const DtComponentDescriptorList&

       list);


    virtual const DtConnectionDescriptorList& connectionDescriptorList() const;

    virtual DtConnectionDescriptorList& connectionDescriptorList();

    virtual void setConnectionDescriptorList(const DtConnectionDescriptorList&

       list);


    virtual DtDeadReckonTypes deadReckoningAlgorithm() const;

    virtual void setDeadReckoningAlgorithm(DtDeadReckonTypes

       deadReckoningAlgorithm);


    virtual const DtRwNavigationParameters& navigationParameters() const;

    virtual DtRwNavigationParameters& navigationParameters();

    virtual void setNavigationParameters(const DtRwNavigationParameters& parameters);


    virtual const DtRwBoolean deadReckoningAllowGuiOverrides() const;

    virtual void setDeadReckoningAllowGuiOverrides(bool allow);


    virtual const DtRwDeadReckonThresholds& deadReckoningThresholds() const;

    virtual void setDeadReckoningThresholds(const DtRwDeadReckonThresholds&

       deadReckoningThresholds);


    virtual DtReal mass() const;

    virtual void setMass(const DtReal mass);


    virtual const DtRadioDescriptorList& radioDescriptorList() const;

    virtual DtRadioDescriptorList& radioDescriptorList();


    virtual const DtRwSensorSignatureList& sensorSignatureList() const;

    virtual DtRwSensorSignatureList& sensorSignatureList();


    virtual const DtVrfSubObjectParameterList& subordinateObjects() const;

    virtual void setSubordinateObjects(

       const DtVrfSubObjectParameterList& subordinateObjects);


    virtual const DtVrfSubObjectParameterList& attachedObjects() const;

    virtual void setAttachedObjects(

       const DtVrfSubObjectParameterList& attachedObjects);


    virtual DtVrfObjectSubComponentTypes * localSubComponentTypes() const;


    virtual DtVrfObjectSubComponentTypes * remoteSubComponentTypes() const;


    virtual void putData(std::string& fp, int indentLevel = 0) override;


    virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,

       const DtVariableBindingsList& variableBindings) override;


    virtual const Dt3dBoundingVolume * boundingVolume() const;


    virtual void setBoundingVolume(const Dt3dBoundingVolume& newBoundingVolume);


    virtual void setBoundingVolume(const DtVector& localBvolDiagonal,

       const DtVector& offset = DtVector::zero());


    virtual DtSimBoundingGeometry::DtSimBoundingGeometryType

       boundingGeometryType() const;

    virtual void setBoundingGeometryType(

       DtSimBoundingGeometry::DtSimBoundingGeometryType type);


    virtual double draft() const;


    virtual DtAggregateFormation formation() const;

    virtual void setFormation(DtAggregateFormation formation);


    virtual DtU32 appearance() const;

    virtual void setAppearance(const DtU32 appearance);

    virtual bool appearanceSpecified() const;


    virtual const DtString& displayName() const;

    virtual void setDisplayName(const DtString& s);


    virtual const DtEntityType& defaultEntityType() const;

    virtual void setDefaultEntityType(const DtEntityType& s);


    virtual const DtString& displayDescription() const;

    virtual void setDisplayDescription(const DtString& s);


    virtual const DtString& engagementRules() const;

    virtual void setEngagementRules(const DtString& engagementRules);


    virtual const DtSimResourceManager& resourceManager() const;

    virtual void setResourceManager(const DtSimResourceManager& resourceManager);


    virtual void resolveResourceManager(const DtSimResourceManager&);


    virtual void setStateRepositoryUserExtensionType(const DtString& type);

    virtual const DtString& stateRepositoryUserExtensionType() const;


    virtual DtEntityType objectType() const;

    virtual void setObjectType(const DtEntityType& objectType);


    virtual DtEntityType matchType() const;

    virtual void setMatchType(const DtEntityType& objectType);


    virtual bool taskedBySuperiorUponTaskComplete() const;

    virtual void setTaskedBySuperiorUponTaskComplete(bool trueOrFalse);


    virtual void setRangeRingPublisherTickTime(double);

    virtual double rangeRingPublisherTickTime() const;


    static DtVrfObjectParameters * createParameters(DtlObjPtr mtlStream,

       const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& variableBindings,

       DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);

    static DtVrfObjectParameters * createParameters(const char* name,

       DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);


    static DtVrfObjectParameterFactory * factory();


    static void setFactory(DtVrfObjectParameterFactory * factory);


    static void addParameterCreatorFcn(const DtString & type,

       DtSimObjectParametersCreatorFcn fcn);


    static DtVrfObjectParameters * creator(DtEnvironmentSP env, DtEnvValueSP* objectNode);


    void setParameterType(const DtString&);

    const DtString& parameterType() const;


    virtual void setStateRepositoryUserExtension(

       const DtVrfStateRepositoryUserExtension& userExtension);

    virtual DtVrfStateRepositoryUserExtension* stateRepositoryUserExtension() const;


    virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths = DtReaderWriter::SearchPaths(),

       const DtVariableBindingsList& variableBindings = nullVariableReference()) override;


    virtual void postGetSelf() override;


    virtual void prePutSelf() override;


    virtual DtTime underFireTime() const;


    virtual void setUnderFireTime(DtTime time);


    virtual bool underFireTimeSpecified() const;


    virtual DtReal underFireDistance() const;


    virtual void setUnderFireDistance(DtReal underFireDistance);


    virtual bool underFireDistanceSpecified() const;


    virtual const DtSimSector& initialSectorOfResponsibility() const;

    virtual void setInitialSectorOfResponsibility(const DtSimSector& sor);


    virtual DtTaskExecutionRules& taskExecutionRules();

    virtual const DtTaskExecutionRules& taskExecutionRules() const;


    virtual void setTaskExecutionRulesFilename(const DtFilename&);

    virtual const DtReaderWriterFile& taskExecutionRulesFilename() const;


    virtual void setHlaFomClass(const DtString&);

    virtual const DtString& hlaFomClass() const;


    virtual void setArtPartList(const DtSimArtPartDescriptorList& partList);

    virtual const DtSimArtPartDescriptorList& artPartList() const;


    virtual const DtAutoConnectionsListPtr& autoConnections() const;

    virtual DtAutoConnectionsListPtr& autoConnections();


    virtual const std::list<DtSimArtPartDescriptor*>* configuredArtPartList() const;


    virtual const std::list<DtSimArtPartDescriptor*>* componentDefaultArtPartList() const;


    virtual void connectSystems();


    bool operator==(const DtVrfObjectParameters&) const;

    bool operator!=(const DtVrfObjectParameters&) const;


    virtual DtEnvironmentSP xmlEnvironment();

    virtual DtEnvValueSP objectNode();


    virtual const DtReaderWriter* findVariableBinding(const DtString&) const;


    virtual const DtVariableBindingsList& variableBindingsFromLoad() const;


    virtual DtReaderWriterRegistryData* findProperty(const DtString& rwName) const;


    virtual const DtRwProperties& parameterData() const;

    virtual DtRwProperties& parameterData();


    virtual const DtRwProperties& stateData() const;

    virtual DtRwProperties& stateData();


    virtual const DtRwProperties& internalStateData() const;

    virtual DtRwProperties& internalStateData();


    virtual void setPublishParameterData(bool);

    virtual bool publishParameterData() const;


    virtual void setDisplayObjectImage(int);

    virtual int displayObjectImage() const;


    virtual void setLosTerrainCategoryMask(DtTerrainCategoryMask mask);

    virtual DtTerrainCategoryMask losTerrainCategoryMask() const;


    virtual void setMovementTerraincategoryMask(DtTerrainCategoryMask mask);

    virtual DtTerrainCategoryMask movementTerrainCategoryMask() const;


    virtual void setUiFilename(const DtString& uiFilename);

    virtual DtString uiFilename() const;


    virtual void setCanCreateAsNew(bool);

    virtual bool canCreateAsNew() const;


    virtual void setCanMoveOntoEmbarked(bool);

    virtual bool canMoveOntoEmbarked(const DtEntityType& = DtEntityType()) const;


    virtual void setSameObjectTypeCanAutoEmbark(bool);

    virtual bool sameObjectTypeCanAutoEmbark() const;


    virtual const DtRwEntityTypes& canMoveOntoEmbarkedTypes() const;

    virtual void setCanMoveOntoEmbarkedTypes(const DtRwEntityTypes&);

 /*   virtual void addCanMoveOntoEmbarkedType(const DtEntityType&);

    virtual void removeCanMoveOntoEmbarkedType(const DtEntityType&);*/


    virtual bool dynamicFeatureEnabled() const;

    virtual void setDynamicFeatureEnabled(bool enabled);


    virtual double dynamicFeatureWidth() const;

    virtual void setDynamicFeatureWidth(double w);


    virtual bool spatiallySearchable() const;

    virtual void setSpatiallySearchable(bool searchable);


    virtual void rebuildArtPartList();


    virtual void updatePartOverridesFromActuator(DtSimArtPartDescriptor& artPartDescriptor,

       const DtComponentDescriptor& actuatorDescriptor,

       const DtString& systemName = DtString::nullString());


 protected:


    virtual DtVrfSubObjectParameterList* createSubordinateObjectsList(

       const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry) const;


    virtual DtVrfSubObjectParameterList* createAttachedObjectsList(

       const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry) const;


    virtual void addArtPartsFromSystem(DtComponentSystemDescriptor* systemDesc,

       std::list<DtSimArtPartDescriptor*>& artPartList);


    virtual void createAutomaticConnections(DtRwAutoConnection* autoConnection);


    typedef void (*ArtPartDescriptorProcessor)(const DtComponentDescriptor& compDesc,

       DtSimArtPartDescriptor& artPartDesc);


    virtual void addArtPartDescriptorProcessor(const DtString& componentType,

       const ArtPartDescriptorProcessor& fcn);


    static void artPartWeaponDescriptorProcessor(const DtComponentDescriptor& compDesc,

       DtSimArtPartDescriptor& artPartDesc);

    static void artPartHumanGunDescriptorProcessor(const DtComponentDescriptor& compDesc,

       DtSimArtPartDescriptor& artPartDesc);

    static void artPartBallisticGunDescriptorProcessor(const DtComponentDescriptor& compDesc,

       DtSimArtPartDescriptor& artPartDesc);

    static void artPartAzimuthMountDescriptorProcessor(const DtComponentDescriptor& compDesc,

       DtSimArtPartDescriptor& artPartDesc);

    static void artPartElevationMountDescriptorProcessor(const DtComponentDescriptor& compDesc,

       DtSimArtPartDescriptor& artPartDesc);

    static void artPartTurretDescriptorProcessor(const DtComponentDescriptor& compDesc,

       DtSimArtPartDescriptor& artPartDesc);

    static void artPartSensorGimbalDescriptorProcessor(const DtComponentDescriptor& compDesc,

       DtSimArtPartDescriptor& artPartDesc);

    static void artPartSwingingPartDescriptorProcessor(const DtComponentDescriptor& compDesc,

       DtSimArtPartDescriptor& artPartDesc);

    static void artPartTranslatablePartDescriptorProcessor(const DtComponentDescriptor& compDesc,

       DtSimArtPartDescriptor& artPartDesc);


    virtual void addStateDataFromComponents();

    virtual void addStateDataFromSystem(const DtComponentSystemDescriptor* systemDesc);

    virtual void addStateDataFromComponent(const DtComponentDescriptor* systemDesc);


 protected:


    DtEntityType myMatchType;

    DtEntityType myObjectType;


    DtRwBoundingGeometryType         myBoundingGeometryType;


    DtRwBoundingVolume               myBvol;


    DtVrfObjectSubComponentTypes *   myLocalSubComponentTypes;


    DtVrfObjectSubComponentTypes *   myRemoteSubComponentTypes;


    DtRwFormationType                myFormationType;


    DtRwAppearance myDefaultAppearance;


    DtRwForceType             myForceType;


    DtRwString                myCategory;


    DtRwString                myEchelonLevel;


    DtRwString                myCallsign;


    DtRwBoolean               myOrganized;


    DtRwReal                  myMinTickPeriod;


    DtRwReal                  myMinTickPeriodVariance;


    DtRwDeadReckonTypes       myDeadReckoningAlgorithm;


    DtRwNavigationParameters myNavigationParameters;


    DtRwDeadReckonThresholds  myDeadReckoningThresholds;


    DtRwBoolean myDeadReckoningAllowGuiOverrides;


    DtRadioDescriptorList   myRadioDescriptorList;


    DtComponentSystemDescriptorList mySystemDescriptorList;


    DtComponentDescriptorList mySensorDescriptorList;


    DtComponentDescriptorList myControllerDescriptorList;


    DtComponentDescriptorList myActuatorDescriptorList;


    DtConnectionDescriptorList myConnectionDescriptorList;


    DtRwReal                  myMass;


    DtRwSensorSignatureList   mySensorSignatureList;


    DtVrfSubObjectParameterList* mySubordinateObjects;


    DtVrfSubObjectParameterList* myAttachedObjects;


    DtRwString                myEngagementRules;


    DtSimResourceManager myResourceManager;


    DtRwString                myStateRepositoryUserExtensionType;


    DtRwBoolean               myTaskedBySuperiorUponTaskComplete;


    DtVrfStateRepositoryUserExtension* myStateRepositoryUserExtension;


    DtRwTime                  myUnderFireTime;


    DtRwReal                  myUnderFireDistance;


    DtSimSector myInitialSectorOfResponsibility;


    DtReaderWriterFile myTaskExecutionRulesFilename;


    DtTaskExecutionRules myTaskExecutionRules;


    DtString                   myParameterType;


    static DtVrfObjectParameterFactory * theFactory;


    std::list<DtSimArtPartDescriptor*> myConfiguredArtPartList;


    std::list<DtSimArtPartDescriptor*> myComponentDefaultArtPartList;


    DtEnvValueSP myObjectNode;

    DtEnvironmentSP myEnvironment;


    DtAutoConnectionsListPtr myAutoConnections;


    DtRwProperties myParameterData;


    DtRwProperties myStateData;


    DtRwProperties myInternalStateData;


    DtRwReal myRangeRingPublisherTickTime;


    DtRwBoolean       myPublishParameterData;


    DtRwBoolean myIlluminationRecalcTime;


    DtRwString myDisplayName;


    DtRwString myDisplayDescription;


    DtRwString myUiFilename;


    DtRwBoolean myCanCreateAsNew;


    DtRwBoolean myCanMoveOntoEmbarked;


    DtRwBoolean mySameObjectTypeCanAutoEmbark;


    DtRwEntityTypes myCanMoveOntoEmbarkedTypes;


    DtRwString myHlaFomClass;


    DtRwEntityType myDefaultEntityType;


    DtRwVisualMetaData myVisualMetaData;


    DtSimArtPartDescriptorList myArtPartList;


    DtRwString myMainComponent;


    DtRwNLengthStringVector   myPublicData;


    DtRwInt   myDisplayObjectImage;


    DtRwTerrainCategoryMask myLosTerrainCategoryMask;


    DtRwTerrainCategoryMask myMovementTerrainCategoryMask;


    DtRwBoolean myDynamicFeatureEnabled;


    DtRwReal myDynamicFeatureWidth;


    DtRwBoolean mySpatiallySearchable;


    DtVariableBindingsList myGetSelfVariableBindings;


    typedef std::map<DtString, ArtPartDescriptorProcessor> ArtPartDescProcMap;

    ArtPartDescProcMap myArtPartDescProcs;

 };


 inline void DtVrfObjectParameters::setParameterType(const DtString& t)

 {

    myParameterType = t;

 }


 inline const DtString& DtVrfObjectParameters::parameterType() const

 {

    return myParameterType;

 }

DtReaderWriter::operator==
bool operator==(const DtReaderWriter &) const
Equivalence operator.

DtVrfObjectParameters
Instances of DtVrfObjectParameters are the readable/writeable objects that contain the information ne...
Definition: vrfObjectParameters.h:64

DtVrfObjectParameters::myParameterData
DtRwProperties myParameterData
Properties that are specific to this parameter as read from the OPE file. These properties cannot be ...
Definition: vrfObjectParameters.h:1043

DtVrfObjectParameters::myDisplayObjectImage
DtRwInt myDisplayObjectImage
Parameter Name: display-object-image Parameter Description: In the object palette, show: 0 - No image 1 - Image file if it exists 2 - List icon Parameter Default Value: 1 (Image file) .
Definition: vrfObjectParameters.h:1162

DtVrfObjectParameters::myResourceManager
DtSimResourceManager myResourceManager
Parameter Name: resources Parameter Description: Specifies the types and amount of resources the enti...
Definition: vrfObjectParameters.h:962

DtVrfObjectParameters::myPublishParameterData
DtRwBoolean myPublishParameterData
Parameter Name: publish-parameter-data Parameter Description: Set to true to publish the parameter da...
Definition: vrfObjectParameters.h:1063

DtReaderWriter::prePutSelf
virtual void prePutSelf()
Called before either version of put self (file or environment). Default is no-op. ...

rwBoundingVolume.h

DtVrfObjectParameters::myUnderFireTime
DtRwTime myUnderFireTime
Parameter Name: under-fire-time Parameter Description: Deprecated. This concept is now modeled in the...
Definition: vrfObjectParameters.h:991

DtTime

connectionDescriptorList.h

DtVrfObjectParameters::mySubordinateObjects
DtVrfSubObjectParameterList * mySubordinateObjects
Parameter Name: subordinate-objects Parameter Description: (Optional) List of entries specifying subo...
Definition: vrfObjectParameters.h:930

DtVrfObjectParameters::myCanMoveOntoEmbarked
DtRwBoolean myCanMoveOntoEmbarked
Parameter Name: can-move-onto-embarked Parameter Description: Whether or not this object can be embar...
Definition: vrfObjectParameters.h:1104

DtVrfObjectParameters::myEchelonLevel
DtRwString myEchelonLevel
Parameter Name: echelon-level Parameter Description: The echelon level to use for this entity when cr...
Definition: vrfObjectParameters.h:779

rwFormationType.h

DtVrfObjectParameters::myParameterType
DtString myParameterType
String that keeps the type of parameter this is Local only – not part of descriptor.
Definition: vrfObjectParameters.h:1023

DtVrfObjectParameters::myDisplayName
DtRwString myDisplayName
Parameter Name: display-name Parameter Description: Name to display to user in Simulation Object Edit...
Definition: vrfObjectParameters.h:1076

DtVrfObjectParameters::ArtPartDescProcMap
std::map< DtString, ArtPartDescriptorProcessor > ArtPartDescProcMap
Definition: vrfObjectParameters.h:1197

taskExecutionRules.h

DtSymbolString
This class allows one to collect and compare strings using an index number instead of having to do st...
Definition: symbolString.h:27

DtVrfObjectParameters::myInitialSectorOfResponsibility
DtSimSector myInitialSectorOfResponsibility
Parameter Name: initial-sector-of-responsibility Parameter Description: The sector of responsibility ...
Definition: vrfObjectParameters.h:1006

DtVrfObjectParameters::myCanMoveOntoEmbarkedTypes
DtRwEntityTypes myCanMoveOntoEmbarkedTypes
Parameter Name: can-move-onto-types Parameter Description: If can move onto if embarked, the types that are allowed. Empty list means all types (default) Parameter Units: Parameter Default Value: False.
Definition: vrfObjectParameters.h:1116

DtVrfObjectParameters::myTaskExecutionRules
DtTaskExecutionRules myTaskExecutionRules
Task execution rules. This is the structure that is read in from the file pointed to by myTaskExecuti...
Definition: vrfObjectParameters.h:1019

DtVrfObjectParameters::myArtPartList
DtSimArtPartDescriptorList myArtPartList
Parameter Name: art-parts Parameter Description: List of configured articulated parts on this type of...
Definition: vrfObjectParameters.h:1142

simSector.h

rwTerrainCategoryMask.h

DtVrfObjectParameters::myHlaFomClass
DtRwString myHlaFomClass
Parameter Name: hla-fom-class Parameter Description: Specifies the HLA FOM class to be published...
Definition: vrfObjectParameters.h:1122

DtSimObjectParametersCreatorFcn
DtVrfObjectParameters *(* DtSimObjectParametersCreatorFcn)(DtEnvironmentSP env, DtEnvValueSP *objectNode)
Definition: vrfObjectParameterFactory.h:25

DtReaderWriterRegistryData
Definition: readerWriterRegistryData.h:25

DT_DLL_vrfobjparam
#define DT_DLL_vrfobjparam
This file is used to determine how to build.
Definition: vrfobjparamDefines.h:28

DtSimArtPartDescriptor
A readable, writable type that holds an articulated part type, attached-to part type, attachment point, and a list of art-part params (DtSimArtPartParamList). The read/write name is not used for anything in particular, and therefore may be used for file readability.
Definition: simArtPartDescriptor.h:28

DtVrfObjectParameters::mySensorDescriptorList
DtComponentDescriptorList mySensorDescriptorList
Parameter Name: sensors Parameter Description: List of sensor controller component descriptors...
Definition: vrfObjectParameters.h:850

DtRwNLengthStringVector
DtRwNLengthStringVector is a named, readable/writable vector of strings of arbitrary length...
Definition: rwNLengthStringVector.h:28

DtVrfObjectParameters::myUiFilename
DtRwString myUiFilename
Parameter Name: ui-filename Parameter Description: name of the .ui file used to configure this entity...
Definition: vrfObjectParameters.h:1089

DtVrfObjectParameters::myMass
DtRwReal myMass
Parameter Name: mass Parameter Description: The mass of the entity. Parameter Default Value: 5000...
Definition: vrfObjectParameters.h:894

simArtPartDescriptorList.h

DtVrfObjectParameters::setParameterType
void setParameterType(const DtString &)
Sets/gets type of parameter.
Definition: vrfObjectParameters.h:1201

DtVrfObjectParameters::myPublicData
DtRwNLengthStringVector myPublicData
Parameter Name: public-data Parameter Description: List of public data that is supported by this comp...
Definition: vrfObjectParameters.h:1154

DtReaderWriter::postGetSelf
virtual void postGetSelf()
Called after either version of getSelf (mtl or environment). Default is no-op.

DtSimSector
Description: DtSimSector is a readable/writable description of a sector of responsibility (center and...
Definition: simSector.h:20

DtVrfObjectParameters::myRemoteSubComponentTypes
DtVrfObjectSubComponentTypes * myRemoteSubComponentTypes
Parameter Name: remote-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used for remotely simulated objects.
Definition: vrfObjectParameters.h:735

DtVrfObjectParameters::myLosTerrainCategoryMask
DtRwTerrainCategoryMask myLosTerrainCategoryMask
Parameter Name: los-terrain-category-mask Parameter Description: The types of terrain that are requir...
Definition: vrfObjectParameters.h:1169

DtVrfSubObjectParameterList
DtVrfSubObjectParameterList is a readable/writable list of DtVrfSubObjectParameterEntrys.
Definition: vrfSubObjectParameterList.h:21

DtComponentSystemDescriptorList
List of DtComponentSystemDescriptor instances.
Definition: componentSystemDescriptorList.h:20

DtVrfObjectParameters::myControllerDescriptorList
DtComponentDescriptorList myControllerDescriptorList
Parameter Name: controllers Parameter Description: List of controller component descriptors.
Definition: vrfObjectParameters.h:854

rwBoolean.h

DtReaderWriter::getData
virtual DtlObjPtr getData(DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
Deriving class overrides these to get/put class specific data.

vrfSubObjectParameterList.h

rwAppearance.h

DtReaderWriter
Definition: readerWriter.h:85

DtRwString
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20

DtVrfObjectParameters::myTaskExecutionRulesFilename
DtReaderWriterFile myTaskExecutionRulesFilename
Parameter Name: task-execution-rules Parameter Description: The name of the file that contains the ta...
Definition: vrfObjectParameters.h:1014

DtSimResourceManager
class DtSimResourceManager:
Definition: simResourceManager.h:19

DtComponentDescriptorList
Instances of DtComponentDescriptorList are readable/writeable lists of DtComponentDescriptor objects...
Definition: componentDescriptorList.h:22

DtComponentDescriptor
A readable, writable type whose name is the name of a component and that has a list of component name...
Definition: componentDescriptor.h:49

DtVrfObjectParameters::myDeadReckoningThresholds
DtRwDeadReckonThresholds myDeadReckoningThresholds
Parameter Name: dr-thresholds Parameter Description: The translation, rotation, and aggregate dimensi...
Definition: vrfObjectParameters.h:834

DtVrfObjectParameters::parameterType
const DtString & parameterType() const
Definition: vrfObjectParameters.h:1206

DtReaderWriterRegistry
Definition: readerWriterRegistry.h:39

radioDescriptorList.h

DtVrfObjectParameters::myMovementTerrainCategoryMask
DtRwTerrainCategoryMask myMovementTerrainCategoryMask
Parameter Name: movement-terrain-category-mask Parameter Description: The types of terrain that are r...
Definition: vrfObjectParameters.h:1176

DtVrfObjectParameters::myMinTickPeriod
DtRwReal myMinTickPeriod
Parameter Name: min-tick-period Parameter Description: Specifies the shortest period of time...
Definition: vrfObjectParameters.h:800

rwSensorSignatureList.h

DtVrfObjectParameters::myDisplayDescription
DtRwString myDisplayDescription
Parameter Name: display-description Parameter Description: Description of parameter to display in Sim...
Definition: vrfObjectParameters.h:1082

DtVrfObjectParameters::myMainComponent
DtRwString myMainComponent
Parameter Name: main-component Parameter Description: The component that is considered the root (main...
Definition: vrfObjectParameters.h:1148

DtRwDeadReckonTypes
Description: Readable, Writable DtDeadReckonTypes.
Definition: rwDeadReckonTypes.h:30

DtSimArtPartDescriptorList
Instances of DtSimArtPartDescriptorList are lists of DtSimArtPartDescriptors. This is an optional par...
Definition: simArtPartDescriptorList.h:16

DtRadioDescriptorList
List of DtRadioDescriptor subclasses that can be read from a RW type file. This class owns all descri...
Definition: radioDescriptorList.h:27

DtVrfObjectParameters::myStateRepositoryUserExtension
DtVrfStateRepositoryUserExtension * myStateRepositoryUserExtension
Parameter Name: user-extension Parameter Description: Extension to the state repository class...
Definition: vrfObjectParameters.h:985

findProperty
const SpecificRwType * findProperty(const DtReaderWriter &properties, const DtString &propertyName)
Finds the ReaderWriter object in the given set of properties with the specified name. Then verifies that the ReaderWriter matches the type specified as the template argument. Returns a valid pointer if successful.

DtRwFormationType
Description: Readable, Writable DtAggregateFormation.
Definition: rwFormationType.h:30

DtReaderWriter::factory
static DtReaderWriterFactory * factory()

DtRwDeadReckonThresholds
Definition: rwDeadReckonThresholds.h:23

DtVrfObjectParameterFactory
DtVrfObjectParameterFactory is a hashlist of DtSimObjectParametersCreatorFcn, indexed by a string typ...
Definition: vrfObjectParameterFactory.h:31

componentDescriptorList.h

DtVrfObjectSubComponentTypes
DtVrfObjectSubComponentTypes.
Definition: vrfObjectSubComponentTypes.h:25

readerWriter.h

DtVrfObjectParameters::mySameObjectTypeCanAutoEmbark
DtRwBoolean mySameObjectTypeCanAutoEmbark
Parameter Name: same-object-type-can-auto-embark Parameter Description: Whether or not the same objec...
Definition: vrfObjectParameters.h:1110

DtVrfObjectParameters::myMatchType
DtEntityType myMatchType
An extended form of the DIS/RPR FOM entity enumerated type. Specifies the key used to look up the ent...
Definition: vrfObjectParameters.h:692

DtReaderWriter::operator!=
bool operator!=(const DtReaderWriter &rhs) const
Definition: readerWriter.h:121

DtVrfObjectParameters::myDeadReckoningAlgorithm
DtRwDeadReckonTypes myDeadReckoningAlgorithm
Parameter Name: dr-algorithm Parameter Description: The VR-Link dead-reckoning algorithm to use when ...
Definition: vrfObjectParameters.h:822

DtVrfObjectParameters::myDynamicFeatureWidth
DtRwReal myDynamicFeatureWidth
Parameter Name: dynamic-feature-width Parameter Description: When dynamic-feature-enabled is True...
Definition: vrfObjectParameters.h:1186

rwEntityTypeList.h

DtVrfObjectParameters::myDefaultAppearance
DtRwAppearance myDefaultAppearance
Parameter Name: default-appearance Parameter Description: Unsigned int used to set default valus for ...
Definition: vrfObjectParameters.h:751

DtRwVisualMetaData
DtRwVisualMetaData is a container for a visual meta data file, and, with the meta data within that fi...
Definition: rwVisualMetaData.h:18

DtVrfObjectParameters::myUnderFireDistance
DtRwReal myUnderFireDistance
Parameter Name: under-fire-distance Parameter Description: Deprecated. This concept is now modeled in...
Definition: vrfObjectParameters.h:997

DtVariableBindingsList
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29

DtVrfObjectParameters::myInternalStateData
DtRwProperties myInternalStateData
Properties that will be added to the state repository of this particular entity. These values can be ...
Definition: vrfObjectParameters.h:1052

DtRwAppearance
Class Description: Readable, writable form of DtAppearance.
Definition: rwAppearance.h:16

DtVrfObjectParameters::myConfiguredArtPartList
std::list< DtSimArtPartDescriptor * > myConfiguredArtPartList
A list containing all the art part descriptors for parts that will be available to the entity...
Definition: vrfObjectParameters.h:1029

DtVrfObjectParameters::myEngagementRules
DtRwString myEngagementRules
Parameter Name: engagement-rules Parameter Description: (Optional) The engagement rules the entity wi...
Definition: vrfObjectParameters.h:945

simClock.h
File: vlClock.h.

DtRwInt
Description: Readable, Writable int.
Definition: rwInt.h:25

DtVrfObjectParameters::myIlluminationRecalcTime
DtRwBoolean myIlluminationRecalcTime
Parameter Name: illumination-recalc-time Parameter Description: Amount of time (in seconds) to recalc...
Definition: vrfObjectParameters.h:1070

DtReaderWriter::SearchPaths
std::vector< DtFilename > SearchPaths
Definition: readerWriter.h:92

DtVrfObjectParameters::myRangeRingPublisherTickTime
DtRwReal myRangeRingPublisherTickTime
The tick time of the range ring &quot;publisher&quot; for range ring parameter and state data. Default is -1 (as fast as possible) Value is in seconds of simulation time.
Definition: vrfObjectParameters.h:1056

DtVrfObjectParameters::myFormationType
DtRwFormationType myFormationType
Parameter Name: formation Parameter Description: (Optional) One of the following: ...
Definition: vrfObjectParameters.h:747

DtVrfObjectParameters::myDeadReckoningAllowGuiOverrides
DtRwBoolean myDeadReckoningAllowGuiOverrides
Parameter Name: bounding-geometry-type Parameter Description: Describes an object&#39;s bounding volume...
Definition: vrfObjectParameters.h:836

DtVrfObjectParameters::myOrganized
DtRwBoolean myOrganized
Parameter Name: is-organized Parameter Description: Specifies that the entity is part of the entity h...
Definition: vrfObjectParameters.h:793

DtVrfStateRepositoryUserExtension
Instances of DtVrfStateRepositoryUserExtension can be used by customers to extend the base DtVrfObjec...
Definition: vrfStateRepositoryUserExtension.h:20

DtVrfObjectParameters::myStateRepositoryUserExtensionType
DtRwString myStateRepositoryUserExtensionType
Parameter Name: state-repository-extension-type Parameter Description: Type of state repository exten...
Definition: vrfObjectParameters.h:970

DtVrfObjectParameters::myDefaultEntityType
DtRwEntityType myDefaultEntityType
Parameter Name: display-entity-type Parameter Description: Default entity type for platform to use in...
Definition: vrfObjectParameters.h:1128

DtVrfObjectParameters::myObjectNode
DtEnvValueSP myObjectNode
Definition: vrfObjectParameters.h:1036

DtSimBoundingGeometry::DtSimBoundingGeometryType
DtSimBoundingGeometryType
Definition: simBoundingGeometry.h:61

DtRwTerrainCategoryMask
A DtReaderWriter subclass for DtTerrainCategoryMask. This accepts the mask names as both symbols and ...
Definition: rwTerrainCategoryMask.h:31

DtVrfObjectParameters::myObjectType
DtEntityType myObjectType
Definition: vrfObjectParameters.h:693

rwReal.h

DtRwAutoConnection
Rw Object which defines automatic connections between specified system categories / components...
Definition: rwAutoConnection.h:19

DtVrfObjectParameters::mySpatiallySearchable
DtRwBoolean mySpatiallySearchable
Parameter Name: spatially-searchable Parameter Description: When true, this object will be added avai...
Definition: vrfObjectParameters.h:1192

DtReaderWriter::getSelf
virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter member...

DtConnectionDescriptorList
Instances of DtConnectionDescriptorList are readable/writeable lists of DtConnectionDescriptor object...
Definition: connectionDescriptorList.h:22

DtVrfObjectParameters::theFactory
static DtVrfObjectParameterFactory * theFactory
Definition: vrfObjectParameters.h:1025

DtRwForceType
Description: A readable, writable DtForceType.
Definition: rwForceType.h:26

DtVrfObjectParameters::myLocalSubComponentTypes
DtVrfObjectSubComponentTypes * myLocalSubComponentTypes
Parameter Name: local-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used by locally simulated objects.
Definition: vrfObjectParameters.h:729

rwNavigationParameters.h

DtReaderWriter::nullVariableReference
static const DtVariableBindingsList & nullVariableReference()

DtRwReal
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27

DtRwEntityType
File: rwEntType.h.
Definition: rwEntityType.h:26

DtRwNavigationParameters
Definition: rwNavigationParameters.h:27

DtVrfObjectParameters::myBoundingGeometryType
DtRwBoundingGeometryType myBoundingGeometryType
Parameter Name: bounding-geometry-type Parameter Description: Describes an object&#39;s bounding volume...
Definition: vrfObjectParameters.h:710

DtVrfObjectParameters::myActuatorDescriptorList
DtComponentDescriptorList myActuatorDescriptorList
Parameter Name: actuators Parameter Description: List of actuator component descriptors.
Definition: vrfObjectParameters.h:858

DtVrfObjectParameters::myBvol
DtRwBoundingVolume myBvol
Parameter Name: bounding-volume Parameter Description: Specifies the bounding volume around an object...
Definition: vrfObjectParameters.h:723

DtRwBoundingGeometryType
class DtRwBoundingGeometryType:
Definition: rwBoundingGeometryType.h:20

DtComponentSystemDescriptor
Descriptor for a DtComponentSystem. Specified a system being added to an entity. This does not actual...
Definition: componentSystemDescriptor.h:23

rwString.h

DtReaderWriter::putData
virtual void putData(std::string &fp, int indentLevel=0)
Deriving class overrides these to get/put class specific data.

DtRwBoolean
Description: Readable, Writable bool.
Definition: rwBoolean.h:26

rwDeadReckonThresholds.h

DtVrfObjectParameters::myDynamicFeatureEnabled
DtRwBoolean myDynamicFeatureEnabled
Parameter Name: dynamic-feature-enabled Parameter Description: When enabled, will add a new feature i...
Definition: vrfObjectParameters.h:1181

DtSimResource
DtSimResource is a class which will define a SISO Enumeration to use as a resource and the quantity o...
Definition: simResource.h:32

rwDeadReckonTypes.h

DtRwTemplatedListPtr< DtRwAutoConnection, true >

DtTerrainCategoryMask
unsigned int DtTerrainCategoryMask
This bitmask is made using DtTerrainCategory values.
Definition: rwTerrainCategoryMask.h:27

init
DT_DLL_DEBUGDRAWRENDERER void init(makVrv::DtDe &de)
Work function for the plugin initialization.

DtVrfObjectParameters::myCallsign
DtRwString myCallsign
Parameter Name: callsign Parameter Description: The default callsign to use for this entity...
Definition: vrfObjectParameters.h:786

DtVrfObjectParameters::myStateData
DtRwProperties myStateData
Properties that will be added to the state repository of this particular entity. These values can be ...
Definition: vrfObjectParameters.h:1047

simResourceManager.h

DtVrfObjectParameters::myMinTickPeriodVariance
DtRwReal myMinTickPeriodVariance
Parameter Name: min-tick-period-variance Parameter Description: Specifies an amount within which the ...
Definition: vrfObjectParameters.h:808

DtVrfObjectParameters::myCanCreateAsNew
DtRwBoolean myCanCreateAsNew
Parameter Name: can-create-as-new Parameter Description: Only for Simulation Object Editor...
Definition: vrfObjectParameters.h:1096

vrfobjparamDefines.h

componentSystemDescriptorList.h

rwEntityType.h

DtVrfObjectParameters::myForceType
DtRwForceType myForceType
Parameter Name: force-type Parameter Description: The force to which the object belongs. One of the following:
Definition: vrfObjectParameters.h:763

DtReaderWriter::operator=
const DtReaderWriter & operator=(const DtReaderWriter &orig)
assignment operator

DtVrfObjectParameters::myGetSelfVariableBindings
DtVariableBindingsList myGetSelfVariableBindings
Local copy of variable bindings used to seed this parameter entry.
Definition: vrfObjectParameters.h:1195

DtRwProperties
A list of properties. A DtPropertyInterface object that is a specialized version of DtRwVariableBindi...
Definition: rwProperties.h:122

rwBoundingGeometryType.h

DtVrfObjectParameters::mySensorSignatureList
DtRwSensorSignatureList mySensorSignatureList
Parameter Name: sensor-signatures Parameter Description: Parameter Default Value: ...
Definition: vrfObjectParameters.h:899

DtVrfObjectParameters::mySystemDescriptorList
DtComponentSystemDescriptorList mySystemDescriptorList
Parameter Name: systems Parameter Description: List of system descriptors. Systems are collections of...
Definition: vrfObjectParameters.h:846

DtVrfObjectParameters::myConnectionDescriptorList
DtConnectionDescriptorList myConnectionDescriptorList
Parameter Name: connections Parameter Description: The connections (Example 5.2, line 19) entry speci...
Definition: vrfObjectParameters.h:888

DtTaskExecutionRules
This RW class contains the rules for executing tasks on a particular type of entity. It contains lists of tasks that are mutually exclusive, meaning that they cannot be run at the same time on the entity.
Definition: taskExecutionRules.h:47

DtVrfObjectParameters::myCategory
DtRwString myCategory
Parameter Name: category Parameter Description: The category string to use when creating an echelon I...
Definition: vrfObjectParameters.h:771

DtEnvironmentSP
DT_DLL_readerWriter std::shared_ptr< DtEnvironment > DtEnvironmentSP
Definition: readerWriter.h:30

DtVrfObjectParameters::myEnvironment
DtEnvironmentSP myEnvironment
Definition: vrfObjectParameters.h:1037

DtVrfObjectParameters::myComponentDefaultArtPartList
std::list< DtSimArtPartDescriptor * > myComponentDefaultArtPartList
A list containing all the art part descriptor default settings from attached actuators. These part settings are not used directly, but can be used to default those in the myConfiguredArtPartList.
Definition: vrfObjectParameters.h:1034

DtVrfObjectParameters::myNavigationParameters
DtRwNavigationParameters myNavigationParameters
Parameter Name: bounding-geometry-type Parameter Description: Describes an object&#39;s bounding volume...
Definition: vrfObjectParameters.h:824

DtString

rwProperties.h

offset
voidpf uLong offset
Definition: ioapi.h:42

rwAutoConnection.h

DtReaderWriterFile
Using a DtReaderWriterFile allows a DtReaderWriter object to be read in from an MTL stream contained ...
Definition: readerWriterFile.h:35

DtVrfObjectParameters::myTaskedBySuperiorUponTaskComplete
DtRwBoolean myTaskedBySuperiorUponTaskComplete
Parameter Name: tasked-by-superior-upon-task-complete Parameter Description: Flag indicating whether ...
Definition: vrfObjectParameters.h:977

rwVisualMetaData.h

DtRwBoundingVolume
File: rwBndingVol.h.
Definition: rwBoundingVolume.h:25

rwForceType.h

DtVrfObjectParameters::myRadioDescriptorList
DtRadioDescriptorList myRadioDescriptorList
Parameter Name: radios Parameter Description: List of all radios on the entity.
Definition: vrfObjectParameters.h:840

DtVrfObjectParameters::myArtPartDescProcs
ArtPartDescProcMap myArtPartDescProcs
Definition: vrfObjectParameters.h:1198

DtVrfObjectParameters::myVisualMetaData
DtRwVisualMetaData myVisualMetaData
Parameter Name: visual-meta-data Parameter Description: If defined how the visual meta data will init...
Definition: vrfObjectParameters.h:1135

DtVrfObjectParameters::myAttachedObjects
DtVrfSubObjectParameterList * myAttachedObjects
Parameter Name: attached-objects Parameter Description:  Parameter Default Value:  ...
Definition: vrfObjectParameters.h:935

readerWriterFile.h

DtRwSensorSignatureList
A RW-List containing DtRwSensorSignature elements.
Definition: rwSensorSignatureList.h:20

DtVrfObjectParameters::myAutoConnections
DtAutoConnectionsListPtr myAutoConnections
Definition: vrfObjectParameters.h:1039

vrfObjectParameterFactory.h

DtVrfObjectParameters::DtAutoConnectionsListPtr
DtRwTemplatedListPtr< DtRwAutoConnection, true > DtAutoConnectionsListPtr
Definition: vrfObjectParameters.h:68