DtTargetingControlTable Class Reference

Inheritance diagram for DtTargetingControlTable:

Public Member Functions
	DtTargetingControlTable (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtTargetingControlTable (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtTargetingControlTable ()
	DtTargetingControlTable (const DtString &name, const DtTargetingControlTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtTargetingControlTable (const DtSymbolString &name, const DtTargetingControlTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtTargetingControlTable (const DtTargetingControlTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtTargetingControlTable &	operator= (const DtTargetingControlTable &orig)
const DtAmmunitionList &	ammunition () const
DtAmmunitionList &	ammunition ()
const DtAmmunitionPrioritiesList &	ammunitionPriorities () const
DtAmmunitionPrioritiesList &	ammunitionPriorities ()
bool	operator== (const DtTargetingControlTable &) const
bool	operator!= (const DtTargetingControlTable &rhs) const
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual bool	isValid () const
virtual bool	hasTargetPriorities () const
virtual bool	ammunitionCanBeUsedBy (const DtAmmunitionParamsEntry *) const
virtual void	postGetSelf ()
virtual void	setTo (DtAmmoSelectTable &) const
virtual DtSimResourceManager	resourceManager () const
virtual void	contributeResourcesTo (DtSimResourceManager &) const
Public Member Functions inherited from DtTargetSelectionCriteria
	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 ()
virtual bool	allowAutonomousFire () const
virtual void	setAllowAutonomousFire (bool v)
bool	operator== (const DtTargetSelectionCriteria &) 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) 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	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
DtAmmunitionList	myAmmunitionList
DtAmmunitionPrioritiesList	myAmmunitionPrioritiesList
Protected Attributes inherited from DtTargetSelectionCriteria
DtTargetPriorityList	myTargetPriorityList
DtRwInt	myMaxTargets
DtRwSpatialFilterContainer	myTargetRegion
DtRwBoolean	myFireWithSpotReportOnly
DtRwBoolean	myAllowAutonomousFire
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

DtTargetingControlTable::DtTargetingControlTable	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtTargetingControlTable::DtTargetingControlTable	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtTargetingControlTable::~DtTargetingControlTable ( )

virtual

destructor

DtTargetingControlTable::DtTargetingControlTable	(	const DtString &	name,
		const DtTargetingControlTable &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtTargetingControlTable::DtTargetingControlTable	(	const DtSymbolString &	name,
		const DtTargetingControlTable &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtTargetingControlTable::DtTargetingControlTable	(	const DtTargetingControlTable &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Member Function Documentation

DtTargetingControlTable& DtTargetingControlTable::operator=

(

const DtTargetingControlTable &

orig

)

assignment operator

const DtAmmunitionList& DtTargetingControlTable::ammunition ( ) const

inline

DtAmmunitionList& DtTargetingControlTable::ammunition ( )

inline

const DtAmmunitionPrioritiesList& DtTargetingControlTable::ammunitionPriorities ( ) const

inline

DtAmmunitionPrioritiesList& DtTargetingControlTable::ammunitionPriorities ( )

inline

bool DtTargetingControlTable::operator==

(

const DtTargetingControlTable &

)

const

bool DtTargetingControlTable::operator!= ( const DtTargetingControlTable &  rhs ) const

inline

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

static const char* DtTargetingControlTable::theXmlType ( )

static

virtual const char* DtTargetingControlTable::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual bool DtTargetingControlTable::isValid ( ) const

virtual

Returns true if there are target priorities and ammunition to fire on those priorities.

virtual bool DtTargetingControlTable::hasTargetPriorities ( ) const

virtual

Returns true if there are target priorities or ammunition that has available targets.

virtual bool DtTargetingControlTable::ammunitionCanBeUsedBy ( const DtAmmunitionParamsEntry *  ) const

virtual

Returns true if this ammunition entry can be used to target anything in this table.

virtual void DtTargetingControlTable::postGetSelf ( )

virtual

Convert entity list to target priority list.

Reimplemented from DtReaderWriter.

virtual void DtTargetingControlTable::setTo ( DtAmmoSelectTable &  ) const

virtual

Takes the ammunition priorities and sets them into the ammo select table.

virtual DtSimResourceManager DtTargetingControlTable::resourceManager ( ) const

virtual

Returns a resource manager that contains the munitions of this class.

virtual void DtTargetingControlTable::contributeResourcesTo ( DtSimResourceManager &  ) const

virtual

If the value is specified, contribute whatever ammunition resources exist to the given resource manager via merge.

Member Data Documentation

DtAmmunitionList DtTargetingControlTable::myAmmunitionList

protected

Parameter Name: ammunition-list
Parameter Description: List and amounts of ammunition available.
.

DtAmmunitionPrioritiesList DtTargetingControlTable::myAmmunitionPrioritiesList

protected

Parameter Name: entity-target-priorities
Parameter Description: List of ammunition to use for each target in the and their priority for that target. This list is also in target priority order, so it will serve two purposes
.

---

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

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