DtBallisticGunControllerDescriptor Class Reference

DtBallisticGunControllerDescriptor, descriptor for the DtBallisticGunController component. More...

Inheritance diagram for DtBallisticGunControllerDescriptor:

List of all members.

Public Member Functions
	DtBallisticGunControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtBallisticGunControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBallisticGunControllerDescriptor (const DtBallisticGunControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtBallisticGunControllerDescriptor &	operator= (const DtBallisticGunControllerDescriptor &orig)
	assignment
virtual	~DtBallisticGunControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
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.
virtual int	roundsPerTriggerPull () const
virtual void	setRoundsPerTriggerPull (int value)
virtual const DtAmmoSelectTable &	ammoSelectTable () const
	Accessor/mutator for myAmmoSelectTable.
virtual void	setAmmoSelectTable (const DtAmmoSelectTable &table)
	Accessor/mutator for myAmmoSelectTable.
virtual const DtString &	ammoSelectTableFilename ()
	Accessor/mutator for myAmmoSelectTableFile.
virtual void	setAmmoSelectTableFilename (const DtString &filename)
	Accessor/mutator for myAmmoSelectTableFile.
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
	DtBallisticGunControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
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.
DtReaderWriterFile	myAmmoSelectTableFile
	Parameter Name: ammo-select-table-file Parameter Description: Sets the filename used for the ammo select table.
DtAmmoSelectTable	myAmmoSelectTable
	Parameter Name: ammo-select-table Parameter Description: Table of target types versus lists of prioritized munition types to use against a given target type.
DtRwInt	myRoundsPerTriggerPull
	Parameter Name: rounds-per-trigger-pull Parameter Description: The number of rounds to fire for each single trigger pull.
DtTargetSelectionCriteria	myTargetSelectionCriteria
	Parameter Name: targeting-control Parameter Description: List of DtTargetSelectionCriteria objects, that hold target selection criteria for a given weapon system.

---

Detailed Description

DtBallisticGunControllerDescriptor, descriptor for the DtBallisticGunController component.

A DtComponentDescriptor that has additional information needed for providing parameters to a generic ballistic gun controller. In contains load time, unload time, and an ammo selection table.

---

Constructor & Destructor Documentation

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

constructor

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

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

copy constructor

virtual DtBallisticGunControllerDescriptor::~DtBallisticGunControllerDescriptor

(

)

[virtual]

destructor

DtBallisticGunControllerDescriptor::DtBallisticGunControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtBallisticGunControllerDescriptor& DtBallisticGunControllerDescriptor::operator=

(

const DtBallisticGunControllerDescriptor &

orig

)

assignment

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

DtBalGunControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtBallisticGunJoyControllerDescriptor, and DtElevatingBallisticGunControllerDescriptor.

virtual DtComponentDescriptor* DtBallisticGunControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtElevatingBallisticGunControllerDescriptor, and DtBallisticGunJoyControllerDescriptor.

virtual DtTime DtBallisticGunControllerDescriptor::loadAmmoTime

(

)

const [virtual]

Accessor/mutator for myLoadAmmoTime.

virtual void DtBallisticGunControllerDescriptor::setLoadAmmoTime

(

DtTime

loadTime

)

[virtual]

Accessor/mutator for myLoadAmmoTime.

virtual DtTime DtBallisticGunControllerDescriptor::unloadAmmoTime

(

)

const [virtual]

Accessor/mutator for myUnloadAmmoTime.

virtual void DtBallisticGunControllerDescriptor::setUnloadAmmoTime

(

DtTime

unloadTime

)

[virtual]

Accessor/mutator for myUnloadAmmoTime.

virtual int DtBallisticGunControllerDescriptor::roundsPerTriggerPull

(

)

const [virtual]

See also:

myRoundsPerTriggerPull.

virtual void DtBallisticGunControllerDescriptor::setRoundsPerTriggerPull

(

int

value

)

[virtual]

See also:

myRoundsPerTriggerPull.

virtual const DtAmmoSelectTable& DtBallisticGunControllerDescriptor::ammoSelectTable

(

)

const [virtual]

Accessor/mutator for myAmmoSelectTable.

virtual void DtBallisticGunControllerDescriptor::setAmmoSelectTable

(

const DtAmmoSelectTable &

table

)

[virtual]

Accessor/mutator for myAmmoSelectTable.

virtual const DtString& DtBallisticGunControllerDescriptor::ammoSelectTableFilename

(

)

[virtual]

Accessor/mutator for myAmmoSelectTableFile.

virtual void DtBallisticGunControllerDescriptor::setAmmoSelectTableFilename

(

const DtString &

filename

)

[virtual]

Accessor/mutator for myAmmoSelectTableFile.

virtual DtTargetSelectionCriteria& DtBallisticGunControllerDescriptor::targetSelectionCriteria

(

)

[virtual]

Accessor/mutator for myTargetSelectionCriteria.

virtual const DtTargetSelectionCriteria& DtBallisticGunControllerDescriptor::targetSelectionCriteria

(

)

const [virtual]

Accessor/mutator for myTargetSelectionCriteria.

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

Reimplemented in DtBallisticGunJoyControllerDescriptor, and DtElevatingBallisticGunControllerDescriptor.

---

Member Data Documentation

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

DtReaderWriterFile DtBallisticGunControllerDescriptor::myAmmoSelectTableFile [protected]

Parameter Name: ammo-select-table-file
Parameter Description: Sets the filename used for the ammo select table.

Parameter Default Value: ""

DtAmmoSelectTable DtBallisticGunControllerDescriptor::myAmmoSelectTable [protected]

Parameter Name: ammo-select-table
Parameter Description: Table of target types versus lists of prioritized munition types to use against a given target type.

Parameter Default Value:

DtRwInt DtBallisticGunControllerDescriptor::myRoundsPerTriggerPull [protected]

Parameter Name: rounds-per-trigger-pull
Parameter Description: The number of rounds to fire for each single trigger pull.

This affects how many rounds a depleted from the resource stores, and the value of the quantity field in the fire/detonate interaction.
Parameter Default Value: 1
Parameter Units: Number.

DtTargetSelectionCriteria DtBallisticGunControllerDescriptor::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/balGunCtlDesc.h