VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes
DtVrfObjectParameters Class Reference

Instances of DtVrfObjectParameters are the readable/writeable objects that contain the information necessary to construct a DtLocalObject.
Developer Description: Used to hold parameters for the DtVrfMovingObjectStateRepository class.

Related Examples
Inheritance diagram for DtVrfObjectParameters:
Inheritance graph
[legend]

Public Types

typedef DtRwTemplatedListPtr
< DtRwAutoConnection, true > 		DtAutoConnectionsListPtr
 
- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString > 		aliasContainer
 
typedef std::vector
< DtSymbolString >::iterator 		aliasIter
 
typedef std::vector
< DtSymbolString >
::const_iterator 		aliasConstIter
 
typedef std::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString > 		DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 

Public Member Functions

 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 ()
 
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 bool organized () const
 
virtual void setOrganized (bool organized)
 
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
DtRwDeadReckonThresholds & 		deadReckoningThresholds () const
 
virtual void setDeadReckoningThresholds (const DtRwDeadReckonThresholds &deadReckoningThresholds)
 
virtual DtReal mass () const
 
virtual void setMass (const DtReal mass)
 
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)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
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 setStateRepositoryUserExtensionType (const DtString &type)
 
virtual const DtString & stateRepositoryUserExtensionType () const
 
virtual DtObjectType objectType () const
 
virtual void setObjectType (const DtObjectType &objectType)
 
virtual DtObjectType matchType () const
 
virtual void setMatchType (const DtObjectType &objectType)
 
virtual bool taskedBySuperiorUponTaskComplete () const
 
virtual void setTaskedBySuperiorUponTaskComplete (bool trueOrFalse)
 
virtual void setRangeRingPublisherTickTime (double)
 
virtual double rangeRingPublisherTickTime () const
 
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())
 
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
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 void setPublishParameterData (bool)
 
virtual bool publishParameterData () const
 
virtual void setDisplayObjectImage (int)
 
virtual int displayObjectImage () 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 &=DtObjectType()) const
 
virtual void setSameObjectTypeCanAutoEmbark (bool)
 
virtual bool sameObjectTypeCanAutoEmbark () const
 
virtual const DtRwEntityTypes & canMoveOntoEmbarkedTypes () const
 
virtual void setCanMoveOntoEmbarkedTypes (const DtRwEntityTypes &)
 
virtual void rebuildArtPartList ()
 
virtual void updatePartOverridesFromActuator (DtSimArtPartDescriptor &artPartDescriptor, const DtComponentDescriptor &actuatorDescriptor, const DtString &systemName=DtString::nullString())
 
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 DtRwBoolean deadReckoningAllowGuiOverrides () const
 
virtual void setDeadReckoningAllowGuiOverrides (bool allow)
 
virtual const
DtRadioDescriptorList & 		radioDescriptorList () const
 
virtual DtRadioDescriptorList & radioDescriptorList ()
 
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
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 
const DtReaderWriter & operator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
virtual void postGetSelf ()
 
virtual void preGetSelf ()
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual DtSymbolString name () const
 
virtual void addAlias (const DtSymbolString &alias)
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContainer & aliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual void reset ()
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
virtual const char * readerWriterType () const
 
virtual const char * xmlType () const
 
virtual DtString prettyPrint () const
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 
virtual std::list
< DtVariableNameType > 		unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 
virtual bool hasVariableReference () const
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 
virtual void recordUpdateTime () const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 
virtual DtSymbolString variableName () const
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriter * defaultRWValue () const
 
virtual DtReaderWriter * defaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistry & registry () const
 
DtReaderWriterRegistry & registry ()
 
virtual DtPropertyInterface * property ()
 
virtual const DtPropertyInterface * property () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindings * generateVariableBindings () const
 
virtual bool toXml (const DtFilename &) const
 
virtual bool fromXml (const DtString &)
 
virtual bool fromXmlFile (const DtFilename &)
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 

Static Public Member Functions

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)
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList & 		nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const char * theXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactory * factory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWriter * createFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWriter * createFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWriter * createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Types

