DtIndirectFireControllerDescriptor; descriptor for the DtIndirectFireController compenent. More...

Inheritance diagram for DtIndirectFireControllerDescriptor:

Public Member Functions
	DtIndirectFireControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtIndirectFireControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtIndirectFireControllerDescriptor (const DtIndirectFireControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtIndirectFireControllerDescriptor &	operator= (const DtIndirectFireControllerDescriptor &orig)
	assignment
virtual	~DtIndirectFireControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const

virtual const DtString &	weaponName () const
	Accessor/mutator for #myWeaponName.
virtual void	setWeaponName (const DtString &name)
	Accessor/mutator for #myWeaponName.

virtual const DtRwStringList &	defaultAmmoList () const
	Accessor/mutator for myDefaultAmmoList.
virtual void	setDefaultAmmoList (const DtRwStringList &list)
	Accessor/mutator for myDefaultAmmoList.

virtual int	numRoundsPerMission () const
	Accessor/mutator for myNumRoundsPerMission.
virtual void	setNumRoundsPerMission (int numRoundsPerMission)
	Accessor/mutator for myNumRoundsPerMission.

virtual const DtNLengthRealVector &	maxRangeList () const
	Accessor/mutator for myMaxRangeList.
virtual void	setMaxRangeList (const DtNLengthRealVector &maxRangeList)
	Accessor/mutator for myMaxRangeList.

virtual const DtString &	rangeName () const
	Accessor/mutator for myRangeName.
virtual void	setRangeName (const DtString &rangeName)
	Accessor/mutator for myRangeName.

virtual DtReal	minRange () const
	Accessor/mutator for myMinRange.
virtual void	setMinRange (DtReal minRange)
	Accessor/mutator for myMinRange.

virtual bool	isDirectAlignmentCapable () const
	Accessor/mutator for myDirectAlignmentCapable.
virtual void	setIsDirectAlignmentCapable (bool direct)
	Accessor/mutator for myDirectAlignmentCapable.
Public Member Functions inherited from DtBaseWeaponControllerDescriptor
	DtBaseWeaponControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtBaseWeaponControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBaseWeaponControllerDescriptor (const DtBaseWeaponControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtBaseWeaponControllerDescriptor &	operator= (const DtBaseWeaponControllerDescriptor &orig)
	assignment
virtual	~DtBaseWeaponControllerDescriptor ()
	destructor
virtual bool	preloadWeapon () const
	Accessor/mutator for myDoWeaponPreload.
virtual void	setPreloadWeapon (bool preloadWeapon)
	Accessor/mutator for myDoWeaponPreload.
virtual DtReal	maxVehicleSpeedToFire () const
	Accessor/mutator for myFireMaxVehicleSpeed.
virtual void	setMaxVehicleSpeedToFire (DtReal maxVehicleSpeedToFire)
	Accessor/mutator for myFireMaxVehicleSpeed.
virtual DtReal	maxAngleOffBoresight () const
	Accessor/mutator for myMaxAngleOffBoresight.
virtual void	setMaxAngleOffBoresight (DtReal maxAngleOffBoresight)
	Accessor/mutator for myMaxAngleOffBoresight.
virtual DtTime	loadAmmoTime () const
	Accessor/mutator for myLoadAmmoTime.
virtual void	setLoadAmmoTime (DtTime loadTime)
	Accessor/mutator for myLoadAmmoTime.
virtual DtTime	unloadAmmoTime () const
	Accessor/mutator for myUnloadAmmoTime.
virtual void	setUnloadAmmoTime (DtTime unloadTime)
	Accessor/mutator for myUnloadAmmoTime.
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
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)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive ()
	Should detailed debug info be printed for this component.
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
	Should the component be created or not.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtIndirectFireControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtBaseWeaponControllerDescriptor
	DtBaseWeaponControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwStringList	myDefaultAmmoList
	Parameter Name: default-ammo-list Parameter Description: Lists the types of ammunition available.
DtRwInt	myNumRoundsPerMission
	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).
DtRwReal	myMinRange
	Parameter Name: min-range Parameter Description: Minimum range of the weapon.
DtNLengthRealVector	myMaxRangeList
	Parameter Name: max-range-list Parameter Description: Implicitly specifies a list of muzzle velocities by listing their maximum ranges.
DtRwString	myRangeName
	Name given to any range item associated with this descriptor.
DtRwString	myWeaponDisplayName
	Parameter Name: weapon-name Parameter Description: User friendly name associated this weapon.
DtRwBoolean	myDirectAlignmentCapable
	Parameter Name: capable-of-direct-alignment Parameter Description: Is this indirect fire weapon capable of directly aligning with close in targets.
Protected Attributes inherited from DtBaseWeaponControllerDescriptor
DtRwReal	myFireMaxVehicleSpeed
	Parameter Name: max-vehicle-speed-to-fire Parameter Description: Some vehicles must stop to shoot, others have a maximum speed to launch a munition.
DtRwReal	myMaxAngleOffBoresight
	Parameter Name: max-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.
DtRwBoolean	myDoWeaponPreload
	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.
DtRwTime	myLoadAmmoTime
	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.
DtRwTime	myUnloadAmmoTime
	Parameter Name: unload-ammo-time Parameter Description: The time is takes to remove ammo (of the wrong type, presumably) from the gun.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwBoolean	myCreateComponent
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

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.

Constructor & Destructor Documentation

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

constructor

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

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

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

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: 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 const DtNLengthRealVector& DtIndirectFireControllerDescriptor::maxRangeList ( ) const

virtual

Accessor/mutator for myMaxRangeList.

virtual void DtIndirectFireControllerDescriptor::setMaxRangeList ( const DtNLengthRealVector & maxRangeList )

virtual

Accessor/mutator for myMaxRangeList.

virtual const DtString& DtIndirectFireControllerDescriptor::rangeName ( ) const

virtual

Accessor/mutator for myRangeName.

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

virtual

Accessor/mutator for myRangeName.

virtual DtReal DtIndirectFireControllerDescriptor::minRange ( ) const

virtual

Accessor/mutator for myMinRange.

virtual void DtIndirectFireControllerDescriptor::setMinRange ( DtReal minRange )

virtual

Accessor/mutator for myMinRange.

virtual bool DtIndirectFireControllerDescriptor::isDirectAlignmentCapable ( ) const

virtual

Accessor/mutator for myDirectAlignmentCapable.

virtual void DtIndirectFireControllerDescriptor::setIsDirectAlignmentCapable ( bool direct )

virtual

Accessor/mutator for myDirectAlignmentCapable.

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

virtual

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.

Reimplemented from DtBaseWeaponControllerDescriptor.

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

DtRwReal DtIndirectFireControllerDescriptor::myMinRange

protected

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

Parameter Default Value: 1000.

DtNLengthRealVector DtIndirectFireControllerDescriptor::myMaxRangeList

protected

Parameter Name: max-range-list
Parameter Description: Implicitly specifies a list of muzzle velocities by listing their maximum ranges.

When the indirect fire controller determines the elevation to use, it uses the lowest maximum range value that covers the distance to the target.
Parameter Default Value:

DtRwString DtIndirectFireControllerDescriptor::myRangeName

protected

Name given to any range item associated with this descriptor.

Parameter Default Value:

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

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/iFireCtlDesc.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation