DtTargetAcquireCriteria Class Reference

DtTargetAcquireCriteria–Criteria for acquiring a target. More...

Inheritance diagram for DtTargetAcquireCriteria:

Public Member Functions
	DtTargetAcquireCriteria (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor More...
	DtTargetAcquireCriteria (const DtTargetAcquireCriteria &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor More...
DtTargetAcquireCriteria &	operator= (const DtTargetAcquireCriteria &orig)
	assignment More...
virtual	~DtTargetAcquireCriteria ()
	destructor More...
bool	operator== (const DtTargetAcquireCriteria &) const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...
virtual const char *	xmlType () const
virtual void	setEntityType (const DtEntityType &entityType)
	Accessor/mutator for myEntityType. More...
virtual const DtRwEntityType &	entityType () const
virtual bool	checkSpeed () const
	Accessor/mutator for myCheckSpeed. More...
virtual void	setCheckSpeed (bool checkSpeed)
virtual bool	checkAngleToTarget () const
	Accessor/mutator for myCheckAngleToTarget. More...
virtual void	setCheckAngleToTarget (bool checkAngle)
virtual bool	checkElevation () const
	Accessor/mutator for myCheckElevation. More...
virtual void	setCheckElevation (bool checkElev)
virtual double	timeToAcquire () const
	Accessor/mutator for myTimeToAcquireTarget. More...
virtual void	setTimeToAcquire (double time)
virtual double	maxTargetSpeedToAcquire () const
	Accessor/mutator for myMaxTargetSpeedToAcquire. More...
virtual void	setMaxTargetSpeedToAcquire (double speed)
virtual double	maxElevAngleToAcquire () const
	Accessor/mutator for myMaxElevAngleToAcuire. More...
virtual void	setMaxElevAngleToAcquire (double angle)
virtual double	maxElevToAcquire () const
	Accessor/mutator for myMaxElevationToAcquire. More...
virtual void	setMaxElevToAcquire (double elev)
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...
bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor More...
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. More...
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More...
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag. More...
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...
virtual void	setName (const DtString &)
	Set the name of the object. More...
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain. More...
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More...
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here. More...
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...
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())
	Gets data from the environment value. More...
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...
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 ()
	The type that is used when archiving to an XML stream. More...
static const DtFilename &	appPath ()
	Gets the current working directory. More...
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...
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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwEntityType	myEntityType
	Parameter Name: entity-type Parameter Description: DIS/RPR enumerated entity type associated with priority value. More...
DtRwReal	myTimeToAcquireTarget
	Parameter Name: time-to-acquire Parameter Description: Specifies the time needed to acquire the target. More...
DtRwBoolean	myCheckSpeed
	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. More...
DtRwReal	myMaxTargetSpeedToAcquire
	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. More...
DtRwBoolean	myCheckAngleToTarget
	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. More...
DtRwReal	myMaxElevAngleToAcuire
	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. More...
DtRwBoolean	myCheckElevation
	Parameter Name: check-elevation-to-acquire Parameter Description: Specifies whether this entity is restrained by elevation in it's abilities to acquire the target. More...
DtRwReal	myMaxElevationToAcquire
	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. More...
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
	Container for the aliases which represent alternative names for the object. More...
bool	myInvalid
	Set to true if there is a problem reading this item. More...
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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)
	Copies values from the specified DtReaderWriter. More...
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

Detailed Description

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.

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

virtual bool DtTargetAcquireCriteria::checkSpeed ( ) const

virtual

Accessor/mutator for myCheckSpeed.

virtual void DtTargetAcquireCriteria::setCheckSpeed ( bool  checkSpeed )

virtual

virtual bool DtTargetAcquireCriteria::checkAngleToTarget ( ) const

virtual

Accessor/mutator for myCheckAngleToTarget.

virtual void DtTargetAcquireCriteria::setCheckAngleToTarget ( bool  checkAngle )

virtual

virtual bool DtTargetAcquireCriteria::checkElevation ( ) const

virtual

Accessor/mutator for myCheckElevation.

virtual void DtTargetAcquireCriteria::setCheckElevation ( bool  checkElev )

virtual

virtual double DtTargetAcquireCriteria::timeToAcquire ( ) const

virtual

Accessor/mutator for myTimeToAcquireTarget.

virtual void DtTargetAcquireCriteria::setTimeToAcquire ( double  time )

virtual

virtual double DtTargetAcquireCriteria::maxTargetSpeedToAcquire ( ) const

virtual

Accessor/mutator for myMaxTargetSpeedToAcquire.

virtual void DtTargetAcquireCriteria::setMaxTargetSpeedToAcquire ( double  speed )

virtual

virtual double DtTargetAcquireCriteria::maxElevAngleToAcquire ( ) const

virtual

Accessor/mutator for myMaxElevAngleToAcuire.

virtual void DtTargetAcquireCriteria::setMaxElevAngleToAcquire ( double  angle )

virtual

virtual double DtTargetAcquireCriteria::maxElevToAcquire ( ) const

virtual

Accessor/mutator for myMaxElevationToAcquire.

virtual void DtTargetAcquireCriteria::setMaxElevToAcquire ( double  elev )

virtual

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.vrf4-8-branch/include/vrfobjparam/targetAcquireCriteria.h