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.
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.

Inheritance diagram for DtTurretAcquireControllerDescriptor:

Public Member Functions
	DtTurretAcquireControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtTurretAcquireControllerDescriptor (const DtTurretAcquireControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtTurretAcquireControllerDescriptor &	operator= (const DtTurretAcquireControllerDescriptor &orig)
virtual	~DtTurretAcquireControllerDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	checkLOS () const
virtual void	setCheckLOS (bool checkLOSFlag)
virtual bool	trackBySignature () const
virtual void	setTrackBySignature (bool trackBySig)
virtual DtSymbolString	trackSignatureDomain () const
virtual void	setTrackSignatureDomain (DtSymbolString domain)
virtual double	minTrackSignature () const
virtual void	setMinTrackSignature (double minSig)
virtual double	maxAlignmentAngle () const
virtual void	setMaxAlightmentAngle (double angle)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	init ()
virtual const DtString &	stateAndParameterDataPrefix () const
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
virtual const DtString &	componentType () const
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setPeriodicTickWhilePaused (bool value)
virtual bool	periodicTickWhilePaused () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setIsEnabledForClutterEntities (bool yesNo)
virtual bool	isEnabledForClutterEntities () const
virtual void	setDebugActive (bool active)
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setTaskVisualizationsEnabled (bool enabled)
virtual bool	taskVisualizationsEnabled () const
virtual void	setCreateComponent (bool yesNo)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
virtual const DtRwProperties &	parameterData () const
virtual DtRwProperties &	parameterData ()
virtual const DtRwProperties &	stateData () const
virtual DtRwProperties &	stateData ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
static void	setFactory (DtComponentDescriptorFactory *factory)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
	DtTurretAcquireControllerDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myCheckLOS
DtRwBoolean	myTrackBySignature
DtRwString	myTrackSignatureDomain
DtRwReal	myMinTrackSignature
DtRwReal	myMaxAlignmentAngle
Protected Attributes inherited from DtComponentDescriptor
bool	myPrefixAppliedToStateAndParamData
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myPeriodicTickWhilePaused
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myIsEnabledForClutterEntities
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwProperties	myParameterData
DtRwProperties	myStateData
DtRwString	myStateAndParameterDataPrefix
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

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.

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/turretAcquireControllerDescriptor.h