DtBaseWeaponControllerDescriptor Class Reference

DtBaseWeaponControllerDescriptor; descriptor for the DtBaseWeaponController component. More...

Inheritance diagram for DtBaseWeaponControllerDescriptor:

List of all members.

Public Member Functions
	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 DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
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.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtBaseWeaponControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
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.

---

Detailed Description

DtBaseWeaponControllerDescriptor; descriptor for the DtBaseWeaponController component.

A DtComponentDescriptor that has additional information needed for providing parameters to an generic weapon controller.

End User Description: It contains load time, unload time, max speed at which the entity can fire and maneuver.

---

Constructor & Destructor Documentation

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

constructor

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

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

copy constructor

virtual DtBaseWeaponControllerDescriptor::~DtBaseWeaponControllerDescriptor

(

)

[virtual]

destructor

DtBaseWeaponControllerDescriptor::DtBaseWeaponControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtBaseWeaponControllerDescriptor& DtBaseWeaponControllerDescriptor::operator=

(

const DtBaseWeaponControllerDescriptor &

orig

)

assignment

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

DtBaseWeaponControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtIndirectFireControllerDescriptor, and DtWeaponControllerDescriptor.

virtual DtComponentDescriptor* DtBaseWeaponControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtIndirectFireControllerDescriptor, and DtWeaponControllerDescriptor.

virtual bool DtBaseWeaponControllerDescriptor::preloadWeapon

(

)

const [virtual]

Accessor/mutator for myDoWeaponPreload.

virtual void DtBaseWeaponControllerDescriptor::setPreloadWeapon

(

bool

preloadWeapon

)

[virtual]

Accessor/mutator for myDoWeaponPreload.

virtual DtReal DtBaseWeaponControllerDescriptor::maxVehicleSpeedToFire

(

)

const [virtual]

Accessor/mutator for myFireMaxVehicleSpeed.

virtual void DtBaseWeaponControllerDescriptor::setMaxVehicleSpeedToFire

(

DtReal

maxVehicleSpeedToFire

)

[virtual]

Accessor/mutator for myFireMaxVehicleSpeed.

virtual DtReal DtBaseWeaponControllerDescriptor::maxAngleOffBoresight

(

)

const [virtual]

Accessor/mutator for myMaxAngleOffBoresight.

virtual void DtBaseWeaponControllerDescriptor::setMaxAngleOffBoresight

(

DtReal

maxAngleOffBoresight

)

[virtual]

Accessor/mutator for myMaxAngleOffBoresight.

virtual DtTime DtBaseWeaponControllerDescriptor::loadAmmoTime

(

)

const [virtual]

Accessor/mutator for myLoadAmmoTime.

virtual void DtBaseWeaponControllerDescriptor::setLoadAmmoTime

(

DtTime

loadTime

)

[virtual]

Accessor/mutator for myLoadAmmoTime.

virtual DtTime DtBaseWeaponControllerDescriptor::unloadAmmoTime

(

)

const [virtual]

Accessor/mutator for myUnloadAmmoTime.

virtual void DtBaseWeaponControllerDescriptor::setUnloadAmmoTime

(

DtTime

unloadTime

)

[virtual]

Accessor/mutator for myUnloadAmmoTime.

static DtComponentDescriptor* DtBaseWeaponControllerDescriptor::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 DtIndirectFireControllerDescriptor, and DtWeaponControllerDescriptor.

---

Member Data Documentation

DtRwReal DtBaseWeaponControllerDescriptor::myFireMaxVehicleSpeed [protected]

Parameter Name: max-vehicle-speed-to-fire
Parameter Description: Some vehicles must stop to shoot, others have a maximum speed to launch a munition.

This is the maximum speed the vehicle can be moving when it fires this weapon. If 0, vehicle has to stop to fire.
Parameter Default Value: 500.0
Parameter Units: meters/second

DtRwReal DtBaseWeaponControllerDescriptor::myMaxAngleOffBoresight [protected]

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.

This method allows the user to set the maximum number of radians off of boresight the target can be and still reasonably fire the weapon. This margin is used in both azimuth and elevation.
Parameter Default Value: 0.005
Parameter Units: radians

DtRwBoolean DtBaseWeaponControllerDescriptor::myDoWeaponPreload [protected]

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.

Parameter Default Value: False

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

---

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

• include/vrfobjparam/basWpnCtlDesc.h