DtBallisticGunControllerDescriptor Class Reference

DtBallisticGunControllerDescriptor, descriptor for the DtBallisticGunController component.

A DtComponentDescriptor that has additional information needed for providing parameters to a generic ballistic gun controller. In contains load time, unload time, and an ammo selection table.

Inheritance diagram for DtBallisticGunControllerDescriptor:

Public Member Functions
	DtBallisticGunControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBallisticGunControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBallisticGunControllerDescriptor (const DtBallisticGunControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtBallisticGunControllerDescriptor &	operator= (const DtBallisticGunControllerDescriptor &orig)
virtual	~DtBallisticGunControllerDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	postGetSelf ()
virtual DtTime	loadAmmoTime () const
virtual void	setLoadAmmoTime (DtTime loadTime)
virtual DtTime	unloadAmmoTime () const
virtual void	setUnloadAmmoTime (DtTime unloadTime)
virtual int	roundsPerTriggerPull () const
virtual void	setRoundsPerTriggerPull (int value)
virtual const DtAmmoSelectTable &	ammoSelectTable () const
virtual void	setAmmoSelectTable (const DtAmmoSelectTable &table)
virtual const DtString &	ammoSelectTableFilename ()
virtual void	setAmmoSelectTableFilename (const DtString &filename)
virtual DtTargetSelectionCriteria &	targetSelectionCriteria ()
virtual const DtTargetSelectionCriteria &	targetSelectionCriteria () const
virtual bool	disabledBySuppression () const
virtual void	setDisabledBySuppression (const bool isDisabled)
virtual bool	treatSelectedAsTasked () const
virtual void	setTreatSelectedAsTasked (bool t)
virtual const DtTargetingControlTable &	targetingControlTable () const
virtual DtTargetingControlTable &	targetingControlTable ()
virtual DtString	requiredTokensString () const
virtual std::set< DtString >	requiredTokens () const
virtual void	setRequiredTokensString (const DtString &tokens)
virtual int	gunPriority () const
virtual void	setGunPriority (const int p)
virtual const DtRwProperties &	weaponProperties () const
virtual DtRwProperties &	weaponProperties ()
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (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 DtString &	stateAndParameterDataPrefix () 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 DtString &	componentType () 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 DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () 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 DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
virtual const DtRwProperties &	parameterData () const
virtual DtRwProperties &	parameterData ()
virtual const DtRwProperties &	stateData () const
virtual DtRwProperties &	stateData ()
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	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 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 DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
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 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 Member Functions
	DtBallisticGunControllerDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
std::set< DtString >	myRequiredTokenSet
tbb::spin_mutex	myRequiredTokensMutex
parameters
These parameters are available for setting in the OPD files.
DtRwTime	myLoadAmmoTime
DtRwTime	myUnloadAmmoTime
DtReaderWriterFile	myAmmoSelectTableFile
DtAmmoSelectTable	myAmmoSelectTable
DtRwInt	myRoundsPerTriggerPull
DtTargetSelectionCriteria	myTargetSelectionCriteria
DtRwBoolean	myDisabledBySuppression
DtRwBoolean	myTreatSelectedAsTasked
DtRwString	myRequiredTokens
DtRwInt	myGunPriority
DtTargetingControlTable	myTargetingControlTable
DtRwProperties	myWeaponProperties
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
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
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 DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtBallisticGunControllerDescriptor::DtBallisticGunControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtBallisticGunControllerDescriptor::DtBallisticGunControllerDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtBallisticGunControllerDescriptor::DtBallisticGunControllerDescriptor	(	const DtBallisticGunControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtBallisticGunControllerDescriptor::~DtBallisticGunControllerDescriptor ( )

virtual

destructor

DtBallisticGunControllerDescriptor::DtBallisticGunControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtBallisticGunControllerDescriptor& DtBallisticGunControllerDescriptor::operator=

(

const DtBallisticGunControllerDescriptor &

orig

)

assignment

virtual DtString DtBallisticGunControllerDescriptor::type ( ) const

virtual

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

DtBallisticGunControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtBallisticGunJoyControllerDescriptor, and DtElevatingBallisticGunControllerDescriptor.

virtual DtComponentDescriptor* DtBallisticGunControllerDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = NULL ) const

virtual

Reimplemented from DtComponentDescriptor.

Reimplemented in DtElevatingBallisticGunControllerDescriptor, and DtBallisticGunJoyControllerDescriptor.

virtual DtTime DtBallisticGunControllerDescriptor::loadAmmoTime ( ) const

virtual

Accessor/mutator for myLoadAmmoTime.

virtual void DtBallisticGunControllerDescriptor::setLoadAmmoTime ( DtTime  loadTime )

virtual

Accessor/mutator for myLoadAmmoTime.

virtual DtTime DtBallisticGunControllerDescriptor::unloadAmmoTime ( ) const

virtual

Accessor/mutator for myUnloadAmmoTime.

virtual void DtBallisticGunControllerDescriptor::setUnloadAmmoTime ( DtTime  unloadTime )

virtual

Accessor/mutator for myUnloadAmmoTime.

virtual int DtBallisticGunControllerDescriptor::roundsPerTriggerPull ( ) const

virtual

See Also

myRoundsPerTriggerPull.

virtual void DtBallisticGunControllerDescriptor::setRoundsPerTriggerPull ( int  value )

virtual

See Also

myRoundsPerTriggerPull.

virtual const DtAmmoSelectTable& DtBallisticGunControllerDescriptor::ammoSelectTable ( ) const

virtual

Accessor/mutator for myAmmoSelectTable.

virtual void DtBallisticGunControllerDescriptor::setAmmoSelectTable ( const DtAmmoSelectTable &  table )

virtual

Accessor/mutator for myAmmoSelectTable.

virtual const DtString& DtBallisticGunControllerDescriptor::ammoSelectTableFilename ( )

virtual

Accessor/mutator for myAmmoSelectTableFile.

virtual void DtBallisticGunControllerDescriptor::setAmmoSelectTableFilename ( const DtString &  filename )

virtual

Accessor/mutator for myAmmoSelectTableFile.

virtual DtTargetSelectionCriteria& DtBallisticGunControllerDescriptor::targetSelectionCriteria ( )

virtual

Accessor/mutator for myTargetSelectionCriteria.

virtual const DtTargetSelectionCriteria& DtBallisticGunControllerDescriptor::targetSelectionCriteria ( ) const

virtual

Accessor/mutator for myTargetSelectionCriteria.

virtual bool DtBallisticGunControllerDescriptor::disabledBySuppression ( ) const

virtual

Accessor/mutator for myDisabledBySuppression. Is this weapon disabled when the entity is suppressed?

virtual void DtBallisticGunControllerDescriptor::setDisabledBySuppression ( const bool  isDisabled )

virtual

Accessor/mutator for myDisabledBySuppression. Is this weapon disabled when the entity is suppressed?

virtual bool DtBallisticGunControllerDescriptor::treatSelectedAsTasked ( ) const

virtual

Accessor/mutator for myTreatSelectedAsTasked.

virtual void DtBallisticGunControllerDescriptor::setTreatSelectedAsTasked ( bool  t )

virtual

Accessor/mutator for myTreatSelectedAsTasked.

virtual const DtTargetingControlTable& DtBallisticGunControllerDescriptor::targetingControlTable ( ) const

virtual

Accessor for myTargetingControlTable.

virtual DtTargetingControlTable& DtBallisticGunControllerDescriptor::targetingControlTable ( )

virtual

Accessor for myTargetingControlTable.

virtual DtString DtBallisticGunControllerDescriptor::requiredTokensString ( ) const

virtual

Accessor/mutator for myRequiredTokens. The string version of the functions (return value and argument) refers to a string that has token names separated by commas. The set version of the functions returns the tokens in a set.

virtual std::set<DtString> DtBallisticGunControllerDescriptor::requiredTokens ( ) const

virtual

Accessor/mutator for myRequiredTokens. The string version of the functions (return value and argument) refers to a string that has token names separated by commas. The set version of the functions returns the tokens in a set.

virtual void DtBallisticGunControllerDescriptor::setRequiredTokensString ( const DtString &  tokens )

virtual

Accessor/mutator for myRequiredTokens. The string version of the functions (return value and argument) refers to a string that has token names separated by commas. The set version of the functions returns the tokens in a set.

virtual int DtBallisticGunControllerDescriptor::gunPriority ( ) const

virtual

Accessor/mutator for myGunPriority.

virtual void DtBallisticGunControllerDescriptor::setGunPriority ( const int  p )

virtual

Accessor/mutator for myGunPriority.

virtual const DtRwProperties& DtBallisticGunControllerDescriptor::weaponProperties ( ) const

virtual

See Also

myWeaponProperties

virtual DtRwProperties& DtBallisticGunControllerDescriptor::weaponProperties ( )

virtual

See Also

myWeaponProperties

static DtComponentDescriptor* DtBallisticGunControllerDescriptor::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 void DtBallisticGunControllerDescriptor::postGetSelf ( )

virtual

Updates ammo select and targeting control variables from the targeting control table if that is specified such that controllers that use this descriptor do not have to change their code for updating.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtRwTime DtBallisticGunControllerDescriptor::myLoadAmmoTime

protected

Parameter Name: load-ammo-time
Parameter Description: The time delay from the time an ammo is selected to the time (an unloaded) gun is ready to fire.
Parameter Default Value: 0.0
Parameter Units: seconds.

DtRwTime DtBallisticGunControllerDescriptor::myUnloadAmmoTime

protected

Parameter Name: unload-ammo-time
Parameter Description: The time is takes to remove ammo (of the wrong type, presumably) from the gun. The same time is used whether the gun was loaded or in the process of being loaded.
Parameter Default Value: 0.0
Parameter Units: seconds.

DtReaderWriterFile DtBallisticGunControllerDescriptor::myAmmoSelectTableFile

protected

Parameter Name: ammo-select-table-file
Parameter Description: Sets the filename used for the ammo select table.
Parameter Default Value: "".

DtAmmoSelectTable DtBallisticGunControllerDescriptor::myAmmoSelectTable

protected

Parameter Name: ammo-select-table
Parameter Description: Table of target types versus lists of prioritized munition types to use against a given target type. Parameter Default Value:
.

DtRwInt DtBallisticGunControllerDescriptor::myRoundsPerTriggerPull

protected

Parameter Name: rounds-per-trigger-pull
Parameter Description: The number of rounds to fire for each single trigger pull. This affects how many rounds a depleted from the resource stores, and the value of the quantity field in the fire/detonate interaction.
Parameter Default Value: 1
Parameter Units: Number.

DtTargetSelectionCriteria DtBallisticGunControllerDescriptor::myTargetSelectionCriteria

protected

Parameter Name: targeting-control
Parameter Description: List of DtTargetSelectionCriteria objects, that hold target selection criteria for a given weapon system.
See DtTargetSelectionCriteria for more information on this item.
Parameter Default Value:
.

DtRwBoolean DtBallisticGunControllerDescriptor::myDisabledBySuppression

protected

Parameter Name: disabled-by-suppression
Parameter Description: A boolean that indicates if this weapon should be disabled when the entity is suppressed. Often true if the weapon is operated by a human outside a vehicle, but false if it is operated by a human inside an armored vehicle.
Parameter Default Value: False
.

DtRwBoolean DtBallisticGunControllerDescriptor::myTreatSelectedAsTasked

protected

Parameter Name: treat-selected-target-as-tasked
Parameter Description: a boolean that indicates that when a target is auto-selected for this gun, vs. set in a fire-at-target task, the gun priority should be the same as when the target is set by task. This makes a high priority gun keep control of necessary turrets even if a lower priority gun on the same turret is tasked.
Parameter Default Value: false
.

DtRwString DtBallisticGunControllerDescriptor::myRequiredTokens

protected

Parameter Name: required-tokens
Parameter Description: A list of strings that name the "token resources" that this weapon requires to operate; for example, crew members. These resources are reserved, not consumed. This list will be saved in a set with the weapon interface and other weapons can compare their requirements against this set to see if the weapon uses conflict.
The parameter should have the form of a string of comma- separated token names, e.g. "commander, gunner"
Parameter Default Value: empty
.

DtRwInt DtBallisticGunControllerDescriptor::myGunPriority

protected

Parameter Name: gun-priority
Parameter Description: A priority among all guns mounted on the same turret. For example, main gun and machine guns mounted on a main turret. Low values are higher priority. Values are integers >= 1.
Parameter Default Value: 1
.

DtTargetingControlTable DtBallisticGunControllerDescriptor::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 Parameter Default Value:
.

DtRwProperties DtBallisticGunControllerDescriptor::myWeaponProperties

protected

A flexible collection of static properties that are provided to users of the weapon through the weaponInfo. These can be accessed by lua functions making fire control decisions, for example.

std::set<DtString> DtBallisticGunControllerDescriptor::myRequiredTokenSet

mutableprotected

The tokens in a set rather than a comma-separated list in one string. This is mutable because it is set from the string the first time it is accessed.

tbb::spin_mutex DtBallisticGunControllerDescriptor::myRequiredTokensMutex

mutableprotected

---

The documentation for this class was generated from the following file:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/ballisticGunControllerDescriptor.h