typedef void(* ArtPartDescriptorProcessor )(const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
 
typedef std::map< DtString,
ArtPartDescriptorProcessor > 		ArtPartDescProcMap
 

Protected Member Functions

 DtVrfObjectParameters (const DtVrfObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtVrfObjectParameters (const DtVrfObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
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)
 
virtual void addArtPartDescriptorProcessor (const DtString &componentType, const ArtPartDescriptorProcessor &fcn)
 
virtual void addStateDataFromComponents ()
 
virtual void addStateDataFromSystem (const DtComponentSystemDescriptor *systemDesc)
 
virtual void addStateDataFromComponent (const DtComponentDescriptor *systemDesc)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Static Protected Member Functions

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)
 

Protected Attributes

DtObjectType myMatchType
 
DtObjectType myObjectType
 
DtTaskExecutionRules myTaskExecutionRules
 
DtString myParameterType
 
std::list
< DtSimArtPartDescriptor * > 		myConfiguredArtPartList
 
std::list
< DtSimArtPartDescriptor * > 		myComponentDefaultArtPartList
 
DtEnvValueSP myObjectNode
 
DtEnvironmentSP myEnvironment
 
DtAutoConnectionsListPtr myAutoConnections
 
DtRwProperties myParameterData
 
DtRwProperties myStateData
 
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
 
DtVariableBindingsList myGetSelfVariableBindings
 
ArtPartDescProcMap myArtPartDescProcs
 
parameters

These parameters are available for setting in the OPD files.

DtRwBoundingGeometryType myBoundingGeometryType
 
DtRwBoundingVolume myBvol
 
DtVrfObjectSubComponentTypes * myLocalSubComponentTypes
 
DtVrfObjectSubComponentTypes * myRemoteSubComponentTypes
 
DtRwFormationType myFormationType
 
DtRwAppearance myDefaultAppearance
 
DtRwForceType myForceType
 
DtRwString myCategory
 
DtRwString myEchelonLevel
 
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
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistry * myParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWriter * myDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

Static Protected Attributes

static
DtVrfObjectParameterFactory * 		theFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactory * theFactory
 
static
DtReaderWriterFactoryCreatorFcn 		theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Member Typedef Documentation

typedef DtRwTemplatedListPtr<DtRwAutoConnection,true> DtVrfObjectParameters::DtAutoConnectionsListPtr
typedef void(* DtVrfObjectParameters::ArtPartDescriptorProcessor)(const DtComponentDescriptor &compDesc, DtSimArtPartDescriptor &artPartDesc)
protected
typedef std::map<DtString, ArtPartDescriptorProcessor> DtVrfObjectParameters::ArtPartDescProcMap
protected

Constructor & Destructor Documentation

DtVrfObjectParameters::DtVrfObjectParameters ( const DtString &  name = DtString::nullString(),
DtReaderWriterRegistry *  parentRegistry = NULL,
DtEnvironmentSP  env = DtEnvironmentSP(),
DtEnvValueSP *  objectNode = NULL 
)

Constructor with parameters to set up read/writability correctly.

DtVrfObjectParameters::DtVrfObjectParameters ( const DtSymbolString &  name,
DtReaderWriterRegistry *  parentRegistry = NULL,
DtEnvironmentSP  env = DtEnvironmentSP(),
DtEnvValueSP *  objectNode = NULL 
)
virtual DtVrfObjectParameters::~DtVrfObjectParameters ( )
virtual

destructor

DtVrfObjectParameters::DtVrfObjectParameters ( const DtVrfObjectParameters &  orig,
const DtString &  name = DtString::nullString(),
DtReaderWriterRegistry *  parentRegistry = NULL 
)
protected

copy constructor. Use clone instead.

DtVrfObjectParameters::DtVrfObjectParameters ( const DtVrfObjectParameters &  orig,
const DtSymbolString &  name,
DtReaderWriterRegistry *  parentRegistry = NULL 
)
protected

Member Function Documentation

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

assignment operator

virtual DtVrfObjectParameters* DtVrfObjectParameters::clone ( const DtString &  name = DtString::nullString(),
DtReaderWriterRegistry *  parentRegistry = NULL 
) const
virtual

Reimplemented in DtFixedWingEntityParameters, DtRotaryWingEntityParameters, DtMovingObjectParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtCulturalFeatureParameters, DtHumanParameters, DtMinefieldParameters, DtSubSurfaceEntityParameters, DtSurfaceEntityParameters, DtTacticalSmokeParameters, DtMissileParameters, DtBombParameters, DtRandomizedObjectParameters, DtBallisticMissileParameters, and DtGlobalEnvironmentParameters.

virtual DtVrfObjectParameters* DtVrfObjectParameters::clone ( const DtSymbolString &  name,
DtReaderWriterRegistry *  parentRegistry = NULL 
) const
virtual

Reimplemented in DtFixedWingEntityParameters, DtMovingObjectParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtRotaryWingEntityParameters, DtCulturalFeatureParameters, DtMinefieldParameters, DtSurfaceEntityParameters, DtTacticalSmokeParameters, DtHumanParameters, DtMissileParameters, DtBombParameters, DtRandomizedObjectParameters, DtGlobalEnvironmentParameters, DtBallisticMissileParameters, and DtSubSurfaceEntityParameters.

virtual bool DtVrfObjectParameters::init ( )
virtual

Invoked when created so that deriving classes may do virtual allocation as necessary. The base class version creates the local and remote composed object types. Calls createSubordinateObjectsList() and createAttachedObjectsList() to create the mySubordinateObjects and myAttachedObjects data members, respectively.

Reimplemented in DtAggregateObjectParameters, and DtRandomizedObjectParameters.

virtual DtString DtVrfObjectParameters::type ( ) const
virtual

Returns a string identifying the type of parameter descriptor. Used to create the descriptor on read from a parameter database file. ((Required) The value must be in quotation marks. Type strings are defined in vrfParamTypes.h.

Returns
DtVrfObjectParamType

Reimplemented in DtMissileParameters, DtFixedWingEntityParameters, DtGroundVehicleParameters, DtBombParameters, DtMinefieldParameters, DtCulturalFeatureParameters, DtMovingObjectParameters, DtAggregateObjectParameters, DtRotaryWingEntityParameters, DtRandomizedObjectParameters, DtHumanParameters, DtSurfaceEntityParameters, DtTacticalSmokeParameters, DtSubSurfaceEntityParameters, DtBallisticMissileParameters, and DtGlobalEnvironmentParameters.

virtual bool DtVrfObjectParameters::inheritValues ( const DtVrfObjectParameters *  benefactor)
virtual

Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from.

Reimplemented in DtFixedWingEntityParameters, DtMovingObjectParameters, DtRotaryWingEntityParameters, DtRandomizedObjectParameters, DtHumanParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtSurfaceEntityParameters, DtCulturalFeatureParameters, DtSubSurfaceEntityParameters, DtMinefieldParameters, DtBombParameters, and DtMissileParameters.

virtual void DtVrfObjectParameters::inheritValuesFromThisType ( const DtVrfObjectParameters *  benefactor)
virtual

Reimplemented in DtRandomizedObjectParameters.

virtual bool DtVrfObjectParameters::createLocalSubComponentTypes ( )
virtual

Creates a DtVrfObjectSubComponentTypes type of composed object type.

virtual bool DtVrfObjectParameters::createRemoteSubComponentTypes ( )
virtual

Creates a DtVrfObjectSubComponentTypes type of composed object type.

virtual DtVrfObjectSubComponentTypes* DtVrfObjectParameters::localVrfSubComponentTypes ( ) const
virtual

Get local sub-component types. This is the set of type strings indicating the kinds objects that a DtSimObject should contain (i.e. the type of sim state repository, type of network interface), when the DtSimObject is locally simulated.

virtual DtVrfObjectSubComponentTypes* DtVrfObjectParameters::remoteVrfSubComponentTypes ( ) const
virtual

Get remote sub-component types. This is the set of type strings indicating the kinds objects that a DtSimObject should contain (i.e. the type of sim state repository, type of network interface), when the DtSimObject is simulated remotely.

virtual void DtVrfObjectParameters::setMinTickPeriod ( DtReal  minTickPeriod)
virtual

Set the minimum tick period for this object (individual components and the network interface may override)

virtual DtReal DtVrfObjectParameters::minTickPeriod ( ) const
virtual

get the minimum tick period for this component (individual components and the network interface may override)

virtual void DtVrfObjectParameters::setMinTickPeriodVariance ( DtReal  minTickPeriodVariance)
virtual

Set the minimum tick period variance for this component (individual components and the network interface may override)

virtual DtReal DtVrfObjectParameters::minTickPeriodVariance ( ) const
virtual

Get the minimum tick period variance for this component (individual components and the network interface may override)

virtual DtForceType DtVrfObjectParameters::forceType ( ) const
virtual

Currently unused. Since entities are specified at creation time as an entity type and force type, we may go to using both as a lookup key.

virtual void DtVrfObjectParameters::setForceType ( const DtForceType  force)
virtual
virtual bool DtVrfObjectParameters::hasGuiKeyword ( const DtString &  ) const
virtual

Returns true if the gui keywords contain the particular keyword specified (the gui keywords are specified in the .entity object)

virtual const DtString& DtVrfObjectParameters::category ( ) const
virtual

Accessor/mutator for myCategory.

virtual void DtVrfObjectParameters::setCategory ( const DtString &  category)
virtual
virtual bool DtVrfObjectParameters::categorySpecified ( ) const
virtual

Returns true of the category was specified in the file.

virtual const DtString& DtVrfObjectParameters::echelonLevel ( ) const
virtual

Accessor/mutator for myEchelonLevel.

virtual void DtVrfObjectParameters::setEchelonLevel ( const DtString &  echelonLevel)
virtual
virtual bool DtVrfObjectParameters::echelonLevelSpecified ( ) const
virtual

Returns true of the echelon level was specified in the file.

virtual bool DtVrfObjectParameters::organized ( ) const
virtual

Accessor/mutator for myOrganized.

virtual void DtVrfObjectParameters::setOrganized ( bool  organized)
virtual
virtual const DtString& DtVrfObjectParameters::mainComponent ( ) const
virtual

See myMainComponent.

virtual void DtVrfObjectParameters::setMainComponent ( const DtString &  )
virtual

See myMainComponent.

virtual bool DtVrfObjectParameters::mainComponentSpecified ( ) const
virtual

See myMainComponent.

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

See myPublicData.

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

See myPublicData.

virtual bool DtVrfObjectParameters::publicDataSpecified ( ) const
virtual

See myPublicData.

virtual const DtComponentSystemDescriptorList& DtVrfObjectParameters::systemDescriptorList ( ) const
virtual

See mySystemDescriptorList.

virtual DtComponentSystemDescriptorList& DtVrfObjectParameters::systemDescriptorList ( )
virtual

See mySystemDescriptorList.

virtual void DtVrfObjectParameters::setSystemDescriptorList ( const DtComponentSystemDescriptorList &  list)
virtual

See mySystemDescriptorList.

virtual const DtRwVisualMetaData& DtVrfObjectParameters::visualMetaData ( ) const
virtual

Accessor/mutator for myVisualMetaData.

virtual void DtVrfObjectParameters::setVisualMetaData ( const DtRwVisualMetaData &  list)
virtual
virtual const DtComponentDescriptorList& DtVrfObjectParameters::sensorDescriptorList ( ) const
virtual

Accessor/mutator for mySensorDescriptorList.

virtual DtComponentDescriptorList& DtVrfObjectParameters::sensorDescriptorList ( )
virtual
virtual void DtVrfObjectParameters::setSensorDescriptorList ( const DtComponentDescriptorList &  list)
virtual
virtual const DtComponentDescriptorList& DtVrfObjectParameters::controllerDescriptorList ( ) const
virtual

Accessor/mutator for myControllerDescriptorList.

virtual DtComponentDescriptorList& DtVrfObjectParameters::controllerDescriptorList ( )
virtual
virtual void DtVrfObjectParameters::setControllerDescriptorList ( const DtComponentDescriptorList &  list)
virtual
virtual const DtComponentDescriptorList& DtVrfObjectParameters::actuatorDescriptorList ( ) const
virtual

Accessor/mutator for myActuatorDescriptorList.

virtual DtComponentDescriptorList& DtVrfObjectParameters::actuatorDescriptorList ( )
virtual
virtual void DtVrfObjectParameters::setActuatorDescriptorList ( const DtComponentDescriptorList &  list)
virtual
virtual const DtConnectionDescriptorList& DtVrfObjectParameters::connectionDescriptorList ( ) const
virtual

Accessor/mutator for myConnectionDescriptorList.

virtual DtConnectionDescriptorList& DtVrfObjectParameters::connectionDescriptorList ( )
virtual
virtual void DtVrfObjectParameters::setConnectionDescriptorList ( const DtConnectionDescriptorList &  list)
virtual
virtual DtDeadReckonTypes DtVrfObjectParameters::deadReckoningAlgorithm ( ) const
virtual

Accessor/mutator for myDeadReckoningAlgorithm.

virtual void DtVrfObjectParameters::setDeadReckoningAlgorithm ( DtDeadReckonTypes  deadReckoningAlgorithm)
virtual
virtual const DtRwNavigationParameters& DtVrfObjectParameters::navigationParameters ( ) const
virtual

Accessor/mutator for myNavigationParameters.

virtual DtRwNavigationParameters& DtVrfObjectParameters::navigationParameters ( )
virtual
virtual void DtVrfObjectParameters::setNavigationParameters ( const DtRwNavigationParameters &  parameters)
virtual
virtual const DtRwBoolean DtVrfObjectParameters::deadReckoningAllowGuiOverrides ( ) const
virtual

Accessor/mutator for myDeadReckoningAllowGuiOverrides.

virtual void DtVrfObjectParameters::setDeadReckoningAllowGuiOverrides ( bool  allow)
virtual

Accessor/mutator for myDeadReckoningAllowGuiOverrides.

virtual const DtRwDeadReckonThresholds& DtVrfObjectParameters::deadReckoningThresholds ( ) const
virtual

Accessor/mutator for myDeadReckoningThresholds.

virtual void DtVrfObjectParameters::setDeadReckoningThresholds ( const DtRwDeadReckonThresholds &  deadReckoningThresholds)
virtual
virtual DtReal DtVrfObjectParameters::mass ( ) const
virtual

Accessor/mutator for myMass.

virtual void DtVrfObjectParameters::setMass ( const DtReal  mass)
virtual
virtual const DtRadioDescriptorList& DtVrfObjectParameters::radioDescriptorList ( ) const
virtual

See myRadioDescriptorList.

virtual DtRadioDescriptorList& DtVrfObjectParameters::radioDescriptorList ( )
virtual

See myRadioDescriptorList.

virtual const DtRwSensorSignatureList& DtVrfObjectParameters::sensorSignatureList ( ) const
virtual

Accessor/mutator for mySensorSignatureList.

virtual DtRwSensorSignatureList& DtVrfObjectParameters::sensorSignatureList ( )
virtual
virtual const DtVrfSubObjectParameterList& DtVrfObjectParameters::subordinateObjects ( ) const
virtual

List of subordinates objects to create if fully instantiating from the parameter entry (ignored when object is being created by an AggregateAs message, eg.)

virtual void DtVrfObjectParameters::setSubordinateObjects ( const DtVrfSubObjectParameterList &  subordinateObjects)
virtual
virtual const DtVrfSubObjectParameterList& DtVrfObjectParameters::attachedObjects ( ) const
virtual

Note that attached objects are not fully supported yet (still need to modify our network interfaces to support the new VR-Link / RPR mechanism for publishing attached objects) and so this list is currently ignored.

virtual void DtVrfObjectParameters::setAttachedObjects ( const DtVrfSubObjectParameterList &  attachedObjects)
virtual
virtual DtVrfObjectSubComponentTypes* DtVrfObjectParameters::localSubComponentTypes ( ) const
virtual

Get local sub-component types. This is the set of type strings indicating the kinds objects that a DtSimObject should contain (i.e. the type of sim state repository, type of network interface), when the DtSimObject is locally simulated.

virtual DtVrfObjectSubComponentTypes* DtVrfObjectParameters::remoteSubComponentTypes ( ) const
virtual

Get remote sub-component types. This is the set of type strings indicating the kinds objects that a DtSimObject should contain (i.e. the type of sim state repository, type of network interface), when the DtSimObject is simulated remotely.

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

putData writes our type, which is provided by the virtual type accessor of the deriving class.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtVrfObjectParameters::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  variableBindings 
)
virtual

getData is just used to get us past the type in the data stream, since it's not actual stored.

Reimplemented from DtReaderWriter.

virtual const Dt3dBoundingVolume* DtVrfObjectParameters::boundingVolume ( ) const
virtual

Set/get the bounding volume of the object.

Referenced by DtVrfObjectStateRepositoryRWData::initializeFromParameters().

virtual void DtVrfObjectParameters::setBoundingVolume ( const Dt3dBoundingVolume &  newBoundingVolume)
virtual

Set the bounding volume of the object.

virtual void DtVrfObjectParameters::setBoundingVolume ( const DtVector &  localBvolDiagonal,
const DtVector &  offset = DtVector::zero() 
)
virtual

Set the bounding volume from its components. This is not the preferred form, but is included for completeness.

Note
When possible, use the version which takes an entire Dt3dBoundingVolume as the parameter to protect against future changes in the bounding volume class.
virtual DtSimBoundingGeometry::DtSimBoundingGeometryType DtVrfObjectParameters::boundingGeometryType ( ) const
virtual

Set/get the bounding geometry type of the object.

Referenced by DtVrfObjectStateRepositoryRWData::initializeFromParameters().

virtual void DtVrfObjectParameters::setBoundingGeometryType ( DtSimBoundingGeometry::DtSimBoundingGeometryType  type)
virtual
virtual double DtVrfObjectParameters::draft ( ) const
virtual

For convenience– computes the draft from bounding volume. Draft is the distance of the bottom of the bounding box below the origin.

virtual DtAggregateFormation DtVrfObjectParameters::formation ( ) const
virtual

Accessor/mutator for myFormationType.

virtual void DtVrfObjectParameters::setFormation ( DtAggregateFormation  formation)
virtual
virtual DtU32 DtVrfObjectParameters::appearance ( ) const
virtual

Accessor/mutator for myDefaultAppearance.

virtual void DtVrfObjectParameters::setAppearance ( const DtU32  appearance)
virtual
virtual bool DtVrfObjectParameters::appearanceSpecified ( ) const
virtual
virtual const DtString& DtVrfObjectParameters::displayName ( ) const
virtual

Accessor/mutator for myDisplayName.

virtual void DtVrfObjectParameters::setDisplayName ( const DtString &  s)
virtual
virtual const DtEntityType& DtVrfObjectParameters::defaultEntityType ( ) const
virtual

Accessor/mutator for myDefaultEntityType.

virtual void DtVrfObjectParameters::setDefaultEntityType ( const DtEntityType &  s)
virtual
virtual const DtString& DtVrfObjectParameters::displayDescription ( ) const
virtual

Accessor/mutator for myDisplayDescription.

virtual void DtVrfObjectParameters::setDisplayDescription ( const DtString &  s)
virtual
virtual const DtString& DtVrfObjectParameters::engagementRules ( ) const
virtual

Accessor/mutator for myEngagementRules.

Referenced by DtVrfObjectStateRepositoryRWData::initializeFromParameters().

virtual void DtVrfObjectParameters::setEngagementRules ( const DtString &  engagementRules)
virtual
virtual const DtSimResourceManager& DtVrfObjectParameters::resourceManager ( ) const
virtual

Accessor/mutator for myResourceManager.

virtual void DtVrfObjectParameters::setResourceManager ( const DtSimResourceManager &  resourceManager)
virtual
virtual void DtVrfObjectParameters::setStateRepositoryUserExtensionType ( const DtString &  type)
virtual

Accessor/mutator for myStateRepositoryUserExtensionType.

virtual const DtString& DtVrfObjectParameters::stateRepositoryUserExtensionType ( ) const
virtual
virtual DtObjectType DtVrfObjectParameters::objectType ( ) const
virtual

Accessor/mutator for myObjectType.

virtual void DtVrfObjectParameters::setObjectType ( const DtObjectType &  objectType)
virtual
virtual DtObjectType DtVrfObjectParameters::matchType ( ) const
virtual

Accessor/mutator for myMatchType.

virtual void DtVrfObjectParameters::setMatchType ( const DtObjectType &  objectType)
virtual
virtual bool DtVrfObjectParameters::taskedBySuperiorUponTaskComplete ( ) const
virtual

Flag indicating whether or not entity should always go into a 'tasked by superior' state upon completion of a top-level task (a non-subtask task). By default, this is set to true, so a subordinate will be immediately able to participate as part of an aggregate when it completes an independent task. The name of the parameter is 'tasked-by-superior-upon-task-complete'.

virtual void DtVrfObjectParameters::setTaskedBySuperiorUponTaskComplete ( bool  trueOrFalse)
virtual
virtual void DtVrfObjectParameters::setRangeRingPublisherTickTime ( double  )
virtual

Tick time for range ring publisher in simulation seconds. Default is -1 (as fast as possible)

virtual double DtVrfObjectParameters::rangeRingPublisherTickTime ( ) const
virtual
static DtVrfObjectParameters* DtVrfObjectParameters::createParameters ( DtlObjPtr  mtlStream,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  variableBindings,
DtEnvironmentSP  env = DtEnvironmentSP(),
DtEnvValueSP *  objectNode = NULL 
)
static
static DtVrfObjectParameters* DtVrfObjectParameters::createParameters ( const char *  name,
DtEnvironmentSP  env = DtEnvironmentSP(),
DtEnvValueSP *  objectNode = NULL 
)
static
static DtVrfObjectParameterFactory* DtVrfObjectParameters::factory ( )
static
static void DtVrfObjectParameters::setFactory ( DtVrfObjectParameterFactory *  factory)
static
static void DtVrfObjectParameters::addParameterCreatorFcn ( const DtString &  type,
DtSimObjectParametersCreatorFcn  fcn 
)
static
static DtVrfObjectParameters* DtVrfObjectParameters::creator ( DtEnvironmentSP  env,
DtEnvValueSP *  objectNode 
)
static

Returns
Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.
void DtVrfObjectParameters::setParameterType ( const DtString &  t)
inline

Sets/gets type of parameter.

References myParameterType.

const DtString & DtVrfObjectParameters::parameterType ( ) const
inline

References myParameterType.

virtual void DtVrfObjectParameters::setStateRepositoryUserExtension ( const DtVrfStateRepositoryUserExtension &  userExtension)
virtual

State repository user extension data (extensible at the base class DtVrfObjectStateRepository).

virtual DtVrfStateRepositoryUserExtension* DtVrfObjectParameters::stateRepositoryUserExtension ( ) const
virtual
virtual void DtVrfObjectParameters::getSelf ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(),
const DtVariableBindingsList &  variableBindings = nullVariableReference() 
)
virtual

