DtIndirectFireControllerDescriptor Class Reference

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

Inheritance diagram for DtIndirectFireControllerDescriptor:

List of all members.

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 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.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtIndirectFireControllerDescriptor ()
	default constructor; not implemented
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.

---

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

---

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

• include/vrfobjparam/iFireCtlDesc.h