DtTargetSelectionController is a controller that takes the list know object contacts from the entity's state repository, and from this list of contacts, generates prioritized target lists for any number of weapons. More...

Inheritance diagram for DtTargetSelectionController:

[legend]

Public Types
typedef std::list < DtWeaponComponentInterface * >	DtWeaponInterfaceList

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

Public Member Functions
	DtTargetSelectionController (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtTargetSelectionController ()
	Destructor. More...

virtual bool	init ()
	Init. Call immediately after construction. More...

virtual const char *	type () const
	Returns a string identifies the class type of component. More...

virtual void	registerTaskMsgCallbacks ()
	Registers for DtFireAtTargetTask. More...

virtual void	updateWeaponInterfaceTaskState (DtWeaponComponentInterface *weapIf)
	Updates task state for a weaponInterface. More...

virtual void	updateTargetPriorityListState ()
	Updates state for the target priority list. More...

virtual void	taskComplete (bool success=true)
	Clears the task state of weapon interfaces. More...

virtual bool	postAddComponentsInit ()
	Finds all weapons available to this entity and enables the fire-at-target task if appropriate. More...

virtual void	preFirstTickInit ()
	Clears the task state of weapon interfaces. More...

virtual void	tick ()
	This component's simulation tick. More...

Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSingleTaskControllerComponent ()
	destructor More...

virtual void	postTick ()
	Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)). More...

virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task. More...

virtual void	taskNotify (const DtSimTask &task)
	This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is. More...

virtual void	clearTask ()
	If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message. More...

virtual void	suspendTask ()
	This method is called when the currently running task is being suspended. More...

virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself. More...

virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()). More...

virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks. More...

virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks. More...

virtual bool	isSubtasked () const
	Returns true if this controller is currently subtasked. More...

virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component. More...

virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks. More...

virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller. More...

virtual void	clearCurrentTaskMessage ()
	Returns the current subtask with the specified id. More...

virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity. More...

virtual DtSimTaskStatePtr	currentTaskState () const

virtual bool	decideToGiveUpTask () const
	This function is used to determine if the controller should give up trying to execute the current task. More...

virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true. More...

virtual bool	taskActive (int taskId) const

virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared. More...

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type. More...

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller. More...

virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller. More...

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId)

virtual std::list < DtTaskMessage * >	currentTaskMessages () const

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const

virtual void	disable ()
	Overridden to allow tasks controllers that can be disabled to call task complete. More...

Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtTaskControllerComponent ()
	destructor More...

virtual bool	showCurrentTaskInGui () const

virtual void	setRadio (DtSimRadio *radio)
	Calls registerTaskMsgCallbacks. More...

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type. More...

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback. More...

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback(). More...

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback. More...

virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks(). More...

virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message. More...

virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component. More...

virtual void	setTasked (bool tasked)
	The current tasked state of this controller. More...

virtual bool	tasked () const

Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtControllerComponent ()
	destructor More...

virtual DtSimRadio *	radio ()
	The radio this component is listening to. More...

Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent ()
	destructor More...

virtual void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component. More...

DtComponentSystem *	parentSystem () const

virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values. More...

virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived. More...

virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as More...

virtual double	minTickPeriod () const
	access the minimum tick period More...

virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time More...

virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period More...

virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally. More...

virtual double	nextTickTime () const
	access the next tick time More...

virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...

virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at. More...

virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state. More...

virtual DtSimComponent *	nextComponent ()
	List management functions. More...

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)
	Used by DtComponentList. More...

virtual DtListItem *	listItem ()

virtual void	putData (std::string &fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class. More...

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored. More...

virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it. More...

virtual void	removeInputPort (DtInputPort *port)

virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name. More...

virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component. More...

virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it. More...

virtual void	removeOutputPort (DtOutputPort *port)

virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name. More...

virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component. More...

virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it. More...

virtual void	removeInputPortGroup (DtInputPortGroup *group)

virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name. More...

virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component. More...

virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it. More...

virtual void	removeOutputPortGroup (DtOutputPortGroup *group)

virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name. More...

virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component. More...

virtual int	priority () const
	Return the current connection priority for this component. More...

virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value. More...

double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...

virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary. More...

virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component. More...

virtual const DtComponentDescriptor *	componentDescriptor () const

virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity. More...

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in. More...

const DtPhysicalWorld *	physicalWorld () const

DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any. More...

const DtAttachedTerrain *	terrainAttachedTo () const

DtVrfObject *	entity ()
	Gets the entity. More...

const DtVrfObject *	entity () const

const DtVrfObject *	const_entity () const
	You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...

DtSimManager *	simManager ()
	Gets the sim manager. More...

const DtSimManager *	simManager () const

const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...

DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository. More...

const DtVrfObjectStateRepository *	localStateRepository () const

const DtVrfObjectStateRepository *	const_localStateRepository () const
	You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...

virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component. More...

virtual bool	taskVisualizationsEnabled () const
	Returns true if task visualizations are enabled for this component. More...

virtual bool	isThreadSafe () const
	Returns true if this component is marked as being thread safe. More...

virtual void	addVRLinkDeferredJob (const boost::function< void()> &callback)
	Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe. More...

virtual bool	isEnabled ()

virtual void	setIsEnabled (bool yesNo)

virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const

virtual DtSimResourceManager &	resourceManager ()

virtual const DtSimResourceManager &	resourceManager () const

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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

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	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 DtSimComponent *	creator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

Static Public Member Functions inherited from DtTaskControllerComponent
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage msg, void usr, DtSimTaskStatePtr taskState)
	Task processor callback function that acts as an adapter for the deprecated forms of addTaskProcessorCallback and removeTaskProcessorCallback (the deprecated form is is version that. More...

Static Public Member Functions inherited from DtSimComponent
static DtSimComponent *	MarkThreadSafe (DtSimComponent *)
	Marks an instance of a component as being thread safe. More...

static DtSimComponentFactory *	factory ()
	A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...

static void	setFactory (DtSimComponentFactory *factory)

static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtVrfObject owner, DtSimManager simManager, DtComponentSystem parentSystem, DtComponentDescriptor desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More...

static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
	Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. 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...

Static Public Member Functions inherited from DtObjectDebugger< DtSimComponent >
static DtObjectCounter::CounterType	ObjectCount ()

static const DtObjectContainer *	ObjectContainer ()

Protected Types
typedef std::set < DtRwSensorContactInfo *, DtTargetRankOperatorWrapper >	DtOrderedTargetSet

Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks. More...

typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap

Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap

typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap

typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap

typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap

Protected Member Functions
virtual void	processObjectAdded (const DtVrfObject *)

virtual bool	createPorts ()
	Creates and initializes ports. More...

virtual bool	createOutputPorts ()
	Creates a target list output port for each weapon entry in the descriptor. More...

virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager. More...

virtual void	registerRadioMessageCallbacks ()
	Registers for setTarget messages from the local entity's radio. More...

virtual void	processSetTarget (DtSimMessage *msg)
	Sets the userTarget in the PSR to the target specified in the set target message. More...

virtual void	selectTargets ()
	Walks the fusedContactsList once for each weapon, and if validTarget() returns true for each, uses the targetRankOperator returned by createTargetRankOperator() to sort the targets into the target list for the weapon. More...

virtual bool	targetForce (DtForceType force) const

virtual bool	validTarget (const DtRwSensorContactInfo &contactInfo, const DtWeaponComponentInterface &weapIf) const

virtual DtEntityTargetInformation	targetInfoFromContactInfo (const DtRwSensorContactInfo &contactInfo) const

virtual void	updateRegionEvaluators ()
	Updates all spatial filter evaluators with the current entity position and orientation. More...

virtual DtTargetRankOperator *	createTargetRankOperator (const DtTargetSelectionCriteria &criteria) const
	Creates a new DtTargetRankOperator with the specified criteria and the host VrfObject of this component. More...

virtual void	setupDetectableForces (DtForceType)
	Sets up detectable forces based on current force type. More...

virtual void	clearTargets ()
	Clear the target lists. More...

virtual bool	isSurrenderedLifeform (const DtVrfObject *entity) const
	Check for surrendered lifeform state. More...

virtual bool	findFusedTargets (const std::map< DtUUID, DtRwSensorContactInfo * > &contactList, const DtWeaponComponentInterface &weapIf, DtRwSensorContactInfo &userTargetInfo, DtOrderedTargetSet &orderedTargets)

virtual const DtRwSensorContactInfo *	setTargetsToWeaponInterface (DtWeaponComponentInterface &weapIf, DtRwSensorContactInfo &userTargetInfo, DtOrderedTargetSet &orderedTargets)
	Updates the weapon interface with a new target, either from the user target or the ordered target list. More...

virtual void	findWeaponControlInterfaces ()
	Find any available weapon control interfaces on the entity and set them to the local list. More...

virtual bool	permissionToFire () const
	Checks the state repository's engagement rules to see if the entity has permission to fire. More...

virtual bool	canFireAtBasedOnTargetPriorityListRoe (const DtVrfObject *entity) const
	Returns true if this entity can fire upon the target entity given the rules of engagement. More...

virtual bool	suppressed () const
	Checks to see if the entity is suppressed. More...

virtual bool	allowedToFire () const
	Checks to see if conditions permit the entity to fire. More...

virtual bool	haveCommonMount (DtWeaponComponentInterface weapon1, DtWeaponComponentInterface weapon2) const
	Checks to see if the two weapons are mounted, directly or indirectly, on a common articulated part. More...

virtual bool	yieldsFiringPrecedenceTo (DtWeaponComponentInterface weapon1, bool weapon1IsBeingTasked, DtWeaponComponentInterface weapon2)
	Determines if weapon1 should yield to the weapon2, assuming they conflict (i.e. More...

virtual bool	tokenConflict (DtWeaponComponentInterface weapon1, DtWeaponComponentInterface weapon2)
	Determine if any of the token resources of weapon1 overlap with those of weapon2. More...

virtual bool	artPartConflict (DtWeaponComponentInterface weapon1, DtWeaponComponentInterface weapon2, DtArtPartType *conflictingPart)
	Determine if any of the ancestor parts of weapon1's gun overlap with the ancestor parts of weapon2's gun. More...

virtual bool	otherWeaponBlocksWeapon (DtWeaponComponentInterface weapon, bool weaponIsBeingTasked, DtWeaponComponentInterface conflictingWeapon, bool controlExternalTurret)
	Determines if any other weapon in this controller's weapon interface list blocks the given weapon, i.e. More...

virtual void	clearLowerPriorityWeaponTargets (DtWeaponComponentInterface *weapon)
	Goes through the weapon interface list, finds weapons that conflict with the given weapon (either on a common turret, or a token resource), and clears the other weapons' targets and tasks. More...

virtual void	assembleListOfFiredUponTargets (std::set< DtUUID > &targets)
	Assembles a list of targets that have already been fired upon. More...


virtual int	nextPriorityValue ()
	Gets the next priority value (myNextPriorityValue) to use. More...

virtual void	setNextPriorityValue (const int val)
	Not normally used: More...


virtual const artPartWeaponMap &	articulatedPartWeapons () const
	Accessors for the map of articulated parts to lists of weapons that are attached to the part. More...

virtual void	addArtPartWeaponToMap (const DtArtPartType part, const DtWeaponComponentInterface *weaponInterface)

virtual void	setArticulatedPartWeapons (const artPartWeaponMap &artPartMap)

Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
	Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type. More...

virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type. More...

virtual void	cleanupInactiveSubtaskStatus ()
	Clears out subtask status entries that are either completed or canceled which were started by this controller. More...

Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo. More...

virtual void	suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends a single running subtasks of taskId, and puts the suspend info into the provided suspendInfo. More...

virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const
	In case this is aliased, return the actual script id. More...

Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor More...

	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor More...

const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator More...

virtual void	onRestore ()
	Override to iterate over the descriptor to see if there are any targetting control tables. More...

virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)

Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT. More...

bool	testInvariant () const

virtual bool	createPortGroups ()
	Called by init. More...

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager. More...

virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick. More...

virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component. More...

virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization. More...

virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name. More...

virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name. More...

virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name. More...

virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name. More...

double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked. More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()

	DtObjectDebugger (const DtObjectDebugger &)

	~DtObjectDebugger ()

Static Protected Member Functions
static void	objectAddedCb (const DtVrfObject , void )
	Called when object is added. Check to see if this is the object we are looking for in our task. More...

static void	setTargetCallback (DtSimMessage msg, void usr)
	Static callback function. Calls processSetTarget(). More...

Protected Attributes
DtObjectTypesListOutputPort *	myTypesToDetectOutputPort
	Port I/O Interface: More...

DtTargetSelectionControllerPSR *	myProcessState
	Container for state data associated with this component. More...

DtSensorContactInfoListChangeMonitor	myContactListChangeMonitor

DtForceType	myForce
	Force used to put information onto port for hostility matrix. More...

bool	mySetupDetectableForcesRequired
	Flag set to true if a re-run of the setupDetectableForces() is required on the next tick. More...

DtWeaponInterfaceList	myWeaponInterfaceList
	List of weapon interfaces through which the target selection controller communicates with weapon systems. More...

DtRwInt	myNextPriorityValue
	The next default priority level to use for a weapon. More...

artPartWeaponMap	myArticulatedPartWeapons
	A map of articulated part numbers to lists of weapons that are attached to the part directly or indirectly. More...

std::map < DtWeaponComponentInterface *, int >	myOldInterfaceStatus
	A record of the status of each weapon interface (last tick). More...

bool	myHavePrintedSurrender
	For debugging print statements. More...

bool	myHavePrintedNoNewContacts

bool	myRegisteredAddCallback

Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap

std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList
	This list stores any DtTaskProcessorCallbackInfo allocated locally so that they can be deleted when the component is deleted. More...

Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
	Controller components can send messages. More...

Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity

DtVrfObjectStateRepository *	myLocalStateRepository

DtSimManager *	mySimManager

DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs. More...

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myMinTickPeriod

double	myMinTickPeriodVariance

double	myNextTickTime

double	myLastTickSimTime

double	myDT

bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not. More...

bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick. More...

bool	myIsThreadSafe
	Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs
	List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...

bool	myTickEveryFrame
	Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...

DtTaskVisualizationMap	myTaskVisualizations
	The visualization objects to be drawn for this component. More...

double	myNextTaskVisTickTime
	The next tick time for updating the task visualizations. More...

DtSymbolString	myFullComponentName

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

Private Member Functions
	DtTargetSelectionController ()
	Not Implemented. More...

	DtTargetSelectionController (const DtTargetSelectionController &orig)
	Not Implemented. More...

DtTargetSelectionController &	operator= (const DtTargetSelectionController &orig)
	Not Implemented. More...

virtual void	processFireAtTargetTask (DtSimMessage *msg)

virtual bool	processFireAtTargetTask (DtFireAtTargetTask *, bool &foundValidWeapon)
	Returns true if object exists. More...

static void	fireAtTargetTaskCallback (DtSimMessage msg, void usr)
	Processes Fire at Target tasks. More...

virtual void	processWeaponListRequest (const DtVrfObjectMessage *msg)

static void	weaponListRequestCallback (const DtVrfObjectMessage msg, void usr)
	Responds to weapon list requests with list of weapon names associated with this entity. More...

virtual void	processFireNow (DtSimMessage *msg)

static void	fireNowCallback (DtSimMessage msg, void usr)
	Processes fire now by tasking itself a DtFireAtTarget task. More...

static void	hostilitiesChangedCallback (DtU8 force, void *usr)
	Callback invoked by the hostility manager when the hostility matrix is changed. More...

virtual void	processHostilitiesChanged (DtU8 force)

Additional Inherited Members
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	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

Detailed Description

DtTargetSelectionController is a controller that takes the list know object contacts from the entity's state repository, and from this list of contacts, generates prioritized target lists for any number of weapons.

End User Description: This component receives lists of sensor contacts the entity state repository, and selects appropriate targets from those lists, which are then put out on target lists which can be used by weapon systems. The number of output target lists is variable, and depends on the number of target-output blocks specified in the descriptor. Each target output can have a different set of entity types it targets, as well as different coverage area in relation to the entity. This component also listens for setTarget messages from the GUI, and uses the specified target as highest priority target on the output list. Developer Description: The selectTargets() creates the prioritized target lists from this fused contact list.

Each weapon has its own target selection criteria, specified in the descriptor, which allows different priorities for different weapons.

Prioritizing of targets happens with the use of a DtTargetRankOperator, which defines a comparison operator between two contacts. This may be overridden and replaced with a user-defined ranking operator. By default, targets are ranked first based on the entity-type based target priority (specified in the descriptor), then based on whether they are in the current Sector of Responsibility, and finally on range from the host entity.

Any target specified in a setTarget message sent to this entity will be put as the highest priority target when it is on the input list for any weapon for which it is valid.

Note: This controller used to take a list of contacts from one or more sensors (VRF 3.10 and earlier), but was changed to read the list of known sensor contacts from the state repository. A controller such as the DtContactFusionController combines contacts from multiple sensors and populates the list in the state repository.

Uses Descriptor Type: DtComponentDescriptor

Member Typedef Documentation

typedef std::list<DtWeaponComponentInterface*> DtTargetSelectionController::DtWeaponInterfaceList

typedef std::set<DtRwSensorContactInfo*, DtTargetRankOperatorWrapper> DtTargetSelectionController::DtOrderedTargetSet

protected

Constructor & Destructor Documentation

DtTargetSelectionController::DtTargetSelectionController ( )

private

Not Implemented.

DtTargetSelectionController::DtTargetSelectionController ( const DtTargetSelectionController & orig )

private

Not Implemented.

DtTargetSelectionController::DtTargetSelectionController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

virtual DtTargetSelectionController::~DtTargetSelectionController ( )

virtual

Destructor.

Member Function Documentation

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

private

Not Implemented.

virtual bool DtTargetSelectionController::init ( )

virtual

Init. Call immediately after construction.

Reimplemented from DtControllerComponent.

virtual const char* DtTargetSelectionController::type ( ) const

virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns: DtTargetSelectionControllerType

Implements DtTaskControllerComponent.

virtual void DtTargetSelectionController::registerTaskMsgCallbacks ( )

virtual

Registers for DtFireAtTargetTask.

Reimplemented from DtTaskControllerComponent.

virtual void DtTargetSelectionController::updateWeaponInterfaceTaskState ( DtWeaponComponentInterface * weapIf )

virtual

Updates task state for a weaponInterface.

Checks for task completion and weapon status.

virtual void DtTargetSelectionController::updateTargetPriorityListState ( )

virtual

Updates state for the target priority list.

Checks for entity destroyed or non-existence.

static void DtTargetSelectionController::fireAtTargetTaskCallback	(	DtSimMessage *	msg,
		void *	usr
	)

static

Processes Fire at Target tasks.

Selects a weapon according to the task settings, and assigns the target to the selected weapon. If no valid weapon systems are found, calls taskComplete(false).

virtual void DtTargetSelectionController::processFireAtTargetTask ( DtSimMessage * msg )

virtual

virtual bool DtTargetSelectionController::processFireAtTargetTask	(	DtFireAtTargetTask *	,
		bool &	foundValidWeapon
	)

virtual

Returns true if object exists.

foundValidWeapon will be set to true if a valid weapon for the target is found

static void DtTargetSelectionController::weaponListRequestCallback	(	const DtVrfObjectMessage *	msg,
		void *	usr
	)

static

Responds to weapon list requests with list of weapon names associated with this entity.

virtual void DtTargetSelectionController::processWeaponListRequest ( const DtVrfObjectMessage * msg )

virtual

static void DtTargetSelectionController::fireNowCallback	(	DtSimMessage *	msg,
		void *	usr
	)

static

Processes fire now by tasking itself a DtFireAtTarget task.

virtual void DtTargetSelectionController::processFireNow ( DtSimMessage * msg )

virtual

virtual void DtTargetSelectionController::taskComplete ( bool success = true )

virtual

Clears the task state of weapon interfaces.

Reimplemented from DtSingleTaskControllerComponent.

virtual bool DtTargetSelectionController::postAddComponentsInit ( )

virtual

Finds all weapons available to this entity and enables the fire-at-target task if appropriate.

Reimplemented from DtSimComponent.

virtual void DtTargetSelectionController::preFirstTickInit ( )

virtual

Clears the task state of weapon interfaces.

If currentTaskMessage() has a task, calls processFireAtTask.

Reimplemented from DtSimComponent.

virtual void DtTargetSelectionController::tick ( )

virtual

This component's simulation tick.

Each tick thsi component: updates the task state of weapon interfaces; updates detectable forces if necessary; checks for contact list changes; updates region evaluators; and does autonomous target selection.

Reimplemented from DtSimComponent.

static DtSimComponent* DtTargetSelectionController::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

Returns: New instance of this class.

static void DtTargetSelectionController::objectAddedCb	(	const DtVrfObject *	,
		void *
	)

staticprotected

Called when object is added. Check to see if this is the object we are looking for in our task.

virtual void DtTargetSelectionController::processObjectAdded ( const DtVrfObject * )

protectedvirtual

virtual bool DtTargetSelectionController::createPorts ( )

protectedvirtual

Creates and initializes ports.

Reimplemented from DtSimComponent.

virtual bool DtTargetSelectionController::createOutputPorts ( )

protectedvirtual

Creates a target list output port for each weapon entry in the descriptor.

Ports are named based on the name in the descriptor.

virtual bool DtTargetSelectionController::createPSR ( )

protectedvirtual

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

virtual void DtTargetSelectionController::registerRadioMessageCallbacks ( )

protectedvirtual

Registers for setTarget messages from the local entity's radio.

static void DtTargetSelectionController::setTargetCallback	(	DtSimMessage *	msg,
		void *	usr
	)

staticprotected

Static callback function. Calls processSetTarget().

virtual void DtTargetSelectionController::processSetTarget ( DtSimMessage * msg )

protectedvirtual

Sets the userTarget in the PSR to the target specified in the set target message.

virtual void DtTargetSelectionController::selectTargets ( )

protectedvirtual

Walks the fusedContactsList once for each weapon, and if validTarget() returns true for each, uses the targetRankOperator returned by createTargetRankOperator() to sort the targets into the target list for the weapon.

If a contact is specified as the userTargetName in the PSR, it takes highest priority on the output list for any weapon for which it is valid. Also resets the userTargetName in the process state repository to "" if the target did not show up on the fused contacts list.

virtual bool DtTargetSelectionController::targetForce ( DtForceType force ) const

protectedvirtual

Returns: true if targeting of the specified force type is currently allowed.

virtual bool DtTargetSelectionController::validTarget	(	const DtRwSensorContactInfo &	contactInfo,
		const DtWeaponComponentInterface &	weapIf
	)		const

protectedvirtual

Returns: true if this contact is a valid target for the specified target selection criteria. Calls targetForce() to check if the force type of the contact is acceptable.

virtual DtEntityTargetInformation DtTargetSelectionController::targetInfoFromContactInfo ( const DtRwSensorContactInfo & contactInfo ) const

protectedvirtual

Returns: an entity target information structure based on the sensor contact info passed in.

virtual void DtTargetSelectionController::updateRegionEvaluators ( )

protectedvirtual

Updates all spatial filter evaluators with the current entity position and orientation.

virtual DtTargetRankOperator* DtTargetSelectionController::createTargetRankOperator ( const DtTargetSelectionCriteria & criteria ) const

protectedvirtual

Creates a new DtTargetRankOperator with the specified criteria and the host VrfObject of this component.

Returns: a DtPrioritySorRangeTargetRankOperator (this implementation does)

virtual void DtTargetSelectionController::setupDetectableForces ( DtForceType )

protectedvirtual

Sets up detectable forces based on current force type.

Sets myForce to force that was passed in.

static void DtTargetSelectionController::hostilitiesChangedCallback	(	DtU8	force,
		void *	usr
	)

staticprotected

Callback invoked by the hostility manager when the hostility matrix is changed.

virtual void DtTargetSelectionController::processHostilitiesChanged ( DtU8 force )

protectedvirtual

virtual void DtTargetSelectionController::clearTargets ( )

protectedvirtual

Clear the target lists.

virtual bool DtTargetSelectionController::isSurrenderedLifeform ( const DtVrfObject * entity ) const

protectedvirtual

Check for surrendered lifeform state.

virtual bool DtTargetSelectionController::findFusedTargets	(	const std::map< DtUUID, DtRwSensorContactInfo * > &	contactList,
		const DtWeaponComponentInterface &	weapIf,
		DtRwSensorContactInfo &	userTargetInfo,
		DtOrderedTargetSet &	orderedTargets
	)

protectedvirtual

virtual const DtRwSensorContactInfo* DtTargetSelectionController::setTargetsToWeaponInterface	(	DtWeaponComponentInterface &	weapIf,
		DtRwSensorContactInfo &	userTargetInfo,
		DtOrderedTargetSet &	orderedTargets
	)

protectedvirtual

Updates the weapon interface with a new target, either from the user target or the ordered target list.

Returns the weapons next target, or null if there is none.

virtual void DtTargetSelectionController::findWeaponControlInterfaces ( )

protectedvirtual

Find any available weapon control interfaces on the entity and set them to the local list.

Sort the list by weapon priority (a parameter in the gun controller descriptor) so that a higher priority weapon will get its choice of target before a lower priority weapon.

virtual bool DtTargetSelectionController::permissionToFire ( ) const

protectedvirtual

Checks the state repository's engagement rules to see if the entity has permission to fire.

By default, ROE = fire-at-will, or fire-when-fired-upon and entity is under-fire.

virtual bool DtTargetSelectionController::canFireAtBasedOnTargetPriorityListRoe ( const DtVrfObject * entity ) const

protectedvirtual

Returns true if this entity can fire upon the target entity given the rules of engagement.

virtual bool DtTargetSelectionController::suppressed ( ) const

protectedvirtual

Checks to see if the entity is suppressed.

virtual bool DtTargetSelectionController::allowedToFire ( ) const

protectedvirtual

Checks to see if conditions permit the entity to fire.

By default, this is permissionToFire. Note that suppression is not tested here; it is treated on a per-weapon basis; e.g. a tank MG that requires a crew member to be exposed while firing might be suppressed by small arms fire, while the main gun is is not suppressed.

virtual bool DtTargetSelectionController::haveCommonMount	(	DtWeaponComponentInterface *	weapon1,
		DtWeaponComponentInterface *	weapon2
	)		const

protectedvirtual

Checks to see if the two weapons are mounted, directly or indirectly, on a common articulated part.

Uses the articulated part lists of the weapons. Returns true if they are mounted on a common part.

virtual int DtTargetSelectionController::nextPriorityValue ( )

protectedvirtual

Gets the next priority value (myNextPriorityValue) to use.

Each time it is called, myNextPriorityValue increments by one.

virtual void DtTargetSelectionController::setNextPriorityValue ( const int val )

protectedvirtual

Not normally used:

virtual const artPartWeaponMap& DtTargetSelectionController::articulatedPartWeapons ( ) const

protectedvirtual

Accessors for the map of articulated parts to lists of weapons that are attached to the part.

virtual void DtTargetSelectionController::addArtPartWeaponToMap	(	const DtArtPartType	part,
		const DtWeaponComponentInterface *	weaponInterface
	)

protectedvirtual

virtual void DtTargetSelectionController::setArticulatedPartWeapons ( const artPartWeaponMap & artPartMap )

protectedvirtual

virtual bool DtTargetSelectionController::yieldsFiringPrecedenceTo	(	DtWeaponComponentInterface *	weapon1,
		bool	weapon1IsBeingTasked,
		DtWeaponComponentInterface *	weapon2
	)

protectedvirtual

Determines if weapon1 should yield to the weapon2, assuming they conflict (i.e.

if they use the same token resource or the same turret). This decision depends on the weapon priority (a parameter in the ballistic-gun-controller descriptor) and whether the weapon has been explicitly tasked. Lower priority numbers mean higher priority. A weapon is tasked if it was explicitly tasked with a fire-at-target task, or if the target selection controller gave it a target but the parameter treat-selected-target-as-tasked is set true in the ballistic-gun-controller descriptor.

If one weapon is tasked and the other isn't, then the tasked weapon takes control (i.e., this function returns true if weapon1 is not tasked and weapon2 is). If neither weapon is tasked or both are tasked, then weapon1 yields if weapon2's priority is strictly lower than weapon1's priority.

virtual bool DtTargetSelectionController::tokenConflict	(	DtWeaponComponentInterface *	weapon1,
		DtWeaponComponentInterface *	weapon2
	)

protectedvirtual

Determine if any of the token resources of weapon1 overlap with those of weapon2.

A token is a word in the string parameter required-tokens in the ballistic-gun-controller descriptor. They are intended to represent entity resources needed to operate the weapon, such as crew members.

virtual bool DtTargetSelectionController::artPartConflict	(	DtWeaponComponentInterface *	weapon1,
		DtWeaponComponentInterface *	weapon2,
		DtArtPartType *	conflictingPart
	)

protectedvirtual

Determine if any of the ancestor parts of weapon1's gun overlap with the ancestor parts of weapon2's gun.

Parameters

conflictingArtPart returns the part number of the part that conflicted (valid if the function returns true).

virtual bool DtTargetSelectionController::otherWeaponBlocksWeapon	(	DtWeaponComponentInterface *	weapon,
		bool	weaponIsBeingTasked,
		DtWeaponComponentInterface **	conflictingWeapon,
		bool *	controlExternalTurret
	)

protectedvirtual

Determines if any other weapon in this controller's weapon interface list blocks the given weapon, i.e.

it uses a common turret or token resource, and the given yields precedence to the other weapon. The other weapon must have a target to block the given weapon.

Parameters

weaponIsBeingTasked	should be set true if the given weapon is being considered for a fire-at-target task, and false if it is auto-selecting a target. Tasked targets are given priority over auto-selected targets (except, see treat-selected-as-tasked parameter in the ballistic gun controller).
conflictingWeapon	Returns a pointer to the (first) weapon found that blocks the given weapon.
controlExternalTurret	If the function returns false, i.e. the weapon is free to fire, this parameter may indicate that it should not try to control azimuth rotation outside of its own system. E.g., an MG mounted on a main gun turret can use its own ring, but shouldn't set outputs for the main gun turret. This is because a higher priority gun is controlling the external turret.

virtual void DtTargetSelectionController::clearLowerPriorityWeaponTargets ( DtWeaponComponentInterface * weapon )

protectedvirtual

Goes through the weapon interface list, finds weapons that conflict with the given weapon (either on a common turret, or a token resource), and clears the other weapons' targets and tasks.

The procedure assumes that none of the other weapons block the given weapon (if one did, the weapon wouldn't fire, and it wouldn't be necessary to clear any other weapons).

Parameters

weapon The weapon that is now firing.

virtual void DtTargetSelectionController::assembleListOfFiredUponTargets ( std::set< DtUUID > & targets )

protectedvirtual

Assembles a list of targets that have already been fired upon.

No need to target these again until we know the result of the attack.

Member Data Documentation

DtObjectTypesListOutputPort* DtTargetSelectionController::myTypesToDetectOutputPort

protected

Port I/O Interface:

Inputs: DtSensorContactListInputPort : detected-objects Outputs: DtObjectTypesListOutputPort : target-types-to-detectOutput Port Name: target-types-to-detect
Output Port Description: List of types of object the target selection controller is interested in. Connects to the sensors.
Output Port Range:
Output Port Default Value:
Output Group Parent:

DtTargetSelectionControllerPSR* DtTargetSelectionController::myProcessState

protected

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).

