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

DtIndirectFireControllerDescriptor; descriptor for the DtIndirectFireController compenent.

DtIndirectFireControllerDescriptor is a DtBaseWeaponControllerDescriptor that has additional information needed for providing parameters to an indirectFire controller.

In contains a list of the ammos to use, in order of availability, if no ammo is specified in a FFE task; a minimum fire range; and a maximum fire range.

Inheritance diagram for DtIndirectFireControllerDescriptor:
Inheritance graph
[legend]

Public Member Functions

 DtIndirectFireControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=nullptr)
 
 DtIndirectFireControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=nullptr)
 
 DtIndirectFireControllerDescriptor (const DtIndirectFireControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=nullptr)
 
DtIndirectFireControllerDescriptoroperator= (const DtIndirectFireControllerDescriptor &orig)
 
virtual ~DtIndirectFireControllerDescriptor ()
 
virtual DtString type () const override
 
virtual const
DtRwNLengthStringVector
customFireTasks () const
 
virtual DtRwNLengthStringVectorcustomFireTasks ()
 
virtual const DtRwPropertiesweaponProperties () const
 
virtual DtRwPropertiesweaponProperties ()
 
virtual DtComponentDescriptorclone (DtReaderWriterRegistry *parentRegistry=nullptr) const override
 
virtual void postGetSelf () override
 
virtual const DtStringweaponName () const
 
virtual void setWeaponName (const DtString &name)
 
virtual const DtRwStringListdefaultAmmoList () const
 
virtual void setDefaultAmmoList (const DtRwStringList &list)
 
virtual int numRoundsPerMission () const
 
virtual void setNumRoundsPerMission (int numRoundsPerMission)
 
virtual bool enforceRangeLimits () const
 
virtual void setEnforceRangeLimits (bool limit)
 
virtual bool allowVelocityVariation () const
 
virtual void setAllowVelocityVariation (bool allow)
 
virtual const DtNLengthRealVectormuzzleSpeedList () const
 
virtual void setMuzzleSpeedList (const DtNLengthRealVector &muzzleSpeeds)
 
virtual const DtStringrangeName () const
 
virtual void setRangeName (const DtString &rangeName)
 
virtual int rangeId () const
 
virtual void setRangeId (int rangeId)
 
virtual bool rangeIdIsSpecified () const
 
virtual DtReal minRange () const
 
virtual void setMinRange (DtReal minRange)
 
virtual DtReal maxRange () const
 
virtual void setMaxRange (DtReal maxRange)
 
virtual DtReal minAltitude () const
 
virtual void setMinAltitude (DtReal minAlt)
 
virtual DtReal maxAltitude () const
 
virtual void setMaxAltitude (DtReal maxAlt)
 
virtual DtReal preferredAltitude () const
 
virtual void setPreferredAltitude (DtReal prefAlt)
 
virtual bool isDirectAlignmentCapable () const
 
virtual void setIsDirectAlignmentCapable (bool direct)
 
virtual bool useScriptedTasks () const
 
virtual void setUseScriptedTasks (bool useScripted)
 
virtual const
DtTargetingControlTable
targetingControlTable () const
 
virtual DtTargetingControlTabletargetingControlTable ()
 
- Public Member Functions inherited from DtBaseWeaponControllerDescriptor
 DtBaseWeaponControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=nullptr)
 
 DtBaseWeaponControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=nullptr)
 
 DtBaseWeaponControllerDescriptor (const DtBaseWeaponControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=nullptr)
 
DtBaseWeaponControllerDescriptoroperator= (const DtBaseWeaponControllerDescriptor &orig)
 
virtual ~DtBaseWeaponControllerDescriptor ()
 
virtual bool preloadWeapon () const
 
virtual void setPreloadWeapon (bool preloadWeapon)
 
virtual DtReal maxVehicleSpeedToFire () const
 
virtual void setMaxVehicleSpeedToFire (DtReal maxVehicleSpeedToFire)
 