Override so we can figure out what kind of DtVrfStateRepositoryUserExtension to instantiate before calling down to base class version to actually load the parameters.

Reimplemented from DtReaderWriter.

Reimplemented in DtGroundVehicleParameters.

virtual DtTime DtVrfObjectParameters::underFireTime ( ) const
virtual
Deprecated:
For backwards compatibility only. This value should be specified in the damage actuator's descriptor.
virtual void DtVrfObjectParameters::setUnderFireTime ( DtTime  time)
virtual
Deprecated:
For backwards compatibility only. This value should be specified in the damage actuator's descriptor.
virtual bool DtVrfObjectParameters::underFireTimeSpecified ( ) const
virtual
Deprecated:
For backwards compatibility only. This function allows the damage actuator to know if myUnderFireTime should override the value in its descriptor.
virtual DtReal DtVrfObjectParameters::underFireDistance ( ) const
virtual
Deprecated:
For backwards compatibility only. This value should be specified in the damage actuator's descriptor.
virtual void DtVrfObjectParameters::setUnderFireDistance ( DtReal  underFireDistance)
virtual
Deprecated:
For backwards compatibility only. This value should be specified in the damage actuator's descriptor.
virtual bool DtVrfObjectParameters::underFireDistanceSpecified ( ) const
virtual
Deprecated:
For backwards compatibility only. This function allows the damage actuator to know if myUnderFireDistance should override the value in its descriptor.
virtual const DtSimSector& DtVrfObjectParameters::initialSectorOfResponsibility ( ) const
virtual
See Also
myInitialSectorOfResponsibility
virtual void DtVrfObjectParameters::setInitialSectorOfResponsibility ( const DtSimSector &  sor)
virtual
See Also
myInitialSectorOfResponsibility
virtual DtTaskExecutionRules& DtVrfObjectParameters::taskExecutionRules ( )
virtual
See Also
myTaskExecutionRules
virtual const DtTaskExecutionRules& DtVrfObjectParameters::taskExecutionRules ( ) const
virtual
See Also
myTaskExecutionRules
virtual void DtVrfObjectParameters::setTaskExecutionRulesFilename ( const DtFilename &  )
virtual
See Also
myTaskExecutionRulesFilename
virtual const DtReaderWriterFile& DtVrfObjectParameters::taskExecutionRulesFilename ( ) const
virtual
See Also
myTaskExecutionRulesFilename
virtual void DtVrfObjectParameters::setHlaFomClass ( const DtString &  )
virtual
See Also
myHlaFomClass
virtual const DtString& DtVrfObjectParameters::hlaFomClass ( ) const
virtual
See Also
myHlaFomClass
virtual void DtVrfObjectParameters::setArtPartList ( const DtSimArtPartDescriptorList &  partList)
virtual
See Also
myArtPartList.
virtual const DtSimArtPartDescriptorList& DtVrfObjectParameters::artPartList ( ) const
virtual
See Also
myArtPartList.
virtual const DtAutoConnectionsListPtr& DtVrfObjectParameters::autoConnections ( ) const
virtual
Returns
The list of auto connections
virtual DtAutoConnectionsListPtr& DtVrfObjectParameters::autoConnections ( )
virtual
virtual const std::list<DtSimArtPartDescriptor*>* DtVrfObjectParameters::configuredArtPartList ( ) const
virtual
Returns
A list containing all the DtSimArtPartDescriptor instances for configured on this entity. These are art parts that a user has specifically added or modified for this entity type.
virtual const std::list<DtSimArtPartDescriptor*>* DtVrfObjectParameters::componentDefaultArtPartList ( ) const
virtual
Returns
A list containing all the DtSimArtPartDescriptor instances for added by actuators on this entity. These are art parts that a user has specifically added or modified for this entity type.
virtual void DtVrfObjectParameters::connectSystems ( )
virtual

Creates entity-level connections between systems based on sysdef metadata.

bool DtVrfObjectParameters::operator== ( const DtVrfObjectParameters &  ) const

Equality operator. Simply compares the contents of the registry.

bool DtVrfObjectParameters::operator!= ( const DtVrfObjectParameters &  ) const
virtual DtEnvironmentSP DtVrfObjectParameters::xmlEnvironment ( )
virtual
virtual DtEnvValueSP DtVrfObjectParameters::objectNode ( )
virtual
virtual const DtReaderWriter* DtVrfObjectParameters::findVariableBinding ( const DtString &  ) const
virtual

Find a variable binding from the original items in getSelf. Only valid if getSelf was called for this object.

virtual const DtVariableBindingsList& DtVrfObjectParameters::variableBindingsFromLoad ( ) const
virtual
Returns
The variable bindings that were used when this parameter object was loaded. Useful for cases where a sub-file is being loaded at a later point based on the contents of this parameters object.
virtual DtReaderWriterRegistryData* DtVrfObjectParameters::findProperty ( const DtString &  rwName) const
virtual

Returns a property value as defined in the registry (first look) or the additional parameter data (second look)

virtual const DtRwProperties& DtVrfObjectParameters::parameterData ( ) const
virtual

Return parameter data accessor.

virtual DtRwProperties& DtVrfObjectParameters::parameterData ( )
virtual
virtual const DtRwProperties& DtVrfObjectParameters::stateData ( ) const
virtual

Return state data.

virtual DtRwProperties& DtVrfObjectParameters::stateData ( )
virtual
virtual void DtVrfObjectParameters::setPublishParameterData ( bool  )
virtual

Set to true if the parameter data is to be published in the extended data portion of the object. If true each item will be published as the NAME of the parameter with the receiver expecting to know what the type of the object is to decode. Default is false.

virtual bool DtVrfObjectParameters::publishParameterData ( ) const
virtual
virtual void DtVrfObjectParameters::setDisplayObjectImage ( int  )
virtual

See myDisplayObjectImage {.

virtual int DtVrfObjectParameters::displayObjectImage ( ) const
virtual
virtual void DtVrfObjectParameters::setUiFilename ( const DtString &  uiFilename)
virtual

}

virtual DtString DtVrfObjectParameters::uiFilename ( ) const
virtual
virtual void DtVrfObjectParameters::setCanCreateAsNew ( bool  )
virtual
virtual bool DtVrfObjectParameters::canCreateAsNew ( ) const
virtual
virtual void DtVrfObjectParameters::setCanMoveOntoEmbarked ( bool  )
virtual

Whether or not this object can be embarked on by checking as to whether or not and entity is moving near it and intersects it at a test location. This flag is set as a hint to the back-end to not test every object near an entity. Default is false.

virtual bool DtVrfObjectParameters::canMoveOntoEmbarked ( const DtEntityType &  = DtObjectType()) const
virtual
virtual void DtVrfObjectParameters::setSameObjectTypeCanAutoEmbark ( bool  )
virtual
virtual bool DtVrfObjectParameters::sameObjectTypeCanAutoEmbark ( ) const
virtual
virtual const DtRwEntityTypes& DtVrfObjectParameters::canMoveOntoEmbarkedTypes ( ) const
virtual
virtual void DtVrfObjectParameters::setCanMoveOntoEmbarkedTypes ( const DtRwEntityTypes &  )
virtual
virtual void DtVrfObjectParameters::rebuildArtPartList ( )
virtual

Clears out and rebuilds the articulated part list. Should be called after any point in which the art parts may have changed.

virtual void DtVrfObjectParameters::updatePartOverridesFromActuator ( DtSimArtPartDescriptor &  artPartDescriptor,
const DtComponentDescriptor &  actuatorDescriptor,
const DtString &  systemName = DtString::nullString() 
)
virtual

Some older actuator descriptors may contain settings that override the art part settings. This function updates those settings.

virtual DtVrfSubObjectParameterList* DtVrfObjectParameters::createSubordinateObjectsList ( const DtSymbolString &  name,
DtReaderWriterRegistry *  parentRegistry 
) const
protectedvirtual

Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot mySubordinateObjects in init(). Override this function if you want to create a derived type. Name is the DtReaderWriter name of the object (the name will appear as the first string in the object when this object is written out to file).

virtual DtVrfSubObjectParameterList* DtVrfObjectParameters::createAttachedObjectsList ( const DtSymbolString &  name,
DtReaderWriterRegistry *  parentRegistry 
) const
protectedvirtual

Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot myAttachedObjects in init(). Override this function if you want to create a derived type. Name is the DtReaderWriter name of the object (the name will appear as the first string in the object when this object is written out to file).

virtual void DtVrfObjectParameters::addArtPartsFromSystem ( DtComponentSystemDescriptor *  systemDesc,
std::list< DtSimArtPartDescriptor * > &  artPartList 
)
protectedvirtual

Adds any art parts defined within a system to the list. Recurses if the system contains other systems. Utility function used by rebuildArtPartList().

virtual void DtVrfObjectParameters::createAutomaticConnections ( DtRwAutoConnection *  autoConnection)
protectedvirtual
virtual void DtVrfObjectParameters::addArtPartDescriptorProcessor ( const DtString &  componentType,
const ArtPartDescriptorProcessor &  fcn 
)
protectedvirtual

Adds a special function for processing additional art part information from a component descriptor.

static void DtVrfObjectParameters::artPartWeaponDescriptorProcessor ( const DtComponentDescriptor &  compDesc,
DtSimArtPartDescriptor &  artPartDesc 
)
staticprotected
static void DtVrfObjectParameters::artPartHumanGunDescriptorProcessor ( const DtComponentDescriptor &  compDesc,
DtSimArtPartDescriptor &  artPartDesc 
)
staticprotected
static void DtVrfObjectParameters::artPartBallisticGunDescriptorProcessor ( const DtComponentDescriptor &  compDesc,
DtSimArtPartDescriptor &  artPartDesc 
)
staticprotected
static void DtVrfObjectParameters::artPartAzimuthMountDescriptorProcessor ( const DtComponentDescriptor &  compDesc,
DtSimArtPartDescriptor &  artPartDesc 
)
staticprotected
static void DtVrfObjectParameters::artPartElevationMountDescriptorProcessor ( const DtComponentDescriptor &  compDesc,
DtSimArtPartDescriptor &  artPartDesc 
)
staticprotected
static void DtVrfObjectParameters::artPartTurretDescriptorProcessor ( const DtComponentDescriptor &  compDesc,
DtSimArtPartDescriptor &  artPartDesc 
)
staticprotected
static void DtVrfObjectParameters::artPartSensorGimbalDescriptorProcessor ( const DtComponentDescriptor &  compDesc,
DtSimArtPartDescriptor &  artPartDesc 
)
staticprotected
static void DtVrfObjectParameters::artPartSwingingPartDescriptorProcessor ( const DtComponentDescriptor &  compDesc,
DtSimArtPartDescriptor &  artPartDesc 
)
staticprotected
static void DtVrfObjectParameters::artPartTranslatablePartDescriptorProcessor ( const DtComponentDescriptor &  compDesc,
DtSimArtPartDescriptor &  artPartDesc 
)
staticprotected
virtual void DtVrfObjectParameters::addStateDataFromComponents ( )
protectedvirtual
virtual void DtVrfObjectParameters::addStateDataFromSystem ( const DtComponentSystemDescriptor *  systemDesc)
protectedvirtual
virtual void DtVrfObjectParameters::addStateDataFromComponent ( const DtComponentDescriptor *  systemDesc)
protectedvirtual

Member Data Documentation

DtObjectType DtVrfObjectParameters::myMatchType
protected

An extended form of the DIS/RPR FOM entity enumerated type. Specifies the key used to look up the entry. VR-Forces adds a field to the DIS/RPR FOM entity enumeration so that we can manage objects that are not part of the DIS/RPR enumeration scheme, such as aggregate entities and control objects. We enclose the seven-digit DIS/RPR FOM enumeration in parentheses and preface it with the object super-type.
<super type>=""> (<DIS rpr="" fom="" enumerated="" type>="">)
For example, an M1A2 has the following object type:
1 (1 1 225 1 1 3 0)
.

See Also
objTypeEnums.h for the list of available super-type values.
For more information about the entity enumeration scheme, see the DIS Enumeration Document (Enumeration and Bit Encoded Values for Use with Protocols for DIS Applications).
DtObjectType DtVrfObjectParameters::myObjectType
protected
DtRwBoundingGeometryType DtVrfObjectParameters::myBoundingGeometryType
protected

Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object). The value specified affects how the bounding-volume parameter gets interpreted in the code. Values may be:

.

  • Undefined: No bounding geometry information is indicated.
  • Area: Only the first 2 rows and columns of a 3x3 matrix used to represent the geometry are used to define the area. Used for 2 dimensional objects such as control areas.
  • Volume: A complete 3x3 matrix is used to represent a 3 dimensional bounding box containing the object.
DtRwBoundingVolume DtVrfObjectParameters::myBvol
protected

Parameter Name: bounding-volume Parameter Description: Specifies the bounding volume around an object. It has the following sub-parameters:

  • local-bvol: half-length, half-width, and half-height of the entity (3 real numbers)
  • offset: Body coordinate x, y, z offset from entity position
    Note
    body coordinates is x forward, y right, z down)
    bounding-volume is an optional parameter. However, if you specify it, you must specify both local-bvol and offset. Parameter Default Value: local-bvol: <1.0, 1.0, 1.0> offset: <0.0, 0.0, 0.0>
DtVrfObjectSubComponentTypes* DtVrfObjectParameters::myLocalSubComponentTypes
protected

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.

DtVrfObjectSubComponentTypes* DtVrfObjectParameters::myRemoteSubComponentTypes
protected

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.

DtRwFormationType DtVrfObjectParameters::myFormationType
protected

Parameter Name: formation
Parameter Description: (Optional) One of the following:

  • Column
  • Line
  • Vee
  • Wedge
  • Assembly
  • Other
  • UserFormation<n> where n is a digit from 1 to 255 Parameter Default Value: Other
DtRwAppearance DtVrfObjectParameters::myDefaultAppearance
protected

Parameter Name: default-appearance
Parameter Description: Unsigned int used to set default valus for the DIS/RPR appearance bits.

DtRwForceType DtVrfObjectParameters::myForceType
protected

Parameter Name: force-type Parameter Description: The force to which the object belongs. One of the following:

  • ForceOther
  • ForceNeutral
  • ForceFriendly
  • ForceOpposing
  • ForceUserDefinedn, where n is a digit from 1 to 255.
    Note
    This parameter is not currently used. Parameter Default Value: ForceOther.
DtRwString DtVrfObjectParameters::myCategory
protected

Parameter Name: category Parameter Description: The category string to use when creating an echelon ID. The string category item is used to to describe an entity, e.g. "Armor" Bn, or "M1A1" platform. Parameter Default: "c?" Parameter Units: string.

DtRwString DtVrfObjectParameters::myEchelonLevel
protected

Parameter Name: echelon-level Parameter Description: The echelon level to use for this entity when creating an echelon ID. his is a string indicating the echelon level of a military entity, e.g. "platform" or "Bde". Parameter Default: "e?" Parameter Units: string.

DtRwBoolean DtVrfObjectParameters::myOrganized
protected

Parameter Name: is-organized Parameter Description: Specifies that the entity is part of the entity hierarchy and requires an echelon ID. If organized it true, this object type will have an entry in the organization hierarchy. Parameter Default Value: False.

DtRwReal DtVrfObjectParameters::myMinTickPeriod
protected

Parameter Name: min-tick-period Parameter Description: Specifies the shortest period of time, in seconds, that can elapse between ticks of an entity's components. Parameter Default Value: 0. Parameter Units: seconds.

DtRwReal DtVrfObjectParameters::myMinTickPeriodVariance
protected

Parameter Name: min-tick-period-variance Parameter Description: Specifies an amount within which the min-tick-period can vary. Defined as: plus or minus rand(min-tick-period/2). Parameter Default Value: 0. Parameter Units: seconds.

DtRwDeadReckonTypes DtVrfObjectParameters::myDeadReckoningAlgorithm
protected