DtSensorContactInfoListChangeMonitor DtTargetSelectionController::myContactListChangeMonitor

protected

DtForceType DtTargetSelectionController::myForce

protected

Force used to put information onto port for hostility matrix.

bool DtTargetSelectionController::mySetupDetectableForcesRequired

protected

Flag set to true if a re-run of the setupDetectableForces() is required on the next tick.

(This is required when the hostility matrix changes)

DtWeaponInterfaceList DtTargetSelectionController::myWeaponInterfaceList

protected

List of weapon interfaces through which the target selection controller communicates with weapon systems.

Sorted in order of descending weapon priority (priority for a gun is a parameter in the gun controller descriptor).

DtRwInt DtTargetSelectionController::myNextPriorityValue

protected

The next default priority level to use for a weapon.

Starts at 1 and increments each time it is used.

artPartWeaponMap DtTargetSelectionController::myArticulatedPartWeapons

protected

A map of articulated part numbers to lists of weapons that are attached to the part directly or indirectly.

For example, a tank turret would map to a list that includes the main gun and any MGs mounted on the turret. This map is used to identify interacting weapons. The map is constructed when the target selection controller is initialized, so this member is not saved in the scenario.

std::map<DtWeaponComponentInterface*, int> DtTargetSelectionController::myOldInterfaceStatus

protected

A record of the status of each weapon interface (last tick).

If the status changes, it will make the controller re-select targets for the weapon interfaces.

bool DtTargetSelectionController::myHavePrintedSurrender

protected

For debugging print statements.

bool DtTargetSelectionController::myHavePrintedNoNewContacts

protected

bool DtTargetSelectionController::myRegisteredAddCallback

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfmodel/targetSelectionController.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation