DtTargetAcquireCriteria Class Reference

DtTargetAcquireCriteria–Criteria for acquiring a target.

Defines a criteria for acquiring targets for a single weapon system. This class stores all the information about the criteria needed for a target to be acquired by the weapon system.

Inheritance diagram for DtTargetAcquireCriteria:

Public Member Functions
	DtTargetAcquireCriteria (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtTargetAcquireCriteria (const DtTargetAcquireCriteria &orig, DtReaderWriterRegistry *parentRegistry=0)
DtTargetAcquireCriteria &	operator= (const DtTargetAcquireCriteria &orig)
virtual	~DtTargetAcquireCriteria ()
bool	operator== (const DtTargetAcquireCriteria &) const
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual void	setEntityType (const DtEntityType &entityType)
virtual const DtRwEntityType &	entityType () const
virtual bool	checkSpeed () const
virtual void	setCheckSpeed (bool checkSpeed)
virtual bool	checkAngleToTarget () const
virtual void	setCheckAngleToTarget (bool checkAngle)
virtual bool	checkElevation () const
virtual void	setCheckElevation (bool checkElev)
virtual double	timeToAcquire () const
virtual void	setTimeToAcquire (double time)
virtual double	maxTargetSpeedToAcquire () const
virtual void	setMaxTargetSpeedToAcquire (double speed)
virtual double	maxElevAngleToAcquire () const
virtual void	setMaxElevAngleToAcquire (double angle)
virtual double	maxElevToAcquire () const
virtual void	setMaxElevToAcquire (double elev)
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 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	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 const char *	theXmlType ()
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 Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwEntityType	myEntityType
DtRwReal	myTimeToAcquireTarget
DtRwBoolean	myCheckSpeed
DtRwReal	myMaxTargetSpeedToAcquire
DtRwBoolean	myCheckAngleToTarget
DtRwReal	myMaxElevAngleToAcuire
DtRwBoolean	myCheckElevation
DtRwReal	myMaxElevationToAcquire
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 )()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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

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

constructor

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

copy constructor

virtual DtTargetAcquireCriteria::~DtTargetAcquireCriteria ( )

virtual

destructor

Member Function Documentation

DtTargetAcquireCriteria& DtTargetAcquireCriteria::operator=

(

const DtTargetAcquireCriteria &

orig

)

assignment

virtual void DtTargetAcquireCriteria::setEntityType ( const DtEntityType &  entityType )

virtual

Accessor/mutator for myEntityType.

virtual const DtRwEntityType& DtTargetAcquireCriteria::entityType ( ) const

virtual

Accessor/mutator for myEntityType.

virtual bool DtTargetAcquireCriteria::checkSpeed ( ) const

virtual

Accessor/mutator for myCheckSpeed.

virtual void DtTargetAcquireCriteria::setCheckSpeed ( bool  checkSpeed )

virtual

Accessor/mutator for myCheckSpeed.

virtual bool DtTargetAcquireCriteria::checkAngleToTarget ( ) const

virtual

Accessor/mutator for myCheckAngleToTarget.

virtual void DtTargetAcquireCriteria::setCheckAngleToTarget ( bool  checkAngle )

virtual

Accessor/mutator for myCheckAngleToTarget.

virtual bool DtTargetAcquireCriteria::checkElevation ( ) const

virtual

Accessor/mutator for myCheckElevation.

virtual void DtTargetAcquireCriteria::setCheckElevation ( bool  checkElev )

virtual

Accessor/mutator for myCheckElevation.

virtual double DtTargetAcquireCriteria::timeToAcquire ( ) const

virtual

Accessor/mutator for myTimeToAcquireTarget.

virtual void DtTargetAcquireCriteria::setTimeToAcquire ( double  time )

virtual

Accessor/mutator for myTimeToAcquireTarget.

virtual double DtTargetAcquireCriteria::maxTargetSpeedToAcquire ( ) const

virtual

Accessor/mutator for myMaxTargetSpeedToAcquire.

virtual void DtTargetAcquireCriteria::setMaxTargetSpeedToAcquire ( double  speed )

virtual

Accessor/mutator for myMaxTargetSpeedToAcquire.

virtual double DtTargetAcquireCriteria::maxElevAngleToAcquire ( ) const

virtual

Accessor/mutator for myMaxElevAngleToAcuire.

virtual void DtTargetAcquireCriteria::setMaxElevAngleToAcquire ( double  angle )

virtual

Accessor/mutator for myMaxElevAngleToAcuire.

virtual double DtTargetAcquireCriteria::maxElevToAcquire ( ) const

virtual

Accessor/mutator for myMaxElevationToAcquire.

virtual void DtTargetAcquireCriteria::setMaxElevToAcquire ( double  elev )

virtual

Accessor/mutator for myMaxElevationToAcquire.

bool DtTargetAcquireCriteria::operator==

(

const DtTargetAcquireCriteria &

)

const

virtual const char* DtTargetAcquireCriteria::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

static const char* DtTargetAcquireCriteria::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* DtTargetAcquireCriteria::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

Member Data Documentation

DtRwEntityType DtTargetAcquireCriteria::myEntityType

protected

Parameter Name: entity-type
Parameter Description: DIS/RPR enumerated entity type associated with priority value.
Parameter Default Value:

DtRwReal DtTargetAcquireCriteria::myTimeToAcquireTarget

protected

Parameter Name: time-to-acquire
Parameter Description: Specifies the time needed to acquire the target. Some weapons like launchers need some time to acquire the target before they can fire.
Parameter Default Value: 0.0
Parameter Units: Seconds
.

DtRwBoolean DtTargetAcquireCriteria::myCheckSpeed

protected

Parameter Name: check-maximum-speed-to-acquire
Parameter Description: Specifies whether this entity's ability to acquire the target is constrained by the target's speed. Acquiring a target that is moving at its top speed is much more difficult that if the target is stationary. Set to false if there is no need to check.
Parameter Default Value: True
.

DtRwReal DtTargetAcquireCriteria::myMaxTargetSpeedToAcquire

protected

Parameter Name: max-speed-of-target
Parameter Description: Maximum speed the target can be moving at and still be acquired
Parameter Default Value: 10.0
Parameter Units: Meters/second.

DtRwBoolean DtTargetAcquireCriteria::myCheckAngleToTarget

protected

Parameter Name: check-elevation-angle-to-acquire
Parameter Description: Specifies whether this entity is restrained by the angle between it and it's target in the Z-plane, i.e trying to acquire air targets or if the entity is on the top of a building and trying to acquire targets directly below it. Set to false if there is no need to check.
Parameter Default Value: False
.

DtRwReal DtTargetAcquireCriteria::myMaxElevAngleToAcuire

protected

Parameter Name: max-elevation-angle-to-acquire
Parameter Description: Maximum angle between where the entity is and where the target is in the Z-plane. For example a DI with some kind of launcher would not be able to shoot anything that is directly above his head.
Parameter Default Value: 1.5 –Directly overhead
Parameter Units: Radians
.

DtRwBoolean DtTargetAcquireCriteria::myCheckElevation

protected

Parameter Name: check-elevation-to-acquire
Parameter Description: Specifies whether this entity is restrained by elevation in it's abilities to acquire the target. Set to false if there is no need to check.
Parameter Default Value: False
.

DtRwReal DtTargetAcquireCriteria::myMaxElevationToAcquire

protected

Parameter Name: max-elevation-to-acquire
Parameter Description: The maxium elevation of the target relative to the entity in which the entity can still acquire the target and have a reasonable chance of hitting it.
Parameter Default Value: set to maxium range of weapon we are acquiring for.
Parameter Units: meters
.

---

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

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