Parameter Name: dr-algorithm Parameter Description: The VR-Link dead-reckoning algorithm to use when publishing this entity. See the IEEE Standard for Distributed Interactive Simulation – Application Protocols for more information on the meaning of these different algorithms. One of:

  • Other: Fvw
  • Static: Fpb
  • Fpw: Rpb
  • Rpw: Rvb
  • Rvw: Fvb. Parameter Default Value: Fpw
DtRwNavigationParameters DtVrfObjectParameters::myNavigationParameters
protected

Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object). The value specified affects how the bounding-volume parameter gets interpreted in the code. Values may be:

.

  • Undefined: No bounding geometry information is indicated.
  • Area: Only the first 2 rows and columns of a 3x3 matrix used to represent the geometry are used to define the area. Used for 2 dimensional objects such as control areas.
  • Volume: A complete 3x3 matrix is used to represent a 3 dimensional bounding box containing the object.
DtRwDeadReckonThresholds DtVrfObjectParameters::myDeadReckoningThresholds
protected

Parameter Name: dr-thresholds Parameter Description: The translation, rotation, and aggregate dimension thresholds used when publishing this entity. Parameter Default Value: 1.0, 3.0, 0.05 (translation, rotation, aggregate-dimension) Parameter Units: meters (translation), degrees (rotation), unitless (aggregate dimension – value between 0 and 1 representing percentage change in extent)

DtRwBoolean DtVrfObjectParameters::myDeadReckoningAllowGuiOverrides
protected

Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object). The value specified affects how the bounding-volume parameter gets interpreted in the code. Values may be:

.

  • Undefined: No bounding geometry information is indicated.
  • Area: Only the first 2 rows and columns of a 3x3 matrix used to represent the geometry are used to define the area. Used for 2 dimensional objects such as control areas.
  • Volume: A complete 3x3 matrix is used to represent a 3 dimensional bounding box containing the object.
DtRadioDescriptorList DtVrfObjectParameters::myRadioDescriptorList
protected

Parameter Name: radios Parameter Description: List of all radios on the entity.

DtComponentSystemDescriptorList DtVrfObjectParameters::mySystemDescriptorList
protected

Parameter Name: systems Parameter Description: List of system descriptors. Systems are collections of sensors/controllers/actors to be added as a group to the entity.

DtComponentDescriptorList DtVrfObjectParameters::mySensorDescriptorList
protected

Parameter Name: sensors Parameter Description: List of sensor controller component descriptors.

DtComponentDescriptorList DtVrfObjectParameters::myControllerDescriptorList
protected

Parameter Name: controllers Parameter Description: List of controller component descriptors.

DtComponentDescriptorList DtVrfObjectParameters::myActuatorDescriptorList
protected

Parameter Name: actuators Parameter Description: List of actuator component descriptors.

DtConnectionDescriptorList DtVrfObjectParameters::myConnectionDescriptorList
protected

Parameter Name: connections Parameter Description: The connections (Example 5.2, line 19) entry specifies how the components connect to one another (through ports, port groups, or both). Components attach to each other by connecting output and input ports to one another, or output port groups to input port groups. Since a component can have more than one port, port group, or both, the name of the port or port group to use is also specified. If an entity does not have any components that need to connect to one another, then you can omit this entry. Items in the connections entry can be in one of the following forms:

  • Specify a port-to-port connection: connect component_name:output_port component_name:input_port
  • Specify a port group-to-port group connection: connect component_name:output_port_group component_name:input_port_group The connections in Example 5.2 use this format.
  • Specify a port-to-port connection, in which one or both of the ports exists inside of a group, as follows: The input port belongs to an input port group: connect component_name:output_port component_name:input_port_group:input_port The output port belongs to an output port group: connect component_name:output_port group:output_port component_name:input_port Both input and output ports belong to groups: connect component_name:output_port_group:output_port component_name:input_port_group:input_port The port and port group names are defined in code for each component.
DtRwReal DtVrfObjectParameters::myMass
protected

Parameter Name: mass Parameter Description: The mass of the entity. Parameter Default Value: 5000. Parameter Units: kilograms.

DtRwSensorSignatureList DtVrfObjectParameters::mySensorSignatureList
protected

Parameter Name: sensor-signatures Parameter Description: Parameter Default Value:

DtVrfSubObjectParameterList* DtVrfObjectParameters::mySubordinateObjects
protected

Parameter Name: subordinate-objects
Parameter Description: (Optional) List of entries specifying subordinate objects to be created as part of an aggregate object. Each entry specifies a subobject to be created when fully instantiating an aggregate object (as opposed to building such an entity from the bottom up, using aggregateAs). The entry contains an object type, a position offset, and a heading offset (offsets with respect to the parent objects position and heading). Each entry has the following parameters:

  • object-type: (Required) Object type of the subordinate to be created. Object type is an extension of the DIS/RPR enumeration.
  • position-offset: (Optional) Position offset of subordinate object in body coordinates of the aggregate object at creation time, in meters. Default: < 0.0 0.0 0.0 > (3 real numbers)
  • heading-offset: (Optional) Heading offset of the subordinate object with respect to the aggregate's heading at creation time, in radians. Default: 0.0 (real number)
    Example subordinate-objects entry:
    (subordinate-objects
    (sub1
    (object-type 1 (1 1 225 1 1 3 -1))
    (position-offset -20.00000 0.000000 0.00000)
    (heading-offset -0.78)
    )
    (sub2
    (object-type 1 (1 1 225 1 1 3 -1))
    (position-offset -20.00000 8.000000 0.00000)
    (heading-offset 0.78)
    )
    )
DtVrfSubObjectParameterList* DtVrfObjectParameters::myAttachedObjects
protected

Parameter Name: attached-objects
Parameter Description:
Parameter Default Value:
.

DtRwString DtVrfObjectParameters::myEngagementRules
protected

Parameter Name: engagement-rules Parameter Description: (Optional) The engagement rules the entity will use unless/until changed by a set engagement rules message. Applies to aggregate entities also. Options:

  • "hold-fire"
  • "fire-when-fired-upon"
  • "fire-at-will" Parameter Default: "fire-at-will"
DtSimResourceManager DtVrfObjectParameters::myResourceManager
protected

Parameter Name: resources Parameter Description: Specifies the types and amount of resources the entity has. The resources parameter has a list of resource parameters whose name is the name of the resource, and which has the following format:

  • resource-type - Currently "integer-resource" or "real-resource" (string)
  • full-amount - Specifies what is considered a full load of this resource. (integer or real, based on resource type.)
  • amount - The amount of the specified resource available. (integer or real, based on resource type.)
  • subresources - Just like a resource; name is the name of the subresource, and all other resource parameters are available.
    Note
    There are no default values for resources. If a resource is expected (such as fuel), and it is not specified, then consumption of that resource is not modeled.
DtRwString DtVrfObjectParameters::myStateRepositoryUserExtensionType
protected

Parameter Name: state-repository-extension-type
Parameter Description: Type of state repository extensions class to instantiate. Users may define derived DtVrfStateRepositoryUserExtension types and register them with the DtVrfStateRepositoryUserExtensionFactory. This is the unique string value that gets registered with that factory.
Parameter Default Value:
.

DtRwBoolean DtVrfObjectParameters::myTaskedBySuperiorUponTaskComplete
protected

