DtWeaponControllerDescriptor Class Reference

DtWeaponControllerDescriptor; descriptor for the DtWeaponController component. More...

Inheritance diagram for DtWeaponControllerDescriptor:

List of all members.

Public Member Functions
	DtWeaponControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtWeaponControllerDescriptor (const DtWeaponControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtWeaponControllerDescriptor &	operator= (const DtWeaponControllerDescriptor &orig)
	assignment
virtual	~DtWeaponControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual const DtAmmoSelectTable &	ammoSelectTable () const
	Accessor/mutator for myAmmoSelectTable.
virtual void	setAmmoSelectTable (const DtAmmoSelectTable &table)
	Accessor/mutator for myAmmoSelectTable.
virtual void	setAmmoSelectTableFilename (const DtString &filename)
	Accessor/mutator for myAmmoSelectTableFile.
virtual const DtString &	ammoSelectTableFilename ()
	Accessor/mutator for myAmmoSelectTableFile.
virtual const DtString &	rangeName () const
	Accessor/mutator for myRangeName.
virtual void	setRangeName (const DtString &rangeName)
	Accessor/mutator for myRangeName.
virtual DtTargetSelectionCriteria &	targetSelectionCriteria ()
	Accessor/mutator for myTargetSelectionCriteria.
virtual const DtTargetSelectionCriteria &	targetSelectionCriteria () const
	Accessor/mutator for myTargetSelectionCriteria.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtWeaponControllerDescriptor ()
	default constructor
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtReaderWriterFile	myAmmoSelectTableFile
	Parameter Name: ammo-select-table-file Parameter Description: Filename used for the ammo select table.
DtAmmoSelectTable	myAmmoSelectTable
	Parameter Name: ammo-select-table Parameter Description: Table that provides a list of munitions that are appropriate for specific target types.
DtRwString	myRangeName
	Parameter Name: range-name Parameter Description: Text name used when displaying the range ring or weapon name of this weapon in the VRF GUI.
DtTargetSelectionCriteria	myTargetSelectionCriteria
	Parameter Name: targeting-control Parameter Description: List of DtTargetSelectionCriteria objects, that hold target selection criteria for a given weapon system.

---

Detailed Description

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.

---

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 DtTargetSelectionCriteria& DtWeaponControllerDescriptor::targetSelectionCriteria

(

)

[virtual]

Accessor/mutator for myTargetSelectionCriteria.

virtual const DtTargetSelectionCriteria& DtWeaponControllerDescriptor::targetSelectionCriteria

(

)

const [virtual]

Accessor/mutator for myTargetSelectionCriteria.

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.

Reimplemented from DtBaseWeaponControllerDescriptor.

---

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: Text name used when displaying the range ring or weapon name of this weapon in the VRF GUI.

Parameter Default Value: Blank String

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:

---

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

• include/vrfobjparam/weaponCtlDesc.h