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

Inheritance diagram for DtIndirectFireControllerDescriptor:

Public Member Functions
	DtIndirectFireControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor More...

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

	DtIndirectFireControllerDescriptor (const DtIndirectFireControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

DtIndirectFireControllerDescriptor &	operator= (const DtIndirectFireControllerDescriptor &orig)
	assignment More...

virtual	~DtIndirectFireControllerDescriptor ()
	destructor More...

virtual DtString	type () const
	Returns the type of component this descriptor describes. More...

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

virtual void	postGetSelf ()
	Updates default ammo lost with ammunition in targeting control table. More...


virtual const DtString &	weaponName () const
	Accessor/mutator for #myWeaponName. More...

virtual void	setWeaponName (const DtString &name)


virtual const DtRwStringList &	defaultAmmoList () const
	Accessor/mutator for myDefaultAmmoList. More...

virtual void	setDefaultAmmoList (const DtRwStringList &list)


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

virtual void	setNumRoundsPerMission (int numRoundsPerMission)


virtual bool	enforceRangeLimits () const
	Accessor/mutator for myEnforceRangeLimits. More...

virtual void	setEnforceRangeLimits (bool limit)


virtual bool	allowVelocityVariation () const
	Accessor/mutator for myAllowVelocityVariation. More...

virtual void	setAllowVelocityVariation (bool allow)


virtual const DtNLengthRealVector &	muzzleSpeedList () const
	Accessor/mutator for myMuzzleSpeedList. More...

virtual void	setMuzzleSpeedList (const DtNLengthRealVector &muzzleSpeeds)


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

virtual void	setRangeName (const DtString &rangeName)


virtual int	rangeId () const
	Accessor/mutator for myRangeId. More...

virtual void	setRangeId (int rangeId)

virtual bool	rangeIdIsSpecified () const


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

virtual void	setMinRange (DtReal minRange)


virtual DtReal	maxRange () const
	Accessor/mutator for myMaxRange. More...

virtual void	setMaxRange (DtReal maxRange)


virtual DtReal	minAltitude () const
	Accessor/mutator for myMinAltitude. More...

virtual void	setMinAltitude (DtReal minAlt)


virtual DtReal	maxAltitude () const
	Accessor/mutator for myMaxAltitude. More...

virtual void	setMaxAltitude (DtReal maxAlt)


virtual DtReal	preferredAltitude () const
	Accessor/mutator for myPreferredAltitude. More...

virtual void	setPreferredAltitude (DtReal prefAlt)


virtual bool	isDirectAlignmentCapable () const
	Accessor/mutator for myDirectAlignmentCapable. More...

virtual void	setIsDirectAlignmentCapable (bool direct)


virtual const DtTargetingControlTable &	targetingControlTable () const
	Accessor for myTargetingControlTable. More...

virtual DtTargetingControlTable &	targetingControlTable ()

Public Member Functions inherited from DtBaseWeaponControllerDescriptor
	DtBaseWeaponControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor More...

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

	DtBaseWeaponControllerDescriptor (const DtBaseWeaponControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

DtBaseWeaponControllerDescriptor &	operator= (const DtBaseWeaponControllerDescriptor &orig)
	assignment More...

virtual	~DtBaseWeaponControllerDescriptor ()
	destructor More...

virtual bool	preloadWeapon () const
	Accessor/mutator for myDoWeaponPreload. More...

virtual void	setPreloadWeapon (bool preloadWeapon)

virtual DtReal	maxVehicleSpeedToFire () const
	Accessor/mutator for myFireMaxVehicleSpeed. More...

virtual void	setMaxVehicleSpeedToFire (DtReal maxVehicleSpeedToFire)

virtual DtReal	maxAzimuthAngleOffBoresight () const
	Accessor/mutator for myMaxAzimuthAngleOffBoresight. More...

virtual void	setMaxAzimuthAngleOffBoresight (DtReal maxAngle)

virtual DtReal	maxElevationAngleOffBoresight () const
	Accessor/mutator for myMaxElevationAngleOffBoresight. More...

virtual void	setMaxElevationAngleOffBoresight (DtReal maxAngle)

virtual DtTime	loadAmmoTime () const
	Accessor/mutator for myLoadAmmoTime. More...

virtual void	setLoadAmmoTime (DtTime loadTime)

virtual DtTime	unloadAmmoTime () const
	Accessor/mutator for myUnloadAmmoTime. More...

virtual void	setUnloadAmmoTime (DtTime unloadTime)

virtual bool	disabledBySuppression () const
	Accessor/mutator for myDisabledBySuppression. More...

virtual void	setDisabledBySuppression (const bool isDisabled)

Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment More...

virtual	~DtComponentDescriptor ()

virtual void	putData (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type. More...

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored. More...

virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary. More...

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. More...

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)
	Accessor/mutator for myTickPeriodUsesRealTime. More...

virtual bool	tickPeriodUsesRealTime () const

virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR. More...

virtual void	setProcessStateRepositoryName (const DtString &name)

virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create. More...

virtual void	setProcessStateRepositoryType (const DtString &type)

virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not. More...

virtual bool	isEnabled () const

virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component. More...

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)
	Should the component be created or not. More...

virtual bool	createComponent () const

virtual void	setCreateOnRemoteObject (bool yesNo)
	Whether or not this component is created on remote versions of the object. More...

virtual bool	createOnRemoteObject () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. More...

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

virtual void	writeSelf (std::string &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. More...

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)
	Set read-only flag. More...

bool	isReadonly () const

virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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. More...

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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. More...

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here. More...

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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())
	Gets data from the environment value. More...

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

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)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory. More...