virtual DtReal maxAzimuthAngleOffBoresight () const
 
virtual void setMaxAzimuthAngleOffBoresight (DtReal maxAngle)
 
virtual DtReal maxElevationAngleOffBoresight () const
 
virtual void setMaxElevationAngleOffBoresight (DtReal maxAngle)
 
virtual DtTime loadAmmoTime () const
 
virtual void setLoadAmmoTime (DtTime loadTime)
 
virtual DtTime unloadAmmoTime () const
 
virtual void setUnloadAmmoTime (DtTime unloadTime)
 
virtual bool disabledBySuppression () const
 
virtual void setDisabledBySuppression (const bool isDisabled)
 
virtual bool stowable () const
 
virtual void setStowable (bool v)
 
virtual bool controlLauncherAppearance () const
 
virtual void setControlLauncherAppearance (bool v)
 
- Public Member Functions inherited from DtComponentDescriptor
 DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtComponentDescriptoroperator= (const DtComponentDescriptor &orig)
 
virtual ~DtComponentDescriptor ()
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual bool init ()
 
virtual const DtStringstateAndParameterDataPrefix () const
 
bool operator== (const DtComponentDescriptor &) const
 
 DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual void setComponentType (const DtString &componentType)
 
virtual const DtStringcomponentType () const
 
virtual void setMinTickPeriod (DtReal minTickPeriod)
 
virtual DtReal minTickPeriod () const
 
virtual void setMinTickPeriodVariance (DtReal minTickPeriodVariance)
 
virtual DtReal minTickPeriodVariance () const
 
virtual void setPeriodicTickWhilePaused (bool value)
 
virtual bool periodicTickWhilePaused () const
 
virtual const DtStringprocessStateRepositoryName () const
 
virtual void setProcessStateRepositoryName (const DtString &name)
 
virtual const DtStringprocessStateRepositoryType () const
 
virtual void setProcessStateRepositoryType (const DtString &type)
 
virtual void setIsEnabled (bool yesNo)
 
virtual bool isEnabled () const
 
virtual void setIsEnabledForClutterEntities (bool yesNo)
 
virtual bool isEnabledForClutterEntities () const
 
virtual void setDebugActive (bool active)
 
virtual bool debugActive () const
 
virtual void setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
 
virtual DtReal minTaskVisualizationTickPeriod () const
 
virtual void setTaskVisualizationsEnabled (bool enabled)
 
virtual bool taskVisualizationsEnabled () const
 
virtual void setCreateComponent (bool yesNo)
 
virtual bool createComponent () const
 
virtual void setCreateOnRemoteObject (bool yesNo)
 
virtual bool createOnRemoteObject () const
 
virtual const
DtRwNLengthStringVector
scriptIds () const
 
virtual DtRwNLengthStringVectorscriptIds ()
 
virtual const
DtRwScriptVariablesList
scriptVariables () const
 
virtual DtRwScriptVariablesListscriptVariables ()
 
virtual const DtRwPropertiesparameterData () const
 
virtual DtRwPropertiesparameterData ()
 
virtual const DtRwPropertiesstateData () const
 
virtual DtRwPropertiesstateData ()
 
