DtBaseWeaponControllerDescriptor Class Reference

DtBaseWeaponControllerDescriptor; descriptor for the DtBaseWeaponController component.

A DtComponentDescriptor that has additional information needed for providing parameters to an generic weapon controller.

End User Description: It contains load time, unload time, max speed at which the entity can fire and maneuver.

Inheritance diagram for DtBaseWeaponControllerDescriptor:

Public Member Functions
	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 DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
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	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	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 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
	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.
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

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

constructor

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

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

copy constructor

virtual DtBaseWeaponControllerDescriptor::~DtBaseWeaponControllerDescriptor ( )

virtual

destructor

DtBaseWeaponControllerDescriptor::DtBaseWeaponControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtBaseWeaponControllerDescriptor& DtBaseWeaponControllerDescriptor::operator=

(

const DtBaseWeaponControllerDescriptor &

orig

)

assignment

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

DtBaseWeaponControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtIndirectFireControllerDescriptor, and DtWeaponControllerDescriptor.

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

virtual

Reimplemented from DtComponentDescriptor.

Reimplemented in DtIndirectFireControllerDescriptor, and DtWeaponControllerDescriptor.

virtual bool DtBaseWeaponControllerDescriptor::preloadWeapon ( ) const

virtual

Accessor/mutator for myDoWeaponPreload.

virtual void DtBaseWeaponControllerDescriptor::setPreloadWeapon ( bool  preloadWeapon )

virtual

Accessor/mutator for myDoWeaponPreload.

virtual DtReal DtBaseWeaponControllerDescriptor::maxVehicleSpeedToFire ( ) const

virtual

Accessor/mutator for myFireMaxVehicleSpeed.

virtual void DtBaseWeaponControllerDescriptor::setMaxVehicleSpeedToFire ( DtReal  maxVehicleSpeedToFire )

virtual

Accessor/mutator for myFireMaxVehicleSpeed.

virtual DtReal DtBaseWeaponControllerDescriptor::maxAzimuthAngleOffBoresight ( ) const

virtual

Accessor/mutator for myMaxAzimuthAngleOffBoresight.

virtual void DtBaseWeaponControllerDescriptor::setMaxAzimuthAngleOffBoresight ( DtReal  maxAngle )

virtual

Accessor/mutator for myMaxAzimuthAngleOffBoresight.

virtual DtReal DtBaseWeaponControllerDescriptor::maxElevationAngleOffBoresight ( ) const

virtual

Accessor/mutator for myMaxElevationAngleOffBoresight.

virtual void DtBaseWeaponControllerDescriptor::setMaxElevationAngleOffBoresight ( DtReal  maxAngle )

virtual

Accessor/mutator for myMaxElevationAngleOffBoresight.

virtual DtTime DtBaseWeaponControllerDescriptor::loadAmmoTime ( ) const

virtual

Accessor/mutator for myLoadAmmoTime.

virtual void DtBaseWeaponControllerDescriptor::setLoadAmmoTime ( DtTime  loadTime )

virtual

Accessor/mutator for myLoadAmmoTime.

virtual DtTime DtBaseWeaponControllerDescriptor::unloadAmmoTime ( ) const

virtual

Accessor/mutator for myUnloadAmmoTime.

virtual void DtBaseWeaponControllerDescriptor::setUnloadAmmoTime ( DtTime  unloadTime )

virtual

Accessor/mutator for myUnloadAmmoTime.

virtual bool DtBaseWeaponControllerDescriptor::disabledBySuppression ( ) const

virtual

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

virtual void DtBaseWeaponControllerDescriptor::setDisabledBySuppression ( const bool  isDisabled )

virtual

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

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

DtRwReal DtBaseWeaponControllerDescriptor::myFireMaxVehicleSpeed

protected

Parameter Name: max-vehicle-speed-to-fire
Parameter Description: Some vehicles must stop to shoot, others have a maximum speed to launch a munition. This is the maximum speed the vehicle can be moving when it fires this weapon. If 0, vehicle has to stop to fire.
Parameter Default Value: 500.0
Parameter Units: meters/second.

DtRwReal DtBaseWeaponControllerDescriptor::myMaxAzimuthAngleOffBoresight

protected

Parameter Name: max-azimuth-angle-off-boresight
Parameter Description: Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target. This method allows the user to set the maximum number of radians of azimuth off of boresight the target can be and still reasonably fire the weapon.
Parameter Default Value: 0.005
Parameter Units: radians.

DtRwReal DtBaseWeaponControllerDescriptor::myMaxElevationAngleOffBoresight

protected

Parameter Name: max-elevation-angle-off-boresight
Parameter Description: Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target. This method allows the user to set the maximum number of radians of elevation off of boresight the target can be and still reasonably fire the weapon.
Parameter Default Value: 0.005
Parameter Units: radians.

DtRwReal DtBaseWeaponControllerDescriptor::myMaxAngleOffBoresight

protected

Parameter Name: max-angle-off-boresight
Parameter Description: NOTE: This parameter is deprecated. It is retained for backwards compatibility, but will be ignored.
Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target. This method allows the user to set the maximum number of radians off of boresight the target can be and still reasonably fire the weapon. This margin is used in both azimuth and elevation.
Parameter Default Value: 0.005
Parameter Units: radians.

DtRwBoolean DtBaseWeaponControllerDescriptor::myDoWeaponPreload

protected

Parameter Name: preload-weapon
Parameter Description: Setting PreloadWeapon to True will result in the weapon being loaded with the first munition choice if no target is currently available.
Parameter Default Value: False.

DtRwTime DtBaseWeaponControllerDescriptor::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 DtBaseWeaponControllerDescriptor::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.

DtRwBoolean DtBaseWeaponControllerDescriptor::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
.

---

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

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