Defines a criteria for choosing targets for a single weapon system. This class stores all the information about what targets should be considered valid for a particular weapon, and a prioritizing order for those targets.

Inheritance diagram for DtTargetSelectionCriteria:

[legend]

Public Member Functions
	DtTargetSelectionCriteria (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

	DtTargetSelectionCriteria (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)

	DtTargetSelectionCriteria (const DtString &name, const DtTargetSelectionCriteria &orig, DtReaderWriterRegistry *parentRegistry=0)

	DtTargetSelectionCriteria (const DtSymbolString &name, const DtTargetSelectionCriteria &orig, DtReaderWriterRegistry *parentRegistry=0)

	DtTargetSelectionCriteria (const DtTargetSelectionCriteria &orig, DtReaderWriterRegistry *parentRegistry=0)

DtTargetSelectionCriteria &	operator= (const DtTargetSelectionCriteria &orig)

virtual	~DtTargetSelectionCriteria ()

bool	operator== (const DtTargetSelectionCriteria &) const

virtual const char *	readerWriterType () const


virtual DtTargetPriorityList &	priorityList ()

virtual const DtTargetPriorityList &	priorityList () const


virtual int	maxTargets () const

virtual void	setMaxTargets (int num)


virtual DtRwSpatialFilterContainer *	targetRegion ()

virtual const DtRwSpatialFilterContainer *	targetRegion () const


virtual bool	fireWithSpotReportOnly () const

virtual void	setFireWithSpotReportOnly (bool value)

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)

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 *	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	wasUpdatedSince (DtTime t) 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)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtTargetPriorityList	myTargetPriorityList

DtRwInt	myMaxTargets

DtRwSpatialFilterContainer	myTargetRegion

DtRwBoolean	myFireWithSpotReportOnly

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

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

constructor

DtTargetSelectionCriteria::DtTargetSelectionCriteria	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtTargetSelectionCriteria::DtTargetSelectionCriteria	(	const DtString &	name,
		const DtTargetSelectionCriteria &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor

DtTargetSelectionCriteria::DtTargetSelectionCriteria	(	const DtSymbolString &	name,
		const DtTargetSelectionCriteria &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

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

virtual DtTargetSelectionCriteria::~DtTargetSelectionCriteria ( )

virtual

destructor

Member Function Documentation

DtTargetSelectionCriteria& DtTargetSelectionCriteria::operator= ( const DtTargetSelectionCriteria & orig )

assignment

virtual DtTargetPriorityList& DtTargetSelectionCriteria::priorityList ( )

virtual

Accessor/mutator for myTargetPriorityList.

virtual const DtTargetPriorityList& DtTargetSelectionCriteria::priorityList ( ) const

virtual

Accessor/mutator for myTargetPriorityList.

virtual int DtTargetSelectionCriteria::maxTargets ( ) const

virtual

Accessor/mutator for myMaxTargets.

virtual void DtTargetSelectionCriteria::setMaxTargets ( int num )

virtual

Accessor/mutator for myMaxTargets.

virtual DtRwSpatialFilterContainer* DtTargetSelectionCriteria::targetRegion ( )

virtual

Accessor/mutator for myTargetRegion.

virtual const DtRwSpatialFilterContainer* DtTargetSelectionCriteria::targetRegion ( ) const

virtual

Accessor/mutator for myTargetRegion.

virtual bool DtTargetSelectionCriteria::fireWithSpotReportOnly ( ) const

virtual

See Also: myFireWithSpotReportOnly

virtual void DtTargetSelectionCriteria::setFireWithSpotReportOnly ( bool value )

virtual

See Also: myFireWithSpotReportOnly

bool DtTargetSelectionCriteria::operator== ( const DtTargetSelectionCriteria & ) const

Equivalence operator.

virtual const char* DtTargetSelectionCriteria::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.

Reimplemented in DtTargetingControlTable.

Member Data Documentation

DtTargetPriorityList DtTargetSelectionCriteria::myTargetPriorityList

protected

Parameter Name: target-priorities
Parameter Description: List of object types provides acceptable types of objects to use as targets, and well as what types should be considered higher priority than other types.
Parameter Default Value: Empty list.
.

DtRwInt DtTargetSelectionCriteria::myMaxTargets

protected

Parameter Name: max-targets
Parameter Description: Maximum number of targets to output to this weapon system simultaneously. Value of -1 indicates no limit.
Parameter Default Value: -1
.

DtRwSpatialFilterContainer DtTargetSelectionCriteria::myTargetRegion

protected

Parameter Name: target-region
Parameter Description: Region (in relation to the host entity) in which this weapon should attempt target objects. Only objects within the defined region are valid. If no region is defined, all targets are valid. Spatial filters can be combined with logical and/or/not operators as well.
Example 1: Every entity within 4000 meters of this entity.
(in-range
(range 4000.000000)
)
Example 2: Every entity within 4000 meters of this entity, and within the defined frustum of the facing direction of the entity.
(and
(in-range
(range 4000.000000)
)
(in-frustum
(az-max 1.0472)
(az-min -1.0472)
(el-max 1.5708)
(el-min -1.5708)
)
)
Custom geometry filters can be created though the toolkit.
See documentation for DtRwSpatialFilter for more information.
Parameter Default Value:
.

DtRwBoolean DtTargetSelectionCriteria::myFireWithSpotReportOnly

protected

Parameter Name: fire-with-spot-report-only
Parameter Description: If true, the entity will use this weapon to fire on targets that it has received data on only though spot reports. Otherwise, a sensor located on the entity is required to see the target before selecting it as a valid target for this weapon. Parameter Default Value: false.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjparam/targetSelectionCriteria.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation