DtIndividualLifeformAcquireDescriptor Class Reference

DtIndividualLifeformAcquireDescriptor; descriptor for the DtIndividualLifeformAcquireComponent component. More...

Inheritance diagram for DtIndividualLifeformAcquireDescriptor:

List of all members.

Public Member Functions
	DtIndividualLifeformAcquireDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
virtual	~DtIndividualLifeformAcquireDescriptor ()
	destructor
	DtIndividualLifeformAcquireDescriptor (const DtIndividualLifeformAcquireDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtIndividualLifeformAcquireDescriptor &	operator= (const DtIndividualLifeformAcquireDescriptor &orig)
	assignment operator
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual const DtString &	weaponProcessStateRepositoryName () const
	Accessor/mutator for myWeaponProcessStateRepositoryName.
virtual void	setWeaponProcessStateRepositoryName (const DtString &name)
	Accessor/mutator for myWeaponProcessStateRepositoryName.
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.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myWeaponProcessStateRepositoryName
	Parameter Name: weapon-process-state-repository-name Parameter Description: Name that this component will assign to its weapon PSR.
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.

---

Detailed Description

DtIndividualLifeformAcquireDescriptor; descriptor for the DtIndividualLifeformAcquireComponent component.

Instances of DtIndividualLifeformAcquireDescriptor are used to specify the parameters for a DtIndividualLifeformAcquireComponent object.

---

Constructor & Destructor Documentation

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

constructor

virtual DtIndividualLifeformAcquireDescriptor::~DtIndividualLifeformAcquireDescriptor

(

)

[virtual]

destructor

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

copy constructor

---

Member Function Documentation

DtIndividualLifeformAcquireDescriptor& DtIndividualLifeformAcquireDescriptor::operator=

(

const DtIndividualLifeformAcquireDescriptor &

orig

)

assignment operator

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

DtIndividualLifeformAcquireDescriptorType

Reimplemented from DtGroundMoveToDescriptor.

Reimplemented in DtIndLifeformLauncherAcquireDescriptor.

virtual DtComponentDescriptor* DtIndividualLifeformAcquireDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtGroundMoveToDescriptor.

Reimplemented in DtIndLifeformLauncherAcquireDescriptor.

virtual const DtString& DtIndividualLifeformAcquireDescriptor::weaponProcessStateRepositoryName

(

)

const [virtual]

Accessor/mutator for myWeaponProcessStateRepositoryName.

virtual void DtIndividualLifeformAcquireDescriptor::setWeaponProcessStateRepositoryName

(

const DtString &

name

)

[virtual]

Accessor/mutator for myWeaponProcessStateRepositoryName.

virtual bool DtIndividualLifeformAcquireDescriptor::checkLOS

(

)

const [virtual]

Accessor/mutator for myCheckLOS.

virtual void DtIndividualLifeformAcquireDescriptor::setCheckLOS

(

bool

checkLOSFlag

)

[virtual]

Accessor/mutator for myCheckLOS.

virtual bool DtIndividualLifeformAcquireDescriptor::trackBySignature

(

)

const [virtual]

Accessor/mutator for myTrackBySignature.

virtual void DtIndividualLifeformAcquireDescriptor::setTrackBySignature

(

bool

trackBySig

)

[virtual]

Accessor/mutator for myTrackBySignature.

virtual DtSymbolString DtIndividualLifeformAcquireDescriptor::trackSignatureDomain

(

)

const [virtual]

Accessor/mutator for myTrackSignatureDomain.

virtual void DtIndividualLifeformAcquireDescriptor::setTrackSignatureDomain

(

DtSymbolString

domain

)

[virtual]

Accessor/mutator for myTrackSignatureDomain.

virtual double DtIndividualLifeformAcquireDescriptor::minTrackSignature

(

)

const [virtual]

Accessor/mutator for myMinTrackSignature.

virtual void DtIndividualLifeformAcquireDescriptor::setMinTrackSignature

(

double

minSig

)

[virtual]

Accessor/mutator for myMinTrackSignature.

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

Reimplemented in DtIndLifeformLauncherAcquireDescriptor.

---

Member Data Documentation

DtRwString DtIndividualLifeformAcquireDescriptor::myWeaponProcessStateRepositoryName [protected]

Parameter Name: weapon-process-state-repository-name
Parameter Description: Name that this component will assign to its weapon PSR.

Parameter Default Value:

DtRwBoolean DtIndividualLifeformAcquireDescriptor::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. Otherwise targets are checked based on track-by-signature.
Parameter Default Value: True.

DtRwBoolean DtIndividualLifeformAcquireDescriptor::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 DtIndividualLifeformAcquireDescriptor::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 DtIndividualLifeformAcquireDescriptor::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.

---

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

• include/vrfobjparam/indLifeformAcquireDesc.h