VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions
DtTargetSelectionController Class Reference

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:
Inheritance graph
[legend]

Public Types

typedef std::list
< DtWeaponComponentInterface * > 
DtWeaponInterfaceList

Public Member Functions

 DtTargetSelectionController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtTargetSelectionController ()
 Destructor.
virtual bool init ()
 Init. Call immediately after construction.
virtual const chartype () const
 Returns a string identifies the class type of component.
virtual void registerTaskMsgCallbacks ()
 Registers for DtFireAtTargetTask.
virtual void updateWeaponInterfaceTaskState (DtWeaponComponentInterface *weapIf)
 Updates task state for a weaponInterface.
virtual void taskComplete (bool success=true)
 Clears the task state of weapon interfaces.
virtual bool postAddComponentsInit ()
 Finds all weapons available to this entity and enables the fire-at-target task if appropriate.
virtual void preFirstTickInit ()
 Clears the task state of weapon interfaces.
virtual void tick ()
 This component's simulation tick.
- Public Member Functions inherited from DtSingleTaskControllerComponent
 DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtSingleTaskControllerComponent ()
 destructor
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)).
virtual bool beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
 Called by the task manager when this controller should start executing the specified task.
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.
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.
virtual void suspendTask ()
 This method is called when the currently running task is being suspended.
virtual int sendSubtask (DtSimTask &task)
 Sends subtask to ourself.
virtual void clearSubtask (int subtaskId)
 Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void addPendingSubtaskId (int subtaskId)
 Adds given subtask Id to list of pending subtasks.
virtual bool findPendingSubtaskId (int subtaskId)
 Checks to see if given subtaskId exists in our list of pending subtasks.
virtual bool isSubtasked () const
 Returns true if this controller is currently subtasked.
virtual void removePendingSubtaskId (int subtaskId)
 Removes pending subtask from list of subtasks for this component.
virtual void removeAllPendingSubtaskIds ()
 Clear all pending subtasks from our list of subtasks.
virtual std::vector< intcurrentPendingSubstaskIds () const
 Returns the list of all currently pending subtask ids for this controller.
virtual void clearCurrentTaskMessage ()
 Returns the current subtask with the specified id.
virtual DtTaskMessagecurrentTaskMessage () const
 Get a pointer to the message that was used to task this entity.
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.
virtual void giveUpTask ()
 Called when controller is tasked and decideToGiveUp() returns true.
virtual bool taskActive (int taskId) const
 
virtual bool clearTopLevelTasks ()
 If this controller has any top level tasks (not subtasks), they are cleared.
virtual void clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
 Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void clearTasksByType (const DtSimTaskMessageType &taskType)
 Clears any tasks of the specified type running in this controller.
virtual void clearTaskById (int taskId)
 Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfosuspendTaskById (int taskId)
virtual std::list
< DtTaskMessage * > 
currentTaskMessages () const
 
virtual DtTaskWithTaskStateListPtr topLevelTasks () const
 
- Public Member Functions inherited from DtTaskControllerComponent
 DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtTaskControllerComponent ()
 destructor
virtual bool showCurrentTaskInGui () const
virtual void setRadio (DtSimRadio *radio)
 Calls registerTaskMsgCallbacks.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Adds a new function for processing the specified task type.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Deprecated form of addTaskProcessorCallback.
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Undoes anything done by addTaskProcessorCallback().
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Deprecated form of removeTaskProcessorCallback.
virtual void enable ()
 Overridden to call registerTaskMsgCallbacks().
virtual void disable ()
 Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void sendTaskCanceled (DtTaskMessage *taskMsg)
 Sends the task canceled report for the specified message.
virtual bool taskVisualizationsActive () const
 Returns true if task visualizations are currently active for this component.
virtual void setTasked (bool tasked)
 The current tasked state of this controller.
virtual bool tasked () const
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtControllerComponent ()
 destructor
virtual DtSimRadioradio ()
 The radio this component is listening to.
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
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.
virtual DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
virtual void setListItem (DtListItem *item)
 Used by DtComponentList.
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.
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.
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.
virtual void removeInputPort (DtInputPort *port)
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name.
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component.
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.
virtual void removeOutputPort (DtOutputPort *port)
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name.
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component.
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.
virtual void removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name.
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component.
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.
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name.
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component.
virtual int priority () const
 Return the current connection priority for this component.
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.
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
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.
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.
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.
DtVrfProcessStateRepositoryManagerpsrManager ()
virtual DtString componentFullName () const
virtual DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorldphysicalWorld () const
virtual DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrainterrainAttachedTo () const
virtual DtVrfObjectentity ()
 Gets the entity.
virtual const DtVrfObjectentity () const
virtual DtSimManagersimManager ()
 Gets the sim manager.
virtual const DtSimManagersimManager () const
virtual const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_SystemcoordinateSystem ()
virtual
DtVrfObjectStateRepository
localStateRepository ()
 Gets the local state repository.
virtual const
DtVrfObjectStateRepository
localStateRepository () const
virtual DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component.
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 DtSimResourceManagerresourceManager ()
virtual const
DtSimResourceManager
resourceManager () const
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
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.
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op.
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op.
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op.
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.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual void addAlias (const DtString &alias)
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () const
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
std::string debugText () const
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
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.
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated.
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename.
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid.
virtual bool fromXmlFile (const DtFilename &)
 Restires object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
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.
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.
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference.

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Types

typedef std::set
< DtRwSensorContactInfo
*, DtTargetRankOperatorWrapper
DtOrderedTargetSet

Protected Member Functions

virtual void processObjectAdded (DtVrfObject *)
virtual bool createPorts ()
 Creates and initializes ports.
virtual bool createOutputPorts ()
 Creates a target list output port for each weapon entry in the descriptor.
virtual bool createPSR ()
 Creates myProcessState data member, and adds it to our process state repository manager.
virtual void registerRadioMessageCallbacks ()
 Registers for setTarget messages from the local entity's radio.
virtual void processSetTarget (DtSimMessage *msg)
 Sets the userTarget in the PSR to the target specified in the set target message.
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.
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.
virtual DtTargetRankOperatorcreateTargetRankOperator (const DtTargetSelectionCriteria &criteria) const
 Creates a new DtTargetRankOperator with the specified criteria and the host VrfObject of this component.
virtual void setupDetectableForces (DtForceType)
 Sets up detectable forces based on current force type.
virtual void clearTargets ()
 Clear the target lists.
virtual bool isSurrenderedLifeform (const DtVrfObject *entity) const
 Check for surrendered lifeform state.
virtual bool findFusedTargets (const DtSensorContactInfoList *contactList, const DtWeaponComponentInterface &weapIf, DtRwSensorContactInfo &userTargetInfo, DtOrderedTargetSet &orderedTargets)
virtual void setTargetsToWeaponInterface (DtWeaponComponentInterface &weapIf, DtRwSensorContactInfo &userTargetInfo, DtOrderedTargetSet &orderedTargets)
virtual void findWeaponControlInterfaces ()
 Find any available weapon control interfaces on the entity and set them to the local list.
virtual bool permissionToFire () const
 Checks the state repository's engagement rules to see if the entity has permission to fire.
virtual bool suppressed () const
 Checks to see if the entity is suppressed.
virtual bool allowedToFire () const
 Checks to see if conditions permit the entity to fire.
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.
virtual bool yieldsFiringPrecedenceTo (DtWeaponComponentInterface *weapon1, bool weapon1IsBeingTasked, DtWeaponComponentInterface *weapon2)
 Determines if the first weapon should yield to the second weapon, if they conflict (i.e.
virtual bool tokenConflict (DtWeaponComponentInterface *weapon1, DtWeaponComponentInterface *weapon2)
 Determine if any of the token resources of weapon1 overlap with those of weapon2.
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.
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.
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.
virtual int nextPriorityValue ()
 Gets the next priority value (myNextPriorityValue) to use.
virtual void setNextPriorityValue (const int val)
 Not normally used:
virtual const artPartWeaponMaparticulatedPartWeapons () const
 Accessors for the map of articulated parts to lists of weapons that are attached to the part.
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.
virtual void clearSubtasksByType (const DtSimTaskMessageType &taskType)
 Clear all subtasks of a given type.
virtual void cleanupInactiveSubtaskStatus ()
 Clears out subtask status entries that are either completed or canceled which were started by this controller.
- 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.
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT.
bool testInvariant () const
virtual bool createPortGroups ()
 Called by init.
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 Creates a PSR for this component and registers it with the PSR manager.
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick.
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations for this component.
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr pointTaskVisualization (const DtString &name)
 Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr lineTaskVisualization (const DtString &name)
 Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (const DtString &name)
 Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr textTaskVisualization (const DtString &name)
 Finds an existing or creates a new text task visualization with the given name.
double calculateNextTaskVisTickTime () const
 Determines the next time the task visualizations should be ticked.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()
- Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Static Protected Member Functions

static void objectAddedCb (DtVrfObject *, void *)
 Called when object is added. Check to see if this is the object we are looking for in our task.
static void setTargetCallback (DtSimMessage *msg, void *usr)
 Static callback function. Calls processSetTarget().

Protected Attributes

DtObjectTypesListOutputPortmyTypesToDetectOutputPort
 Port I/O Interface:
DtTargetSelectionControllerPSRmyProcessState
 Container for state data associated with this component.
DtSensorContactInfoListChangeMonitor myContactListChangeMonitor
DtForceType myForce
 Force used to put information onto port for hostility matrix.
bool mySetupDetectableForcesRequired
 Flag set to true if a re-run of the setupDetectableForces() is required on the next tick.
DtWeaponInterfaceList myWeaponInterfaceList
 List of weapon interfaces through which the target selection controller communicates with weapon systems.
DtRwInt myNextPriorityValue
 The next default priority level to use for a weapon.
artPartWeaponMap myArticulatedPartWeapons
 A map of articulated part numbers to lists of weapons that are attached to the part directly or indirectly.
bool myHavePrintedSurrender
 For debugging print statements.
bool myHavePrintedNoNewContacts
bool myRegisteredAddCallback

Private Member Functions

 DtTargetSelectionController ()
 Not Implemented.
 DtTargetSelectionController (const DtTargetSelectionController &orig)
 Not Implemented.
DtTargetSelectionControlleroperator= (const DtTargetSelectionController &orig)
 Not Implemented.
virtual void processFireAtTargetTask (DtSimMessage *msg)
virtual bool processFireAtTargetTask (DtFireAtTargetTask *, bool &foundValidWeapon)
 Returns true if object exists.
static void fireAtTargetTaskCallback (DtSimMessage *msg, void *usr)
 Processes Fire at Target tasks.
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.
virtual void processFireNow (DtSimMessage *msg)
static void fireNowCallback (DtSimMessage *msg, void *usr)
 Processes fire now by tasking itself a DtFireAtTarget task.
static void hostilitiesChangedCallback (DtU8 force, void *usr)
 Callback invoked by the hostility manager when the hostility matrix is changed.
virtual void processHostilitiesChanged (DtU8 force)

Additional Inherited Members

- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

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

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 
)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

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.

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

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns
New instance of this class.
static void DtTargetSelectionController::objectAddedCb ( 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 ( 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 DtSensorContactInfoList contactList,
const DtWeaponComponentInterface weapIf,
DtRwSensorContactInfo userTargetInfo,
DtOrderedTargetSet orderedTargets 
)
protectedvirtual
virtual void DtTargetSelectionController::setTargetsToWeaponInterface ( DtWeaponComponentInterface weapIf,
DtRwSensorContactInfo userTargetInfo,
DtOrderedTargetSet orderedTargets 
)
protectedvirtual
virtual void DtTargetSelectionController::findWeaponControlInterfaces ( )
protectedvirtual

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

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::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 the first weapon should yield to the second weapon, if they conflict (i.e.

if they use the same token resource or the same turret). If weapon1IsBeingTasked is true, then weapon1 is treated as if it is tasked. This argument should be set when weapon1 is being considered for a fire-at-target task. Weapon2 task status is determined from its isExplicitlyTasked access function.

The test considers the priority of the weapons, and also whether they are tasked or are being considered for tasking: If the weapon is being tasked, then the other weapon takes precedence if it has a higher priority, except if it is firing at an auto-selected target and is not using task priority for it (per parameter setting). If the weapon is not being tasked, i.e. is auto-selecting a target, then the other weapon takes precedence if it has a higher priority, and also if it has a lower priority, is tasked, and the weapon is not using tasked priority for auto-selected targets.

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

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

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
conflictingArtPartreturns 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
weaponIsBeingTaskedshould 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).
conflictingWeaponReturns a pointer to the (first) weapon found that blocks the given weapon.
controlExternalTurretIf 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
weaponThe weapon that is now firing.

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.

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.

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:

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)