DtTurretAcquireControllerDescriptor Class Reference

A DtComponentDescriptor that has a flag to indicate whether or not line of sight should be checked, and a fire-now-timeout parameter for determining when to give up on a fire now command when the turret cannot be properly positioned for firing. More...

Inheritance diagram for DtTurretAcquireControllerDescriptor:

List of all members.

Public Member Functions
	DtTurretAcquireControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtTurretAcquireControllerDescriptor (const DtTurretAcquireControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtTurretAcquireControllerDescriptor &	operator= (const DtTurretAcquireControllerDescriptor &orig)
	assignment operator
virtual	~DtTurretAcquireControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	checkLOS () const
	Accessor/mutator for myCheckLOS.
virtual void	setCheckLOS (bool checkLOSFlag)
	Accessor/mutator for myCheckLOS.
virtual bool	trackBySignature () const
	Accessor/mutator for myTrackBySignature.
virtual void	setTrackBySignature (bool trackBySig)
	Accessor/mutator for myTrackBySignature.
virtual DtSymbolString	trackSignatureDomain () const
	Accessor/mutator for myTrackSignatureDomain.
virtual void	setTrackSignatureDomain (DtSymbolString domain)
	Accessor/mutator for myTrackSignatureDomain.
virtual double	minTrackSignature () const
	Accessor/mutator for myMinTrackSignature.
virtual void	setMinTrackSignature (double minSig)
	Accessor/mutator for myMinTrackSignature.
virtual double	maxAlignmentAngle () const
	Accessor/mutator for myMinTrackSignature.
virtual void	setMaxAlightmentAngle (double angle)
	Accessor/mutator for myMinTrackSignature.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtTurretAcquireControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myCheckLOS
	Parameter Name: check-LOS Parameter Description: Determines whether any checks are done to see if the target is visible each tick.
DtRwBoolean	myTrackBySignature
	Parameter Name: track-by-signature Parameter Description: Determines whether the acquire controller should use the sensor signature system to track its current target.
DtRwString	myTrackSignatureDomain
	Parameter Name: track-signature-domain Parameter Description: The signature domain to be used to track targets if track-by-signature is True.
DtRwReal	myMinTrackSignature
	Parameter Name: min-track-signature Parameter Description: The minimum apparent signature (in the domain specified by track-signature-domain) for tracking a target when track-by-signature is true.
DtRwReal	myMaxAlignmentAngle
	Parameter Name: max-alignment-angle Parameter Description: The maximum angle that between the turret and the direction to the target which will be considered aligned with the the target.

---

Detailed Description

A DtComponentDescriptor that has a flag to indicate whether or not line of sight should be checked, and a fire-now-timeout parameter for determining when to give up on a fire now command when the turret cannot be properly positioned for firing.

The ability to turn off line-of-sight checking allows you to use the turret acquire controller with missiles that do not have to be able to see a target in order to fire at it. Use the checkLOS() member function to find the current line-of-sight setting and setCheckLOS() to set it. The default is true. The "fire-now-timeout" is the amount of time before a fire now command is considered to have failed if the DtTurretAcquireController cannot properly position the turret.

---

Constructor & Destructor Documentation

DtTurretAcquireControllerDescriptor::DtTurretAcquireControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtTurretAcquireControllerDescriptor::DtTurretAcquireControllerDescriptor	(	const DtTurretAcquireControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtTurretAcquireControllerDescriptor::~DtTurretAcquireControllerDescriptor

(

)

[virtual]

destructor

DtTurretAcquireControllerDescriptor::DtTurretAcquireControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtTurretAcquireControllerDescriptor& DtTurretAcquireControllerDescriptor::operator=

(

const DtTurretAcquireControllerDescriptor &

orig

)

assignment operator

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

DtTurretAcquireControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual bool DtTurretAcquireControllerDescriptor::checkLOS

(

)

const [virtual]

Accessor/mutator for myCheckLOS.

virtual void DtTurretAcquireControllerDescriptor::setCheckLOS

(

bool

checkLOSFlag

)

[virtual]

Accessor/mutator for myCheckLOS.

virtual bool DtTurretAcquireControllerDescriptor::trackBySignature

(

)

const [virtual]

Accessor/mutator for myTrackBySignature.

virtual void DtTurretAcquireControllerDescriptor::setTrackBySignature

(

bool

trackBySig

)

[virtual]

Accessor/mutator for myTrackBySignature.

virtual DtSymbolString DtTurretAcquireControllerDescriptor::trackSignatureDomain

(

)

const [virtual]

Accessor/mutator for myTrackSignatureDomain.

virtual void DtTurretAcquireControllerDescriptor::setTrackSignatureDomain

(

DtSymbolString

domain

)

[virtual]

Accessor/mutator for myTrackSignatureDomain.

virtual double DtTurretAcquireControllerDescriptor::minTrackSignature

(

)

const [virtual]

Accessor/mutator for myMinTrackSignature.

virtual void DtTurretAcquireControllerDescriptor::setMinTrackSignature

(

double

minSig

)

[virtual]

Accessor/mutator for myMinTrackSignature.

virtual double DtTurretAcquireControllerDescriptor::maxAlignmentAngle

(

)

const [virtual]

Accessor/mutator for myMinTrackSignature.

virtual void DtTurretAcquireControllerDescriptor::setMaxAlightmentAngle

(

double

angle

)

[virtual]

Accessor/mutator for myMinTrackSignature.

virtual DtComponentDescriptor* DtTurretAcquireControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

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

---

Member Data Documentation

DtRwBoolean DtTurretAcquireControllerDescriptor::myCheckLOS [protected]

Parameter Name: check-LOS
Parameter Description: Determines whether any checks are done to see if the target is visible each tick.

If false, any target that is provided on the input port is assumed to be trackable and visible.
Parameter Default Value: True.

DtRwBoolean DtTurretAcquireControllerDescriptor::myTrackBySignature [protected]

Parameter Name: track-by-signature
Parameter Description: Determines whether the acquire controller should use the sensor signature system to track its current target.

Set to False when using turret-acquire with the Target Detection Sensor, and to True when using with the Signature Object Sensor.
Parameter Default Value: True

DtRwString DtTurretAcquireControllerDescriptor::myTrackSignatureDomain [protected]

Parameter Name: track-signature-domain
Parameter Description: The signature domain to be used to track targets if track-by-signature is True.

Ignored otherwise.
Parameter Default Value: "visual"

DtRwReal DtTurretAcquireControllerDescriptor::myMinTrackSignature [protected]

Parameter Name: min-track-signature
Parameter Description: The minimum apparent signature (in the domain specified by track-signature-domain) for tracking a target when track-by-signature is true.

Parameter Default Value: 0.5
Parameter Units: Signature value.

DtRwReal DtTurretAcquireControllerDescriptor::myMaxAlignmentAngle [protected]

Parameter Name: max-alignment-angle
Parameter Description: The maximum angle that between the turret and the direction to the target which will be considered aligned with the the target.

The gun system will only fire when the turret is aligned with the target.
Parameter Default Value: 0.15
Parameter Units: Radians.

---

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

• include/vrfobjparam/turAcqDesc.h