Parameter Name: tasked-by-superior-upon-task-complete
Parameter Description: Flag indicating whether or not subordinates should automatically resume a tasked-by-superior status upon completing an independent task.
Parameter Default Value: True
.

DtVrfStateRepositoryUserExtension* DtVrfObjectParameters::myStateRepositoryUserExtension
protected

Parameter Name: user-extension
Parameter Description: Extension to the state repository class. Users may define derived types to extend all state repository objects at the base class level. parameters to
Parameter Default Value:
.

DtRwTime DtVrfObjectParameters::myUnderFireTime
protected

Parameter Name: under-fire-time
Parameter Description: Deprecated. This concept is now modeled in the DtUnderFireDeterminationComponentDescriptor.
Parameter Default Value:
.

DtRwReal DtVrfObjectParameters::myUnderFireDistance
protected

Parameter Name: under-fire-distance
Parameter Description: Deprecated. This concept is now modeled in the DtUnderFireDeterminationComponentDescriptor.
Parameter Default Value:
.

DtSimSector DtVrfObjectParameters::myInitialSectorOfResponsibility
protected

Parameter Name: initial-sector-of-responsibility
Parameter Description: The sector of responsibility for this entity when the entity is first created. This value will be replaced by any Set Sector Of Responsibility commands issued to the entity. Specified as Center and Size angles. Parameter Units: Radians (0 = north). Parameter Default Value: Center 0, Size pi / 2
.

DtReaderWriterFile DtVrfObjectParameters::myTaskExecutionRulesFilename
protected

Parameter Name: task-execution-rules Parameter Description: The name of the file that contains the task execution rules for this entity. These rules are used to determine what tasks can be executed concurrently, and what tasks will interrupt other tasks on the entity. Parameter Default Value: None.

DtTaskExecutionRules DtVrfObjectParameters::myTaskExecutionRules
protected

Task execution rules. This is the structure that is read in from the file pointed to by myTaskExecutionRulesFilename;.

DtString DtVrfObjectParameters::myParameterType
protected

String that keeps the type of parameter this is Local only – not part of descriptor.

Referenced by parameterType(), and setParameterType().

DtVrfObjectParameterFactory* DtVrfObjectParameters::theFactory
staticprotected
std::list<DtSimArtPartDescriptor*> DtVrfObjectParameters::myConfiguredArtPartList
protected

A list containing all the art part descriptors for parts that will be available to the entity.

std::list<DtSimArtPartDescriptor*> DtVrfObjectParameters::myComponentDefaultArtPartList
protected

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.

DtEnvValueSP DtVrfObjectParameters::myObjectNode
protected
DtEnvironmentSP DtVrfObjectParameters::myEnvironment
protected
DtAutoConnectionsListPtr DtVrfObjectParameters::myAutoConnections
protected
DtRwProperties DtVrfObjectParameters::myParameterData
protected

Properties that are specific to this parameter as read from the OPE file. These properties cannot be changed from their original value.

DtRwProperties DtVrfObjectParameters::myStateData
protected

Properties that will be added to the state repository of this particular entity. These values can be modified via the state repository.

DtRwReal DtVrfObjectParameters::myRangeRingPublisherTickTime
protected

The tick time of the range ring "publisher" for range ring parameter and state data. Default is -1 (as fast as possible) Value is in seconds of simulation time.

DtRwBoolean DtVrfObjectParameters::myPublishParameterData
protected

Parameter Name: publish-parameter-data Parameter Description: Set to true to publish the parameter data in the extended object data under the parameters name. The receiver of this data must know what the type being encoded is in order to successfully decode Parameter Default Value: False.

DtRwBoolean DtVrfObjectParameters::myIlluminationRecalcTime
protected

Parameter Name: illumination-recalc-time
Parameter Description: Amount of time (in seconds) to recalculate entity illumination value based on location and time of day Parameter Units: Parameter Default Value: 3000 (5 minutes)

DtRwString DtVrfObjectParameters::myDisplayName
protected

Parameter Name: display-name
Parameter Description: Name to display to user in Simulation Object Editor Parameter Units: Parameter Default Value:

DtRwString DtVrfObjectParameters::myDisplayDescription
protected

Parameter Name: display-description
Parameter Description: Description of parameter to display in Simulation Object Editor Parameter Units: Parameter Default Value:

DtRwString DtVrfObjectParameters::myUiFilename
protected

Parameter Name: ui-filename
Parameter Description: name of the .ui file used to configure this entity in the Simulation Object Editor. Does not include the file path. Parameter Units: Parameter Default Value:

DtRwBoolean DtVrfObjectParameters::myCanCreateAsNew
protected

Parameter Name: can-create-as-new
Parameter Description: Only for Simulation Object Editor. Whether or not this parameter can be used to create a new entity Parameter Units: Parameter Default Value: True.

DtRwBoolean DtVrfObjectParameters::myCanMoveOntoEmbarked
protected

Parameter Name: can-move-onto-embarked
Parameter Description: Whether or not this object can be embarked on by checking as to whether or not and entity is moving near it and intersects it at a test location. This flag is set as a hint to the back-end to not test every object near an entity. Parameter Units: Parameter Default Value: False.

DtRwBoolean DtVrfObjectParameters::mySameObjectTypeCanAutoEmbark
protected

Parameter Name: same-object-type-can-auto-embark
Parameter Description: Whether or not the same object type as this object can auto embark on this object. Parameter Units: Parameter Default Value: False.

DtRwEntityTypes DtVrfObjectParameters::myCanMoveOntoEmbarkedTypes
protected

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.

DtRwString DtVrfObjectParameters::myHlaFomClass
protected

Parameter Name: hla-fom-class Parameter Description: Specifies the HLA FOM class to be published. If not set, the VR-Link FOM Mapper will choose the published class Parameter Default: "".

DtRwEntityType DtVrfObjectParameters::myDefaultEntityType
protected

Parameter Name: display-entity-type
Parameter Description: Default entity type for platform to use in Simulation Object Editor Parameter Units: Parameter Default Value:

DtRwVisualMetaData DtVrfObjectParameters::myVisualMetaData
protected

Parameter Name: visual-meta-data
Parameter Description: If defined how the visual meta data will initially be set when this object is created Parameter Units: Parameter Default Value:

DtSimArtPartDescriptorList DtVrfObjectParameters::myArtPartList
protected

Parameter Name: art-parts
Parameter Description: List of configured articulated parts on this type of entity. Will be added to the list loaded from the model. Parameter Units: Parameter Default Value: empty.

DtRwString DtVrfObjectParameters::myMainComponent
protected

Parameter Name: main-component
Parameter Description: The component that is considered the root (main) component that will be published onto the network (DtEntityStateComponentCreator, DtEnvironmentalStateComponentCreator, DtAggregateStateComponentCreator, for example) Parameter Default Value: None
.

DtRwNLengthStringVector DtVrfObjectParameters::myPublicData
protected

Parameter Name: public-data
Parameter Description: List of public data that is supported by this component beyond the default public data added Parameter Default Value: None
.

DtRwInt DtVrfObjectParameters::myDisplayObjectImage
protected

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)
.

DtVariableBindingsList DtVrfObjectParameters::myGetSelfVariableBindings
protected

Local copy of variable bindings used to seed this parameter entry.

ArtPartDescProcMap DtVrfObjectParameters::myArtPartDescProcs
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)