DtWeaponControllerDescriptor Class Reference

DtWeaponControllerDescriptor; descriptor for the DtWeaponController component.

DtWeaponControllerDescriptor is a DtBaseWeaponControllerDescriptor that has additional information needed for providing parameters to a direct fire weapon controller. In adds an ammo selection table for choosing appropriate ammo based on target type.

Inheritance diagram for DtWeaponControllerDescriptor:

Public Member Functions
	DtWeaponControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtWeaponControllerDescriptor (const DtWeaponControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtWeaponControllerDescriptor &	operator= (const DtWeaponControllerDescriptor &orig)
virtual	~DtWeaponControllerDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual void	postGetSelf ()
virtual const DtAmmoSelectTable &	ammoSelectTable () const
virtual void	setAmmoSelectTable (const DtAmmoSelectTable &table)
virtual void	setAmmoSelectTableFilename (const DtString &filename)
virtual const DtString &	ammoSelectTableFilename ()
virtual const DtString &	rangeName () const
virtual void	setRangeName (const DtString &rangeName)
virtual int	rangeId () const
virtual void	setRangeId (int rangeId)
virtual bool	rangeIdIsSpecified () const
virtual DtTargetSelectionCriteria &	targetSelectionCriteria ()
virtual const DtTargetSelectionCriteria &	targetSelectionCriteria () const
virtual const DtTargetingControlTable &	targetingControlTable () const
virtual DtTargetingControlTable &	targetingControlTable ()
Public Member Functions inherited from DtBaseWeaponControllerDescriptor
	DtBaseWeaponControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBaseWeaponControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBaseWeaponControllerDescriptor (const DtBaseWeaponControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtBaseWeaponControllerDescriptor &	operator= (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)
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 ()
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	setTickPeriodUsesRealTime (bool value)
virtual bool	tickPeriodUsesRealTime () 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	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 ()
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	wasUpdatedSince (DtTime t) 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 DtBaseWeaponControllerDescriptor
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
	DtWeaponControllerDescriptor ()
Protected Member Functions inherited from DtBaseWeaponControllerDescriptor
	DtBaseWeaponControllerDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
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.
DtReaderWriterFile	myAmmoSelectTableFile
DtAmmoSelectTable	myAmmoSelectTable
DtRwString	myRangeName
DtRwInt	myRangeId
DtTargetSelectionCriteria	myTargetSelectionCriteria
DtTargetingControlTable	myTargetingControlTable
Protected Attributes inherited from DtBaseWeaponControllerDescriptor
DtRwReal	myFireMaxVehicleSpeed
DtRwReal	myMaxAzimuthAngleOffBoresight
DtRwReal	myMaxElevationAngleOffBoresight
DtRwReal	myMaxAngleOffBoresight
DtRwBoolean	myDoWeaponPreload
DtRwTime	myLoadAmmoTime
DtRwTime	myUnloadAmmoTime
DtRwBoolean	myDisabledBySuppression
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myTickPeriodUsesRealTime
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
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

DtWeaponControllerDescriptor::DtWeaponControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtWeaponControllerDescriptor::DtWeaponControllerDescriptor	(	const DtWeaponControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtWeaponControllerDescriptor::~DtWeaponControllerDescriptor ( )

virtual

destructor

DtWeaponControllerDescriptor::DtWeaponControllerDescriptor ( )

protected

default constructor

Member Function Documentation

DtWeaponControllerDescriptor& DtWeaponControllerDescriptor::operator=

(

const DtWeaponControllerDescriptor &

orig

)

assignment

virtual DtString DtWeaponControllerDescriptor::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

DtWeaponControllerDescriptorType

Reimplemented from DtBaseWeaponControllerDescriptor.

virtual DtComponentDescriptor* DtWeaponControllerDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Reimplemented from DtBaseWeaponControllerDescriptor.

virtual const DtAmmoSelectTable& DtWeaponControllerDescriptor::ammoSelectTable ( ) const

virtual

Accessor/mutator for myAmmoSelectTable.

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

virtual

Accessor/mutator for myAmmoSelectTable.

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

virtual

Accessor/mutator for myAmmoSelectTableFile.

virtual const DtString& DtWeaponControllerDescriptor::ammoSelectTableFilename ( )

virtual

Accessor/mutator for myAmmoSelectTableFile.

virtual const DtString& DtWeaponControllerDescriptor::rangeName ( ) const

virtual

Accessor/mutator for myRangeName.

virtual void DtWeaponControllerDescriptor::setRangeName ( const DtString &  rangeName )

virtual

Accessor/mutator for myRangeName.

virtual int DtWeaponControllerDescriptor::rangeId ( ) const

virtual

Accessor/mutator for myRangeId.

virtual void DtWeaponControllerDescriptor::setRangeId ( int  rangeId )

virtual

Accessor/mutator for myRangeId.

virtual bool DtWeaponControllerDescriptor::rangeIdIsSpecified ( ) const

virtual

Accessor/mutator for myRangeId.

virtual DtTargetSelectionCriteria& DtWeaponControllerDescriptor::targetSelectionCriteria ( )

virtual

Accessor/mutator for myTargetSelectionCriteria.

virtual const DtTargetSelectionCriteria& DtWeaponControllerDescriptor::targetSelectionCriteria ( ) const

virtual

Accessor/mutator for myTargetSelectionCriteria.

virtual const DtTargetingControlTable& DtWeaponControllerDescriptor::targetingControlTable ( ) const

virtual

Accessor for myTargetingControlTable.

virtual DtTargetingControlTable& DtWeaponControllerDescriptor::targetingControlTable ( )

virtual

Accessor for myTargetingControlTable.

virtual void DtWeaponControllerDescriptor::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.

static DtComponentDescriptor* DtWeaponControllerDescriptor::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.

Member Data Documentation

DtReaderWriterFile DtWeaponControllerDescriptor::myAmmoSelectTableFile

protected

Parameter Name: ammo-select-table-file
Parameter Description: Filename used for the ammo select table.
Parameter Default Value:
.

DtAmmoSelectTable DtWeaponControllerDescriptor::myAmmoSelectTable

protected

Parameter Name: ammo-select-table
Parameter Description: Table that provides a list of munitions that are appropriate for specific target types.
Parameter Default Value:
.

DtRwString DtWeaponControllerDescriptor::myRangeName

protected

Parameter Name: range-name
Parameter Description: Deprecated. Text name used when displaying the range ring or weapon name of this weapon in the VRF GUI. Parameter Default Value: Blank String
.

DtRwInt DtWeaponControllerDescriptor::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.
Parameter Default Value: 0
.

DtTargetSelectionCriteria DtWeaponControllerDescriptor::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:
.

DtTargetingControlTable DtWeaponControllerDescriptor::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:
.

---

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

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