- 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 DtReaderWriteroperator= (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 getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
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 aliasContaineraliases () 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 charreaderWriterType () const
 
virtual const charxmlType () 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 DtReaderWriterdefaultRWValue () const
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistryregistry () const
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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 DtComponentDescriptorcreator ()
 
- Static Public Member Functions inherited from DtBaseWeaponControllerDescriptor
static DtComponentDescriptorcreator ()
 
- Static Public Member Functions inherited from DtComponentDescriptor
static void addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
 
static DtComponentDescriptorcreateComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
static DtComponentDescriptorcreateComponentDescriptor (const char *pName)
 
static DtComponentDescriptorcreator ()
 
static
DtComponentDescriptorFactory
factory ()
 
static void setFactory (DtComponentDescriptorFactory *factory)
 
- 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 chartheXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Member Functions

 DtIndirectFireControllerDescriptor ()
 
- Protected Member Functions inherited from DtBaseWeaponControllerDescriptor
 DtBaseWeaponControllerDescriptor ()
 
- Protected Member Functions inherited from DtComponentDescriptor
 DtComponentDescriptor ()
 
void addPrefixToStateAndParameterData ()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

parameters

These parameters are available for setting in the OPD files.

DtRwStringList myDefaultAmmoList
 
DtRwInt myNumRoundsPerMission
 
DtRwBoolean myEnforceRangeLimits
 
DtRwReal myMinRange
 
DtRwReal myMaxRange
 
DtNLengthRealVector myMuzzleSpeedList
 
DtRwReal myMinAltitude
 
DtRwReal myMaxAltitude
 
DtRwReal myPreferredAltitude
 
DtRwString myRangeName
 
DtRwInt myRangeId
 
DtRwString myWeaponDisplayName
 
DtRwBoolean myDirectAlignmentCapable
 
DtRwBoolean myAllowVelocityVariation
 
DtTargetingControlTable myTargetingControlTable
 
DtRwBoolean myUseScriptedTasks
 
DtRwNLengthStringVector myCustomFireTasks
 
DtRwProperties myWeaponProperties
 
- Protected Attributes inherited from DtBaseWeaponControllerDescriptor
DtRwReal myFireMaxVehicleSpeed
 
DtRwReal myMaxAzimuthAngleOffBoresight
 
DtRwReal myMaxElevationAngleOffBoresight
 
DtRwReal myMaxAngleOffBoresight
 
DtRwBoolean myDoWeaponPreload
 
DtRwTime myLoadAmmoTime
 
DtRwTime myUnloadAmmoTime
 
DtRwBoolean myDisabledBySuppression
 
DtRwBoolean myStowable
 
DtRwBoolean myControlLauncherAppearance
 
- Protected Attributes inherited from DtComponentDescriptor
bool myPrefixAppliedToStateAndParamData
 
DtRwString myComponentType
 
DtRwReal myMinTickPeriod
 
DtRwReal myMinTickPeriodVariance
 
DtRwBoolean myPeriodicTickWhilePaused
 
DtRwString myProcessStateRepositoryName
 
DtRwString myProcessStateRepositoryType
 
DtRwBoolean myIsEnabled
 
DtRwBoolean myIsEnabledForClutterEntities
 
DtRwBoolean myDebug
 
DtRwReal myMinTaskVisualizationTickPeriod
 
DtRwBoolean myTaskVisualizationsEnabled
 
DtRwBoolean myCreateComponent
 
DtRwBoolean myCreateOnRemoteObject
 
DtRwProperties myParameterData
 
DtRwProperties myStateData
 
DtRwString myStateAndParameterDataPrefix
 
DtRwNLengthStringVector myScriptIds
 
DtRwScriptVariablesList myScriptVariables
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

Additional Inherited Members

- 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 )()
 
- Static Protected Attributes inherited from DtComponentDescriptor
static
DtComponentDescriptorFactory
myFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Constructor & Destructor Documentation

DtIndirectFireControllerDescriptor::DtIndirectFireControllerDescriptor ( const DtString name,
DtReaderWriterRegistry parentRegistry = nullptr 
)

constructor

DtIndirectFireControllerDescriptor::DtIndirectFireControllerDescriptor ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = nullptr 
)
DtIndirectFireControllerDescriptor::DtIndirectFireControllerDescriptor ( const DtIndirectFireControllerDescriptor orig,
DtReaderWriterRegistry parentRegistry = nullptr 
)

copy constructor

virtual DtIndirectFireControllerDescriptor::~DtIndirectFireControllerDescriptor ( )
virtual

destructor

DtIndirectFireControllerDescriptor::DtIndirectFireControllerDescriptor ( )
protected

default constructor; not implemented

Member Function Documentation

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

assignment

virtual DtString DtIndirectFireControllerDescriptor::type ( ) const
overridevirtual

Returns the type of component this descriptor describes. Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns
DtIndirectFireControllerDescriptorType

Reimplemented from DtBaseWeaponControllerDescriptor.

virtual const DtString& DtIndirectFireControllerDescriptor::weaponName ( ) const
virtual

Accessor/mutator for #myWeaponName.

virtual void DtIndirectFireControllerDescriptor::setWeaponName ( const DtString name)
virtual

Accessor/mutator for #myWeaponName.

virtual const DtRwStringList& DtIndirectFireControllerDescriptor::defaultAmmoList ( ) const
virtual

Accessor/mutator for myDefaultAmmoList.

virtual void DtIndirectFireControllerDescriptor::setDefaultAmmoList ( const DtRwStringList list)
virtual

Accessor/mutator for myDefaultAmmoList.

virtual int DtIndirectFireControllerDescriptor::numRoundsPerMission ( ) const
virtual

Accessor/mutator for myNumRoundsPerMission.

virtual void DtIndirectFireControllerDescriptor::setNumRoundsPerMission ( int  numRoundsPerMission)
virtual

Accessor/mutator for myNumRoundsPerMission.

virtual bool DtIndirectFireControllerDescriptor::enforceRangeLimits ( ) const
virtual

Accessor/mutator for myEnforceRangeLimits.

virtual void DtIndirectFireControllerDescriptor::setEnforceRangeLimits ( bool  limit)
virtual

Accessor/mutator for myEnforceRangeLimits.

virtual bool DtIndirectFireControllerDescriptor::allowVelocityVariation ( ) const
virtual

Accessor/mutator for myAllowVelocityVariation.

virtual void DtIndirectFireControllerDescriptor::setAllowVelocityVariation ( bool  allow)
virtual

Accessor/mutator for myAllowVelocityVariation.

virtual const DtNLengthRealVector& DtIndirectFireControllerDescriptor::muzzleSpeedList ( ) const
virtual

Accessor/mutator for myMuzzleSpeedList.

virtual void DtIndirectFireControllerDescriptor::setMuzzleSpeedList ( const DtNLengthRealVector muzzleSpeeds)
virtual

Accessor/mutator for myMuzzleSpeedList.

virtual const DtString& DtIndirectFireControllerDescriptor::rangeName ( ) const
virtual

Accessor/mutator for myRangeName. Deprecated.

virtual void DtIndirectFireControllerDescriptor::setRangeName ( const DtString rangeName)
virtual

Accessor/mutator for myRangeName. Deprecated.

virtual int DtIndirectFireControllerDescriptor::rangeId ( ) const
virtual

Accessor/mutator for myRangeId.

virtual void DtIndirectFireControllerDescriptor::setRangeId ( int  rangeId)
virtual

Accessor/mutator for myRangeId.

virtual bool DtIndirectFireControllerDescriptor::rangeIdIsSpecified ( ) const
virtual

Accessor/mutator for myRangeId.

virtual DtReal DtIndirectFireControllerDescriptor::minRange ( ) const
virtual

Accessor/mutator for myMinRange.

virtual void DtIndirectFireControllerDescriptor::setMinRange ( DtReal  minRange)
virtual

Accessor/mutator for myMinRange.

virtual DtReal DtIndirectFireControllerDescriptor::maxRange ( ) const
virtual

Accessor/mutator for myMaxRange.

virtual void DtIndirectFireControllerDescriptor::setMaxRange ( DtReal  maxRange)
virtual

Accessor/mutator for myMaxRange.

virtual DtReal DtIndirectFireControllerDescriptor::minAltitude ( ) const
virtual

Accessor/mutator for myMinAltitude.

virtual void DtIndirectFireControllerDescriptor::setMinAltitude ( DtReal  minAlt)
virtual

Accessor/mutator for myMinAltitude.

virtual DtReal DtIndirectFireControllerDescriptor::maxAltitude ( ) const
virtual

Accessor/mutator for myMaxAltitude.

virtual void DtIndirectFireControllerDescriptor::setMaxAltitude ( DtReal  maxAlt)
virtual

Accessor/mutator for myMaxAltitude.

virtual DtReal DtIndirectFireControllerDescriptor::preferredAltitude ( ) const
virtual

Accessor/mutator for myPreferredAltitude.

virtual void DtIndirectFireControllerDescriptor::setPreferredAltitude ( DtReal  prefAlt)
virtual

Accessor/mutator for myPreferredAltitude.

virtual bool DtIndirectFireControllerDescriptor::isDirectAlignmentCapable ( ) const
virtual

Accessor/mutator for myDirectAlignmentCapable.

virtual void DtIndirectFireControllerDescriptor::setIsDirectAlignmentCapable ( bool  direct)
virtual

Accessor/mutator for myDirectAlignmentCapable.

virtual bool DtIndirectFireControllerDescriptor::useScriptedTasks ( ) const
virtual

Accessor/mutator for myUseScriptedTasks.

virtual void DtIndirectFireControllerDescriptor::setUseScriptedTasks ( bool  useScripted)
virtual

Accessor/mutator for myUseScriptedTasks.

virtual const DtRwNLengthStringVector& DtIndirectFireControllerDescriptor::customFireTasks ( ) const
virtual
virtual DtRwNLengthStringVector& DtIndirectFireControllerDescriptor::customFireTasks ( )
virtual
virtual const DtRwProperties& DtIndirectFireControllerDescriptor::weaponProperties ( ) const
virtual
virtual DtRwProperties& DtIndirectFireControllerDescriptor::weaponProperties ( )
virtual
virtual DtComponentDescriptor* DtIndirectFireControllerDescriptor::clone ( DtReaderWriterRegistry parentRegistry = nullptr) const
overridevirtual

Reimplemented from DtBaseWeaponControllerDescriptor.

static DtComponentDescriptor* DtIndirectFireControllerDescriptor::creator ( )
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.
virtual const DtTargetingControlTable& DtIndirectFireControllerDescriptor::targetingControlTable ( ) const
virtual

Accessor for myTargetingControlTable.

virtual DtTargetingControlTable& DtIndirectFireControllerDescriptor::targetingControlTable ( )
virtual

Accessor for myTargetingControlTable.

virtual void DtIndirectFireControllerDescriptor::postGetSelf ( )
overridevirtual

Updates default ammo lost with ammunition in targeting control table.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtRwStringList DtIndirectFireControllerDescriptor::myDefaultAmmoList
protected

Parameter Name: default-ammo-list
Parameter Description: Lists the types of ammunition available.
Parameter Default Value:
.

DtRwInt DtIndirectFireControllerDescriptor::myNumRoundsPerMission
protected

Parameter Name: num-rounds-per-mission
Parameter Description: Default number of rounds to fire (if the Fire For Effect task does not specify a number).
Parameter Default Value: 1
.

DtRwBoolean DtIndirectFireControllerDescriptor::myEnforceRangeLimits
protected

Parameter Name: enforce-range-limits
Parameter Description: User can choose to enforce minimum and maximum range limitations. Most cases this is desired but in some cases like a human throwing a grenade it is not. If false weapon system will fire to the best of ability either falling short or possibly blowing up too close.
Parameter Default Value: True
.

DtRwReal DtIndirectFireControllerDescriptor::myMinRange
protected

Parameter Name: min-range
Parameter Description: Minimum range of the weapon.
Parameter Default Value: 1000.
.

DtRwReal DtIndirectFireControllerDescriptor::myMaxRange
protected

Parameter Name: max-range
Parameter Description: Maximum range of the weapon.
Parameter Default Value: 4000.
.

DtNLengthRealVector DtIndirectFireControllerDescriptor::myMuzzleSpeedList
protected

Parameter Name: muzzle-speed-list
Parameter Description: Specifies a discrete list of muzzle speeds that are available for this weapon. The indirect fire controller will determine which speed to use based on the target range and the desired min and max altitudes above the shooter.
This parameter is optional. If not specified, controller will determine a suitable muzzle speed itself. Parameter Default Value:
.

DtRwReal DtIndirectFireControllerDescriptor::myMinAltitude
protected

Parameter Name: min-altitude
Parameter Description: Minimum altitude above the shooter or target (whichever is higher) that the peak of the trajectory will reach. Weapon's elevation will be aimed such that the munition reaches at most this altitude before it descends to the target.
Parameter Default Value: 100.
.

DtRwReal DtIndirectFireControllerDescriptor::myMaxAltitude
protected

Parameter Name: max-altitude
Parameter Description: Maximum altitude above the shooter or target (whichever is higher) that the peak of the trajectory will reach. Weapon's elevation will be aimed such that the munition reaches at most this altitude before it descends to the target.
Parameter Default Value: 1000.
.

DtRwReal DtIndirectFireControllerDescriptor::myPreferredAltitude
protected

Parameter Name: preferred-altitude
Parameter Description: Preferred altitude above the shooter or target (whichever is higher) that the peak of the trajectory will reach. Will try to set the weapon's elevation to reach this height or close to it if possible, otherwise a height within the maximum or minimum will be chosen. This is the default preferred altitude for the weapon, but this can also be modified at run time.
Parameter Default Value: 700.
.

DtRwString DtIndirectFireControllerDescriptor::myRangeName
protected

Parameter Name: range-name
Parameter Description: Deprecated. Name given to any range item associated with this descriptor.
Parameter Default Value:
.

DtRwInt DtIndirectFireControllerDescriptor::myRangeId
protected

Parameter Name: range-id
Parameter Description: The identifying value for this range ring. Can be converted to a string based on configured enumeration values. See appData\settings\enumerations\VRF-Enums.xml.
Parameter Default Value: 0
.

DtRwString DtIndirectFireControllerDescriptor::myWeaponDisplayName
protected

Parameter Name: weapon-name
Parameter Description: User friendly name associated this weapon. Useful if there are more than one weapon system on an entity. Parameter Default Value: "Indirect Fire Gun"
.

DtRwBoolean DtIndirectFireControllerDescriptor::myDirectAlignmentCapable
protected

Parameter Name: capable-of-direct-alignment
Parameter Description: Is this indirect fire weapon capable of directly aligning with close in targets. If so value should be true. In this case the gun will check if the target's range is greater than the minimum range but less that the first range value in the range list. If so the weapon will shoot directly at the target and not have a parabolic trajectory. This was put in place for naval guns which have this ability.
Parameter Default Value: false
.

DtRwBoolean DtIndirectFireControllerDescriptor::myAllowVelocityVariation
protected

Parameter Name: allow-velocity-variation
In some instances the user might to define an initial muzzle speed or orientation. If user doesn't specify, actuator will compute the minimum velocity necessary to reach the target not constrained by the range list values, will instead use the actual range to target. Parameter Default Value: false.

DtTargetingControlTable DtIndirectFireControllerDescriptor::myTargetingControlTable
protected

Parameter Name: targeting-control-table
Parameter Description: The table that will specify ammunition that is available to this controller and target priorities. If this is specified will also add ammunition and amounts into resource manager. Target priorities are not currently used Parameter Default Value:
.

DtRwBoolean DtIndirectFireControllerDescriptor::myUseScriptedTasks
protected

Parameter Name: use-scripted-tasks
Parameter Description: Set to false will use the old
built in Fire for effect tasks. For backwards compatibility Parameter Default Value: false
Parameter Units:

DtRwNLengthStringVector DtIndirectFireControllerDescriptor::myCustomFireTasks
protected

Parameter Name: custom-fire-tasks
Parameter Description: Script IDs for lua fire tasks used to fire this weapon.
Parameter Default Value: None
.

DtRwProperties DtIndirectFireControllerDescriptor::myWeaponProperties
protected

Parameter Name: weapon-properties
Parameter Description: A flexible list of RW properties that can be accessed in the weapon info for this weapon in Lua. Parameter Default Value: None
.


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)