static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e. More...

static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class. More...

static DtComponentDescriptor *	creator ()

static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor. More...

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 ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Member Functions
	DtIndirectFireControllerDescriptor ()
	default constructor; not implemented More...

Protected Member Functions inherited from DtBaseWeaponControllerDescriptor
	DtBaseWeaponControllerDescriptor ()
	default constructor; not implemented More...

Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

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. More...

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). More...

DtRwBoolean	myEnforceRangeLimits
	Parameter Name: enforce-range-limits Parameter Description: User can choose to enforce minimum and maximum range limitations. More...

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

DtRwReal	myMaxRange
	Parameter Name: max-range Parameter Description: Maximum range of the weapon. More...

DtNLengthRealVector	myMuzzleSpeedList
	Parameter Name: muzzle-speed-list Parameter Description: Specifies a discrete list of muzzle speeds that are available for this weapon. More...

DtRwReal	myMinAltitude
	Parameter Name: min-altitude Parameter Description: Minimum altitude above the shooter or target (whichever is higher) that the peak of the trajectory will reach. More...

DtRwReal	myMaxAltitude
	Parameter Name: max-altitude Parameter Description: Maximum altitude above the shooter or target (whichever is higher) that the peak of the trajectory will reach. More...

DtRwReal	myPreferredAltitude
	Parameter Name: preferred-altitude Parameter Description: Preferred altitude above the shooter or target (whichever is higher) that the peak of the trajectory will reach. More...

DtRwString	myRangeName
	Parameter Name: range-name Parameter Description: Deprecated. More...

DtRwInt	myRangeId
	Parameter Name: range-id Parameter Description: The identifying value for this range ring. More...

DtRwString	myWeaponDisplayName
	Parameter Name: weapon-name Parameter Description: User friendly name associated this weapon. More...

DtRwBoolean	myDirectAlignmentCapable
	Parameter Name: capable-of-direct-alignment Parameter Description: Is this indirect fire weapon capable of directly aligning with close in targets. More...

DtRwBoolean	myAllowVelocityVariation
	Parameter Name: allow-velocity-variation In some instances the user might to define an initial muzzle speed or orientation. More...

DtTargetingControlTable	myTargetingControlTable
	Parameter Name: targeting-control-table Parameter Description: The table that will specify ammunition that is available to this controller and target priorities. More...

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. More...

DtRwReal	myMaxAzimuthAngleOffBoresight
	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. More...

DtRwReal	myMaxElevationAngleOffBoresight
	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. More...

DtRwReal	myMaxAngleOffBoresight
	Parameter Name: max-angle-off-boresight Parameter Description: NOTE: This parameter is deprecated. More...

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. More...

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. More...

DtRwTime	myUnloadAmmoTime
	Parameter Name: unload-ammo-time Parameter Description: The time is takes to remove ammo (of the wrong type, presumably) from the gun. More...

DtRwBoolean	myDisabledBySuppression
	Parameter Name: disabled-by-suppression Parameter Description: A boolean that indicates if this weapon should be disabled when the entity is suppressed. More...

Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component. More...

DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Average tick period for this component. More...

DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period. More...

DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick. More...

DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component. More...

DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository associated with this component. More...

DtRwBoolean	myIsEnabled
	Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not. More...

DtRwBoolean	myDebug
	This parameter defaults to false. More...

DtRwReal	myMinTaskVisualizationTickPeriod
	Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations. More...

DtRwBoolean	myTaskVisualizationsEnabled
	Parameter Name: task-visualizations-enabled Parameter Description: Whether this component's task visualizations are enabled. More...

DtRwBoolean	myCreateComponent

DtRwBoolean	myCreateOnRemoteObject
	Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local. More...

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
	Container for the aliases which represent alternative names for the object. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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

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

virtual const DtRwStringList& DtIndirectFireControllerDescriptor::defaultAmmoList ( ) const

virtual

Accessor/mutator for myDefaultAmmoList.

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

virtual

virtual int DtIndirectFireControllerDescriptor::numRoundsPerMission ( ) const

virtual

Accessor/mutator for myNumRoundsPerMission.

virtual void DtIndirectFireControllerDescriptor::setNumRoundsPerMission ( int numRoundsPerMission )

virtual

virtual bool DtIndirectFireControllerDescriptor::enforceRangeLimits ( ) const

virtual

Accessor/mutator for myEnforceRangeLimits.

virtual void DtIndirectFireControllerDescriptor::setEnforceRangeLimits ( bool limit )

virtual

virtual bool DtIndirectFireControllerDescriptor::allowVelocityVariation ( ) const

virtual

Accessor/mutator for myAllowVelocityVariation.

virtual void DtIndirectFireControllerDescriptor::setAllowVelocityVariation ( bool allow )

virtual

virtual const DtNLengthRealVector& DtIndirectFireControllerDescriptor::muzzleSpeedList ( ) const

virtual

Accessor/mutator for myMuzzleSpeedList.

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

virtual

virtual const DtString& DtIndirectFireControllerDescriptor::rangeName ( ) const

virtual

Accessor/mutator for myRangeName.

Deprecated

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

virtual

virtual int DtIndirectFireControllerDescriptor::rangeId ( ) const

virtual

Accessor/mutator for myRangeId.

virtual void DtIndirectFireControllerDescriptor::setRangeId ( int rangeId )

virtual

virtual bool DtIndirectFireControllerDescriptor::rangeIdIsSpecified ( ) const

virtual

virtual DtReal DtIndirectFireControllerDescriptor::minRange ( ) const

virtual

Accessor/mutator for myMinRange.

virtual void DtIndirectFireControllerDescriptor::setMinRange ( DtReal minRange )

virtual

virtual DtReal DtIndirectFireControllerDescriptor::maxRange ( ) const

virtual

Accessor/mutator for myMaxRange.

virtual void DtIndirectFireControllerDescriptor::setMaxRange ( DtReal maxRange )

virtual

virtual DtReal DtIndirectFireControllerDescriptor::minAltitude ( ) const

virtual

Accessor/mutator for myMinAltitude.

virtual void DtIndirectFireControllerDescriptor::setMinAltitude ( DtReal minAlt )

virtual

virtual DtReal DtIndirectFireControllerDescriptor::maxAltitude ( ) const

virtual

Accessor/mutator for myMaxAltitude.

virtual void DtIndirectFireControllerDescriptor::setMaxAltitude ( DtReal maxAlt )

virtual

virtual DtReal DtIndirectFireControllerDescriptor::preferredAltitude ( ) const

virtual

Accessor/mutator for myPreferredAltitude.

virtual void DtIndirectFireControllerDescriptor::setPreferredAltitude ( DtReal prefAlt )

virtual

virtual bool DtIndirectFireControllerDescriptor::isDirectAlignmentCapable ( ) const

virtual

Accessor/mutator for myDirectAlignmentCapable.

virtual void DtIndirectFireControllerDescriptor::setIsDirectAlignmentCapable ( bool direct )

virtual

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.

virtual const DtTargetingControlTable& DtIndirectFireControllerDescriptor::targetingControlTable ( ) const

virtual

Accessor for myTargetingControlTable.

virtual DtTargetingControlTable& DtIndirectFireControllerDescriptor::targetingControlTable ( )

virtual

virtual void DtIndirectFireControllerDescriptor::postGetSelf ( )

virtual

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

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfobjparam/indirectFireControllerDescriptor.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