WSF
WsfQuantumTaskerProcessor Class Reference

#include <WsfQuantumTaskerProcessor.hpp>

Inheritance diagram for WsfQuantumTaskerProcessor:
Collaboration diagram for WsfQuantumTaskerProcessor:

Public Types

enum  AssetRepresentationType { cPLATFORM , cSYSTEMS , cRESOURCES }
enum  ReallocationStrategyType { cSTATIC , cDYNAMIC , cRESPONSE , cEVENT }
using AllocationMap = std::map<int, std::set<WsfAssetPerception*>>
Public Types inherited from WsfTaskManager
enum  TrackUpdateStrategy { cDEFAULT , cBATCH }
using RoleIterator = WsfComponentList::RoleIterator<WsfTaskManagerComponent>
 typedef to simplify iteration for calling WsfTaskManagerComponent methods.
using TaskList = std::list<WsfTask>
using PendingMessageList = std::list<PendingMessage>
using TrackList = std::list<ActiveTrack>
using TrackListIter = std::list<ActiveTrack>::iterator
using SensorRequestList = std::list<SensorRequest>
using ComponentList = WsfComponentListT<WsfProcessorComponent>
Public Types inherited from WsfPlatformPart
enum  { cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using InternalMessageQueue = std::queue<WsfMessage*>
using RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart*, WsfMessage*>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringIdTypeList
 The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform ParentType
 This is needed to support the WsfComponentList template.

Public Member Functions

 WsfQuantumTaskerProcessor (WsfScenario &aScenario)
 WsfQuantumTaskerProcessor (WsfScenario &aScenario, const std::string &aPartClass, const std::string &aPartName)
 WsfQuantumTaskerProcessor (const WsfQuantumTaskerProcessor &aSrc)
WsfQuantumTaskerProcessoroperator= (const WsfQuantumTaskerProcessor &)=delete
 ~WsfQuantumTaskerProcessor () override
Public Member Functions inherited from WsfTaskManager
 WsfTaskManager (WsfScenario &aScenario, const std::string &aClassName="WsfTaskManager")
 Constructor.
WsfTaskManageroperator= (const WsfTaskManager &)=delete
 ~WsfTaskManager () override=default
const char * GetScriptClassName () const override
WsfProcessorClone () const override
 A virtual copy constructor.
const int * GetComponentRoles () const override
void * QueryInterface (int aRole) override
bool PreInitialize (double aSimTime) override
bool Initialize (double aSimTime) override
bool Initialize2 (double aSimTime) override
bool ProcessInput (UtInput &aInput) override
void PlatformDeleted (WsfPlatform *aPlatformPtr) override
bool ProcessMessage (double aSimTime, const WsfMessage &aMessage) override
bool ReceiveMessage (double aSimTime, const WsfMessage &aMessage) override
void TurnOff (double aSimTime) override
void TurnOn (double aSimTime) override
void Update (double aSimTime) override
virtual bool AssignTask (double aSimTime, const WsfTrack &aTrack, WsfStringId aTaskType, const WsfTaskResource &aResource, WsfPlatform *aAssigneePtr, WsfStringId aCommName)
virtual bool CancelTask (double aSimTime, unsigned int aTaskId)
virtual void CancelTask (double aSimTime, WsfTask &aTask, bool aSendCancelMessage)
virtual bool CancelTask (double aSimTime, const WsfTrackId &aTrackId, WsfStringId aTaskType, const WsfTaskResource &aResource, size_t aAssigneeIndex)
virtual bool CreateDelayTask (double aSimTime, double aDelayTime, const WsfTrack &aTrack, WsfStringId aTaskType)
virtual bool ChangeOperatingLevel (double aSimTime, WsfStringId aName, int aLevel, WsfPlatform *aAssigneePtr, WsfStringId aCommName)
 Change the operating level for a given subordinate.
void AssigneesForTask (const WsfTrackId &aTrackId, WsfStringId aTaskType, std::vector< size_t > &aAssignees) const
size_t AssigneeForTask (const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName) const
int OperatingLevelFor (WsfStringId aConditionName) const
 Return the current operating level for the specified condition name or status.
int TasksAssignedTo (size_t aAssigneeIndex, const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName) const
int TasksAssignedFor (const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName) const
int TasksReceivedFor (const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName) const
double TimeTaskAssigned (const WsfTrackId &aTrackId, WsfStringId aTaskType, size_t aAssigneeIndex) const
 Return the simulation time when a task was assigned.
TaskListAssignedTaskList ()
 Return the list of tasks this TaskManager has assigned.
TaskListReceivedTaskList ()
 Return the list of tasks this TaskManager has received.
double TimeLastTaskAssigned () const
double TimeLastTaskReceived () const
void CheckMessageAcknowledged (double aSimTime, unsigned int aSerialNumber)
bool SendTaskMessage (double aSimTime, const WsfMessage &aMessage, size_t aRecipientIndex, WsfStringId aCommName, bool aReliable)
double SendTrackUpdate (double aSimTime, unsigned int aTaskId)
WsfStringId SelectCommDevice (WsfPlatform *aAssigneePtr, WsfStringId aCommName)
const TrackListActiveTrackList () const
 Return the list of tasks this TaskManager has active.
bool ShowTaskMessages () const
Public Member Functions inherited from WsfScriptProcessor
 WsfScriptProcessor (const WsfScenario &aScenario)
 WsfScriptProcessor (const WsfScenario &aScenario, WsfStringId aPartClass, const std::string &aPartVarName)
 ~WsfScriptProcessor () override
void SendMessage (double aSimTime, const WsfMessage &aMessage) override
virtual void ExecuteOnMessageCreate (double aSimTime, WsfMessage &aMessage)
virtual bool ExecuteScript (double aSimTime, const std::string &aScriptName)
virtual bool ExecuteScript (double aSimTime, WsfStringId aScriptName, UtScriptData &aScriptRetVal, const UtScriptDataList &aScriptArgs=UtScriptDataList())
void ExecuteScriptAtTime (double aTime, WsfStringId aScriptName, const UtScriptDataList &aScriptArgs)
virtual void SuppressMessage (bool aSuppressMessage)
WsfScriptMessageHandlerGetMessageHandler ()
WsfScriptContextGetScriptContext ()
UtScriptContext * GetScriptAccessibleContext () const override
void SetPlatform (WsfPlatform *aPlatformPtr) override
const WsfBehaviorTreeBehaviorTree () const
WsfAdvancedBehaviorTreeAdvancedBehaviorTree () const
virtual const WsfScriptStateMachineGetStateMachine () const
wsf::ExternalLinksGetExternalLinks ()
std::string State ()
std::string StateAll ()
void SetState (std::string &stateName)
void SetStateAll (std::string &stateNameAll)
Public Member Functions inherited from WsfProcessor
 WsfProcessor (const WsfScenario &aScenario)
 ~WsfProcessor () override=default
ComponentListGetComponents ()
const ComponentListGetComponents () const
virtual void ProcessCallback (double aSimTime, const WsfCallback &aCallback)
WsfComponentCloneComponent () const override
int GetComponentInitializationOrder () const override
const char * GetScriptClassName () const override
void PreInput () override
void SetNonOperational (double aSimTime) override
void SetOperational (double aSimTime) override
void PartBroken (double aSimTime) override
double GetUpdateInterval () const override
void SetUpdateInterval (double aUpdateInterval) override
Public Member Functions inherited from WsfPlatformPart
 WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPartoperator= (const WsfPlatformPart &aRhs)=delete
 ~WsfPlatformPart () override
bool DebugEnabled () const
 Returns 'true' if debugging is enabled for this instance.
void SetDebugEnabled (bool aDebugEnabled)
unsigned int GetDebugMask ()
bool IsExternallyControlled () const
virtual void SetExternallyControlled (double aSimTime, bool aIsExternallyControlled)
int GetPartType () const
const char * GetScriptClassName () const override
WsfSimulationGetSimulation () const
const WsfScenarioGetScenario () const
WsfStringId GetComponentName () const override
void ComponentParentChanged (WsfPlatform *aPlatformPtr) override
WsfPlatformGetPlatform () const
virtual void PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
double GetLastStatusChangeTime () const
void SetLastStatusChangeTime (double aSimTime)
 Allows a system to set the time at which the device was initialized.
bool CanBeMadeOperational () const
 Returns an indication that this system can be made operational.
bool CanBeMadeNonOperational () const
 Returns an indication that this system can be made non-operational.
bool CanBeTurnedOn () const
 Returns an indication that this system can be turned on.
bool CanBeTurnedOff () const
 Returns an indication that this system can be turned off.
bool IsTurnedOn () const
bool InitiallyTurnedOn () const
 Is the system to be turned 'on' when added to the simulation?
void SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
 Sets if the system is turned on when added to the simulation.
virtual void Restore (double aSimTime)
bool IsOperational () const
bool SetOperational (double aSimTime, bool aMakeOperational)
double GetDamageFactor () const
bool SetDamageFactor (double aSimTime, double aDamageFactor)
bool IsCritical () const
void SetCritical (bool aValue)
virtual void OnPlatformBrokenEvent (double aSimTime)
 Owning platform has issued a broken event.
bool IsBroken () const
WsfInternalLinksGetInternalLinks ()
 Return the internal links for this part.
virtual bool HasInternalLinks () const
 Does this platform part have a communication link to other platform parts?
virtual void SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void SendQueuedMessages (double aSimTime)
const WsfCategoryListGetCategories () const
 Get the categories to which this part belongs.
void AddCategory (WsfStringId aCategoryId)
 Adds the provided category to the platform part's category list.
bool IsCategoryMember (WsfStringId aCategoryId) const
const WsfGroupListGetGroups () const
 Get the groups to which this platform part belongs.
void JoinGroup (WsfGroup *aGroupPtr)
 Join the given group.
void LeaveGroup (WsfGroup *aGroupPtr)
 Leave the given group.
bool IsGroupMember (WsfStringId aGroupId)
unsigned int GetUpdateEventEpoch () const
void IncrementUpdateEventEpoch ()
bool UpdateEventActive () const
 Is an 'Update' event active?
void SetUpdateEventActive (bool aUpdateEventActive)
 Indicate if the 'Update' event is active.
Public Member Functions inherited from WsfObject
 WsfObject ()
 This is the constructor for the WsfObject class.
 ~WsfObject () override
 This is the destructor for the WsfObject class.
const char * GetScriptClassName () const override
const std::string & GetType () const
WsfStringId GetTypeId () const
 Get the string ID of the 'type' of the object.
void SetType (WsfStringId aType)
const std::string & GetBaseType () const
WsfStringId GetBaseTypeId () const
const TypeListGetTypeList () const
bool IsA_TypeOf (WsfStringId aType) const
WsfObjectoperator= (const WsfObject &aRhs)
 Assignment operator.
template<typename T>
void Serialize (T &aBuff)
 For XIO (de)serialization.
const std::string & GetName () const
WsfStringId GetNameId () const
void SetName (WsfStringId aName)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
 WsfComponentT ()
 WsfComponentT (const WsfComponentT &) noexcept
WsfComponentToperator= (const WsfComponentT &) noexcept
 ~WsfComponentT () override=default
ParentTypeGetComponentParent () const
void SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual ~WsfComponent ()=default
template<typename T>
bool QueryInterfaceT (T *&aRolePtr)
bool ComponentHasRole (int aRole)
 Returns true if the component has the specified role.
Public Member Functions inherited from WsfUniqueId
 WsfUniqueId ()
 Construtor initializes the unique identifier to 0.
 WsfUniqueId (const WsfUniqueId &)
 Copy constructor initializes the unique identifier to 0.
WsfUniqueIdoperator= (const WsfUniqueId &)
unsigned int GetUniqueId () const
 Get the unique identifier assigned to this object.
template<typename T>
void Serialize (T &aBuff)
 For XIO (de)serialization.
Public Member Functions inherited from WsfAuxDataEnabled
 WsfAuxDataEnabled ()=default
 WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabledoperator= (const WsfAuxDataEnabled &aRhs)
 WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabledoperator= (WsfAuxDataEnabled &&)=default
virtual ~WsfAuxDataEnabled () noexcept
void SetAuxData (const WsfAttributeContainer &aAuxData)
void DeleteAuxData ()
 Delete the aux data container from the object.
void MergeAuxData (const WsfAuxDataEnabled &aSrc)
 Merge the object's aux data with aux data from an existing object.
void UpdateAuxData (const WsfAuxDataEnabled &aSrc)
 Update the object's aux data with aux data from an existing object.
bool HasAuxData () const
 Returns true if this object has aux data.
bool ProcessInput (UtInput &aInput)
template<typename T>
void Serialize (T &aBuff)
 (De)serialization for XIO
WsfAttributeContainerGetAuxData ()
const WsfAttributeContainerGetAuxData () const noexcept
const WsfAttributeContainerGetAuxDataConst () const noexcept
Public Member Functions inherited from WsfQuantumMatrix
 WsfQuantumMatrix ()=default
 WsfQuantumMatrix (const WsfQuantumMatrix &aSrc)
WsfQuantumMatrixoperator= (const WsfQuantumMatrix &)
virtual ~WsfQuantumMatrix ()
std::vector< WsfAssetPerception * > & Assets ()
std::vector< WsfQuantumTask * > & Tasks ()
std::vector< std::vector< double > > & Values ()
double Value (size_t taskIndex, size_t assetIndex)
std::vector< std::vector< double > > & Profit ()
double Profit (size_t taskIndex, size_t assetIndex)
void ClearAssets ()
void SetAssets (std::vector< WsfAssetPerception * > &aAssets)
void SetTasks (std::vector< WsfQuantumTask * > &aTasks)
void ClearTasks ()
void EraseTask (size_t taskIndex)
void RemoveTask (size_t taskIndex)
void EraseAsset (size_t assetIndex)
void RemoveAsset (size_t assetIndex)

Task status response methods

bool ReportTaskProgress (double aSimTime, WsfTask &aTask, WsfStringId aSubStatus)
 Sends a WsfTaskStatusMessage with status cIN_PROGRESS to the task assigner.
bool ReportTaskComplete (double aSimTime, WsfTask &aTask, WsfStringId aSubStatus)
bool RejectTask (double aSimTime, WsfTask &aTask)
void TaskCompleted (double aSimTime, WsfTask &aTask) override
 callback for extra processing when a task is marked complete
void UpdateEvaluations (double aSimTime, WsfQuantumEvaluator &aEvaluator, std::vector< WsfLocalTrack * > &aPerception) override
 This overwrites the WsfQuantumMatrix method so it can filter out any pairings between assets and tasks they have rejected.
WsfSimulationGetSimulation () const
bool AcquireResource (double aSimTime, WsfTask &aTask, const WsfTrack &aTrack) override
bool ReleaseResource (double aSimTime, WsfTask &aTask) override
bool Rejected (WsfAssetPerception *aAssetPtr, WsfQuantumTask *aTaskPtr)
 Returns whether or not this asset has ever rejected this task.
bool RejectedAnyTasks (WsfAssetPerception *aAssetPtr)
 Returns whether or not this asset has ever rejected any tasks.
bool RejectedByAnyAsset (WsfQuantumTask *aTaskPtr)
 Returns whether or not this task has ever been rejected.
bool CompletedAfter (WsfQuantumTask *aTaskPtr, double aSimTime)
 Returns whether or not this task has been reported as completed after the given sim time.
void SetMatrixAssets (double aSimTime)
void SetMatrixTasks (double aSimTime, std::map< int, std::set< size_t > > &aAllocationMap)
void SetAllocations (AllocationList &aList)
void AllocateExtraTasks (AllocationList &aList)
void AllocateExtraAssets (AllocationList &aList)
virtual bool ReportTaskComplete (double aSimTime, const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName, WsfStringId aSubStatus)
virtual bool ReportTaskProgress (double aSimTime, const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName, WsfStringId aSubStatus)

Standard processor function overwrites

WsfProcessorClone () const override
bool PreInitialize (double aSimTime) override
bool Initialize (double aSimTime) override
bool Initialize2 (double aSimTime) override
bool ProcessInput (UtInput &aInput) override
void Update (double aSimTime) override
bool ProcessMessage (double aSimTime, const WsfMessage &aMessage) override
bool ReceiveMessage (double aSimTime, const WsfMessage &aMessage) override
void PlatformDeleted (WsfPlatform *aPlatformPtr) override
const char * GetScriptClassName () const override

Overwrite base message handler.

bool ProcessTaskAssignMessage (double aSimTime, const WsfTaskAssignMessage &aMessage) override
bool ProcessTaskStatusMessage (double aSimTime, const WsfTaskStatusMessage &aMessage) override

Provide task assignment methods - track not required

virtual bool AssignTask (double aSimTime, const WsfTask &aTask)
bool AssignTask (double aSimTime, const WsfTrack &aTrack, const WsfTask &aTask, bool aLockTrack=true) override

Overwrite for no locking & unlocking of local tracks

void PurgeReceivedTask (double aSimTime, WsfTask &aTask) override
void PurgeTransmittedTask (double aSimTime, WsfTask &aTask) override
void UpdateTaskCorrelation (double aSimTime, WsfTask &aTask) override
 Update the task track/local track correlation in a received task.

Allocation Strategy Settings

virtual void SetAssetRepresentation (AssetRepresentationType aType)
virtual void SetReallocationStrategy (ReallocationStrategyType aType)
 See comments for ReallocationStrategyType enum.
virtual void SetIgnoreAllyTracks (bool aVal)
 Sets whether or not ally tracks are passed to the generator (and subsequently tasks on those tracks will be used).
WsfQuantumGeneratorGenerator () const
WsfQuantumEvaluatorEvaluator () const

Task assignment queries

std::list< WsfTask * > TaskListReceivedOfType (WsfStringId aTaskType)
 The list is not filtered by the task type if it is zero.
std::list< WsfTask * > TaskListReceivedForTrack (const WsfTrackId &aTrackId)
 The list is not filtered by the WsfTrackId if it is null.
std::list< WsfTask * > TaskListReceivedOfTypeForTrack (WsfStringId aTaskType, const WsfTrackId &aTrackId)
 The list is not filtered by the WsfTrackId if it is null.
std::list< WsfTask * > TaskListReceivedForResourceType (int aResourceType)
 The list is not filtered by the ResourceType if it is cNONE.
std::list< WsfTask * > TaskListReceivedForResourceName (WsfStringId aResourceName)
 The list is not filtered by the resource name if it is zero.
std::list< WsfTask * > TaskListAssignedOfType (WsfStringId aTaskType)
std::list< WsfTask * > TaskListAssignedForTrack (const WsfTrackId &aTrackId)
std::list< WsfTask * > TaskListAssignedForResourceType (int aResourceType)
std::list< WsfTask * > TaskListAssignedForResourceName (WsfStringId aResourceName)

Task assignee queries

std::set< size_t > AssigneesForTask (WsfQuantumTask *aTaskPtr)
std::set< WsfAssetPerception * > AssetAssigneesForTask (WsfQuantumTask *aTaskPtr)
void AssigneesForTask (const WsfTrackId &aTrackId, WsfStringId aTaskType, std::vector< size_t > &aAssignees) const

Additional Inherited Members

static TaskList::iterator FindTask (TaskList &aTaskList, size_t aAssigneeIndex, const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName)
static TaskList::iterator FindTask (TaskList &aTaskList, unsigned int aTaskId)
static TaskList::iterator FindTask (TaskList &aTaskList, unsigned int aTaskId, size_t aAssigneeIndex)
Static Public Member Functions inherited from WsfQuantumMatrix
static void SetRow (std::vector< std::vector< double > > &m, size_t aRow, double aValue)
static void RemoveRow (std::vector< std::vector< double > > &m, size_t aRow)
static void SetColumn (std::vector< std::vector< double > > &m, size_t aCol, double aValue)
static void RemoveColumn (std::vector< std::vector< double > > &m, size_t aCol)
UtCallbackListN< void(double, WsfTask &, const WsfTrack &)> OnTaskAssigned
 Executes when an assigned task is accepted (by this processor).
UtCallbackListN< void(double, WsfTask &)> OnTaskCanceled
 Executes when a task cancel message is processed.
UtCallbackListN< void(double, WsfTask &)> OnTaskCompleted
 Executes when an task complete is received.
UtCallbackListN< void(double, WsfTask &, const WsfTrack &)> OnTaskAssignSent
 Executes when a task assignment is sent.
UtCallbackListN< void(double, WsfTask &, WsfStringId)> OnTaskCompleteSent
 Executes when a task complete is sent.
UtCallbackListN< void(double, WsfTask &)> OnTaskCancelSent
 Executes when a task cancel is sent.
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)> AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)> AuxDataDestroyed
virtual bool ProcessAssociationMessage (double aSimTime, const WsfAssociationMessage &aMessage)
virtual bool ProcessTaskCancelMessage (double aSimTime, const WsfTaskCancelMessage &aMessage)
virtual bool ProcessTaskControlMessage (double aSimTime, const WsfTaskControlMessage &aMessage)
virtual bool ProcessTrackDropMessage (double aSimTime, const WsfTrackDropMessage &aMessage)
 any sensor tasks for the dropped track will be reported complete/successful
virtual bool ProcessTrackMessage (double aSimTime, const WsfTrackMessage &aMessage)
 WsfTaskManager (const WsfTaskManager &aSrc)
 Copy constructor.
virtual void TaskCanceled (double aSimTime, WsfTask &aTask)
virtual void TaskAssignSent (double aSimTime, const WsfTrack &aTrack, WsfTask &aTask)
virtual void TaskAssigned (double aSimTime, const WsfTrack &aTrack, WsfTask &aTask)
virtual void TaskCorrelated (double aSimTime, WsfTask &aTask)
 Called when a task has been correlated with a local track.
virtual void OperatingLevelChanged (double aSimTime, std::string aLevel)
virtual void TrackDropped (double aSimTime, const WsfTrackId &aTrackId)
bool DropFromPurgedTaskList (TaskList &aPurgedTaskList, size_t aAssignerIndex, unsigned int aTaskId)
bool GetMessageSender (const WsfMessage &aMessage, size_t &aSenderIndex, WsfStringId &aRcvrCommName)
 Given a message, get the platform index of the sender and the local device on which the message was received.
void MessageAcknowledged (unsigned int aSerialNumber)
Protected Member Functions inherited from WsfScriptProcessor
 WsfScriptProcessor (const WsfScriptProcessor &aSrc)
 WsfProcessor (const WsfProcessor &aSrc)
 Copy constructor (for Clone()).
WsfProcessoroperator= (const WsfProcessor &aRhs)=delete
 WsfPlatformPart (const WsfPlatformPart &aSrc)
 Copy constructor (for Clone()).
 WsfObject (const WsfObject &aSrc)
 Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void AssignUniqueId (WsfSimulation *aSimulationPtr)
WsfTrackManagermTrackManagerPtr
 The track manager that owns the tracks.
std::unique_ptr< WsfTimeDelayQueuemThinkerPtr
 The pointer to the 'thinker'.
PendingMessageList mPendingMessageList
TrackList mActiveTrackList
SensorRequestList mSensorRequestList
std::map< WsfStringId, int > mOperatingLevels
std::set< WsfSensor * > mSensorsTurnedOn
 The sensors that have been implicitly turned on.
WsfScenariomScenarioPtr
UtCallbackHolder mCallbacks
TaskList mXmtdTaskList
 Tasks I have sent to others.
TaskList mPurgedXmtdTaskList
TaskList mRcvdTaskList
 Tasks I have received from others.
TaskList mPurgedRcvdTaskList
std::set< WsfTrackIdmPendingRcvdTasks
 The set of assigned track ID's that are awaiting correlation with local track ID's.
WsfStringId mTrackProcessorName
 The name of the track processor whose track manager is the source of tracks.
double mTrackUpdateInterval
WsfRandomVariable mTimeToRecognizeMessage
 The amount of time it takes to recognize a message.
double mCommRetryInterval
 The amount of time between attempts to retry failed communications.
int mCommRetryAttempts
 The number of attempts to retry failed communications.
unsigned int mNextTaskId
 The next task ID to be assigned.
bool mShowTaskMessages
 True if task related messages are to be displayed.
bool mShowUncompletedTasks
 True if leak termination data is to be shown.
TrackUpdateStrategy mTrackUpdateStrategy
 Determine how track updates are sent.
double mTimeLastTaskAssigned
 The time a task was last sent.
double mTimeLastTaskReceived
 The time a task was last received.
Protected Attributes inherited from WsfScriptProcessor
WsfScriptContextmContextPtr
 Pointer to the script context.
WsfScriptMessageHandlermMessageHandlerPtr
 Pointer to the 'on_message' handler.
UtScript * mOnMessageCreateScriptPtr
 Pointer to the 'on_message_create' script.
UtScriptClass * mMessageClassPtr
wsf::ExternalLinks mExternalLinks
 The external recipients.
WsfBehaviorTreemBehaviorTreePtr
ut::CloneablePtr< WsfAdvancedBehaviorTreemAdvancedBehaviorTreePtr
std::unique_ptr< WsfScriptStateMachinemStateMachinePtr
int mStateIndex
bool mSuppressMessage
Protected Attributes inherited from WsfQuantumMatrix
std::vector< WsfAssetPerception * > mAssets
std::vector< WsfQuantumTask * > mTasks
std::vector< std::vector< double > > mValues
std::vector< std::vector< double > > mProfits

Detailed Description

WsfQuantumTaskerProcessor is a class for task control. All tasks sent or received by this processor are intended to be compatible with the WsfTaskManager.

This class allows the user to choose or even custom define every step of the tasking process that occurs each update. Some steps are filtered or tailored based on user selected strategies, for example: a task won't be reassigned if using the cSTATIC strategy. The current steps each update in the tasking process are:

  • Generation: tasks are generated according to asset & threat perception.
  • Evaluation: every theoretical asset-task pairing is given a value.
  • Allocation: an allocation algorithm is performed upon the value matrix.
  • Strategy: the reallocation strategy determines how various cases are handled:
    • tasks re-assignment? when rejected? whenever profitable? never? when perception changes?

If a task reassignment is being performed, a cancel message is sent to the old assignee. If a task stops being generated on update, a cancel message is sent to the old assignee.

If a task is still generated for a stale track, but the task has been reported as completed, then it will not be reassigned unless the track updates as more current than the completion message.

Task assignment messages are only sent on first assign, they are not sent continually

Member Typedef Documentation

◆ AllocationMap

Member Enumeration Documentation

◆ AssetRepresentationType

Enumerator
cPLATFORM 
cSYSTEMS 
cRESOURCES 

◆ ReallocationStrategyType

Enumerator
cSTATIC 
cDYNAMIC 
cRESPONSE 
cEVENT 

Constructor & Destructor Documentation

◆ WsfQuantumTaskerProcessor() [1/3]

◆ WsfQuantumTaskerProcessor() [2/3]

WsfQuantumTaskerProcessor::WsfQuantumTaskerProcessor ( WsfScenario & aScenario,
const std::string & aPartClass,
const std::string & aPartName )

◆ WsfQuantumTaskerProcessor() [3/3]

WsfQuantumTaskerProcessor::WsfQuantumTaskerProcessor ( const WsfQuantumTaskerProcessor & aSrc)

◆ ~WsfQuantumTaskerProcessor()

WsfQuantumTaskerProcessor::~WsfQuantumTaskerProcessor ( )
override

Member Function Documentation

◆ AcquireResource()

bool WsfQuantumTaskerProcessor::AcquireResource ( double aSimTime,
WsfTask & aTask,
const WsfTrack & aTrack )
overrideprotectedvirtual

Reimplemented from WsfTaskManager.

◆ AllocateExtraAssets()

void WsfQuantumTaskerProcessor::AllocateExtraAssets ( AllocationList & aList)
protected

◆ AllocateExtraTasks()

void WsfQuantumTaskerProcessor::AllocateExtraTasks ( AllocationList & aList)
protected

◆ AssetAssigneesForTask()

std::set< WsfAssetPerception * > WsfQuantumTaskerProcessor::AssetAssigneesForTask ( WsfQuantumTask * aTaskPtr)
Returns
set of asset perceptions of task assignees (tasks assigned & sent to them)

References WsfQuantumTask::GetUniqueId().

Referenced by WsfMilEventPipe::QuantumTaskerUpdate().

◆ AssigneesForTask() [1/2]

void WsfTaskManager::AssigneesForTask ( const WsfTrackId & aTrackId,
WsfStringId aTaskType,
std::vector< size_t > & aAssignees ) const

Return the list of platform (indexes) of the assignees for the specified task.

Parameters
aTrackIdThe local track ID of the track of interest. If null then the track ID is not a selection criteria.
aTaskTypeThe task type of the tasks to be counted. If zero then the task type is not a selection criteria.
aAssigneesThe indexes of the platforms that have been assigned to the specified task.

References WsfScriptProcessor::mContextPtr.

◆ AssigneesForTask() [2/2]

std::set< size_t > WsfQuantumTaskerProcessor::AssigneesForTask ( WsfQuantumTask * aTaskPtr)
Returns
set of platform indices of task assignees (tasks assigned & sent to them)

Returns the set of platform indexes that represent all task assignees The set will be empty if the task is not currently assigned

References WsfTask::GetTaskId(), and WsfTaskManager::mXmtdTaskList.

Referenced by Update().

◆ AssignTask() [1/2]

◆ AssignTask() [2/2]

bool WsfQuantumTaskerProcessor::AssignTask ( double aSimTime,
const WsfTrack & aTrack,
const WsfTask & aTask,
bool aLockTrack = true )
overridevirtual
Parameters
aSimTime:: simulation time
aTrack:: track to be associated with the task
aTask:: task to assign, assign message will be sent if not already
aLockTrack:: parameter ignored in this function overwrite
Returns
'true' if possible to assign

Reimplemented from WsfTaskManager.

References AssignTask(), WsfTaskManager::AssignTask(), WsfTrack::GetTrackId(), and WsfTrackId::IsNull().

◆ Clone()

WsfProcessor * WsfQuantumTaskerProcessor::Clone ( ) const
overridevirtual

Create a clone of this object.

Returns
A pointer to the new copy.

Implements WsfProcessor.

References WsfProcessor::WsfProcessor(), and WsfQuantumTaskerProcessor().

Referenced by WsfScriptQuantumTaskerProcessor::Clone(), and WsfBrawlerProcessor::CloneComponent().

◆ CompletedAfter()

bool WsfQuantumTaskerProcessor::CompletedAfter ( WsfQuantumTask * aTaskPtr,
double aSimTime )
protected

Returns whether or not this task has been reported as completed after the given sim time.

Returns
'true' if the aTask was marked complete after aSimTime

References WsfQuantumTask::GetUniqueId().

Referenced by SetMatrixTasks().

◆ Evaluator()

WsfQuantumEvaluator * WsfQuantumTaskerProcessor::Evaluator ( ) const
inline

◆ Generator()

WsfQuantumGenerator * WsfQuantumTaskerProcessor::Generator ( ) const
inline

◆ GetScriptClassName()

const char * WsfQuantumTaskerProcessor::GetScriptClassName ( ) const
override

◆ GetSimulation()

◆ Initialize()

bool WsfQuantumTaskerProcessor::Initialize ( double aSimTime)
overridevirtual

Perform phase 1 initialization of the part. This is invoked by WsfPlatform::Initialize() during phase 1 initialization of the platform. During phase 1 initialization, platform components must not assume the existence of ANY data that is the responsibility of another platform component. In particular, the platform location and initial tracks cannot be assumed to be valid.

Parameters
aSimTimeThe current simulation time.
Returns
'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfProcessor.

References WsfPerceptionProcessor::GetPerceptionProcessor(), WsfPlatformPart::GetPlatform(), WsfScriptProcessor::GetScriptContext(), WsfTaskManager::Initialize(), and ok.

Referenced by WsfBrawlerProcessor::Initialize().

◆ Initialize2()

bool WsfQuantumTaskerProcessor::Initialize2 ( double aSimTime)
overridevirtual

Perform phase 2 initialization of the part. This is invoked by WsfPlatform::Initialize() during phase 2 initialization of the platform. During phase 2, platform components may assume that the platform location has been defined, initial tracks have been loaded and that all components have completed phase 1 initialization.

Parameters
aSimTimeThe current simulation time.
Returns
'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfProcessor.

References WsfTaskManager::Initialize2().

◆ operator=()

◆ PlatformDeleted()

void WsfQuantumTaskerProcessor::PlatformDeleted ( WsfPlatform * aPlatformPtr)
overridevirtual

Some other platform has been deleted from the simulation.

This is invoked (via WsfPlatform::PlatformDeleted) whenever another platform has been deleted from the simulation.

Parameters
aPlatformPtrPointer to the platform being deleted.

Reimplemented from WsfPlatformPart.

References WsfTaskManager::PlatformDeleted().

◆ PreInitialize()

bool WsfQuantumTaskerProcessor::PreInitialize ( double aSimTime)
overridevirtual

Perform pre-initializion function. This is called by WsfPlatform::Initialize prior to actually initializing the components on a platform (i.e.: calling Initialize and Initialize2 for each component). The primary reason for this method is to allow components to add other components that will then be subsequently initialized. The component may examine the component list and add components, but it must not assume ANYTHING about the actual state of the component.

Parameters
aSimTimeThe current simulation time.
Returns
true if successful or false if unsuccessful (bad input data, etc.)

Reimplemented from WsfProcessor.

References WsfTaskManager::PreInitialize().

◆ ProcessInput()

bool WsfQuantumTaskerProcessor::ProcessInput ( UtInput & aInput)
overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters
aInputa reference to a UtInput object.
Returns
'true' if the command was one recognized by the class or 'false' if not.
Exceptions
UtInput::ExceptionBase(or an object derived from it) if the command was recognized but contains some sort of error.
Note
If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfProcessor.

References cDYNAMIC, cEVENT, cPLATFORM, WsfQuantumEvaluatorFactory::CreateEvaluator(), WsfQuantumGeneratorFactory::CreateGenerator(), cRESOURCES, cRESPONSE, cSTATIC, cSYSTEMS, WsfQuantumAllocatorFactory::Instance(), WsfQuantumEvaluatorFactory::Instance(), WsfQuantumGeneratorFactory::Instance(), WsfScriptProcessor::mContextPtr, WsfTaskManager::ProcessInput(), SetIgnoreAllyTracks(), and SetReallocationStrategy().

Referenced by WsfBrawlerProcessor::ProcessInput().

◆ ProcessMessage()

bool WsfQuantumTaskerProcessor::ProcessMessage ( double aSimTime,
const WsfMessage & aMessage )
overridevirtual

Process a received message.

Parameters
aSimTimeThe current simulation time.
aMessageThe message that is being sent.
Returns
'true' if the message was processed or 'false' if not.
Note
A message is first received by ReceiveMessage which then calls ProcessMessage to process the message. A derived class ReceiveMessage method may choose to delay the message before calling ProcessMessage or may choose to ignore the message altogether.

Reimplemented from WsfPlatformPart.

References WsfScriptProcessor::ProcessMessage(), and WsfTaskManager::ProcessMessage().

◆ ProcessTaskAssignMessage()

◆ ProcessTaskStatusMessage()

◆ PurgeReceivedTask()

void WsfQuantumTaskerProcessor::PurgeReceivedTask ( double aSimTime,
WsfTask & aTask )
overridevirtual

these function are being overwritten so that the local track associated with the quantum task is not locked or unlocked

Parameters
aSimTime:: simulation time
aTask:: task to be purged or correlated

Reimplemented from WsfTaskManager.

References WsfTaskManager::CancelTask(), WsfTask::GetAssigneePlatformIndex(), WsfTask::GetAssigneePlatformName(), WsfTask::GetAssignerPlatformIndex(), WsfTask::GetLocalTrackId(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfTask::GetResourceName(), WsfTask::GetTaskType(), WsfTask::GetTrackId(), WsfTaskManager::mPendingRcvdTasks, WsfTaskManager::mShowTaskMessages, WsfTaskManager::mXmtdTaskList, and ReleaseResource().

Referenced by operator=(), and RejectTask().

◆ PurgeTransmittedTask()

void WsfQuantumTaskerProcessor::PurgeTransmittedTask ( double aSimTime,
WsfTask & aTask )
overridevirtual

Perform the actions necessary to purge a transmitted task. This routine is invoked by the transmitter of a task after it has been notified that the receiver has completed the task (successfully, unsuccessfully or rejected) or if assignee did not accept the task in the required time interval.

Parameters
aSimTimeThe current simulation time.
aTaskThe task being purge.
Note
The caller is responsible for deleting the task from the transmitted task list.

Reimplemented from WsfTaskManager.

Referenced by operator=(), and ProcessTaskStatusMessage().

◆ ReceiveMessage()

bool WsfQuantumTaskerProcessor::ReceiveMessage ( double aSimTime,
const WsfMessage & aMessage )
overridevirtual

Receive a message from another platform part (system). The default implementation simply calls ProcessMessage to process the received message.

Parameters
aSimTimeThe current simulation time.
aMessageThe message that is being sent.
Returns
'true' if the message was received or 'false' if not.
Note
A message is first received by ReceiveMessage which then calls ProcessMessage to process the message. A derived class ReceiveMessage method may choose to delay the message before calling ProcessMessage or may choose to ignore the message altogether.

Reimplemented from WsfPlatformPart.

References WsfTaskManager::ReceiveMessage().

◆ Rejected()

bool WsfQuantumTaskerProcessor::Rejected ( WsfAssetPerception * aAssetPtr,
WsfQuantumTask * aTaskPtr )
protected

Returns whether or not this asset has ever rejected this task.

Returns
'true' if the aAsset has rejected the aTask

References WsfQuantumTask::GetUniqueId(), and WsfAssetPerception::mIndex.

Referenced by UpdateEvaluations().

◆ RejectedAnyTasks()

bool WsfQuantumTaskerProcessor::RejectedAnyTasks ( WsfAssetPerception * aAssetPtr)
protected

Returns whether or not this asset has ever rejected any tasks.

Returns
'true' if the aAsset has rejected any tasks

References WsfAssetPerception::mIndex.

Referenced by UpdateEvaluations().

◆ RejectedByAnyAsset()

bool WsfQuantumTaskerProcessor::RejectedByAnyAsset ( WsfQuantumTask * aTaskPtr)
protected

Returns whether or not this task has ever been rejected.

Returns
'true' if the aTask has been rejected by any assets

References WsfQuantumTask::GetUniqueId().

Referenced by SetMatrixTasks().

◆ RejectTask()

◆ ReleaseResource()

bool WsfQuantumTaskerProcessor::ReleaseResource ( double aSimTime,
WsfTask & aTask )
overrideprotectedvirtual

Reimplemented from WsfTaskManager.

Referenced by PurgeReceivedTask().

◆ ReportTaskComplete() [1/2]

◆ ReportTaskComplete() [2/2]

bool WsfQuantumTaskerProcessor::ReportTaskComplete ( double aSimTime,
WsfTask & aTask,
WsfStringId aSubStatus )

Sends a WsfTaskStatusMessage with status cCOMPLETED to the task assigner (The provided sub-status is typically cSUCCESSFUL or cUNSUCCESSFUL) This removes the task from the received task list All this triggers the TaskCompleted() callback later on

References WsfTask::GetResourceName(), WsfTask::GetTaskType(), WsfTask::GetTrackId(), and WsfTaskManager::ReportTaskComplete().

◆ ReportTaskProgress() [1/2]

bool WsfTaskManager::ReportTaskProgress ( double aSimTime,
const WsfTrackId & aTrackId,
WsfStringId aTaskType,
WsfStringId aResourceName,
WsfStringId aSubStatus )
protectedvirtual

Reimplemented from WsfTaskManager.

◆ ReportTaskProgress() [2/2]

bool WsfQuantumTaskerProcessor::ReportTaskProgress ( double aSimTime,
WsfTask & aTask,
WsfStringId aSubStatus )

Sends a WsfTaskStatusMessage with status cIN_PROGRESS to the task assigner.

will send a WsfTaskStatusMessage to task assigner with proper fields populated

Parameters
aSimTime:: simulation time
aTask:: task to report on, complete, or reject
aSubStatus:: extra data to be passed with report
Returns
'true' if task exists to report on & message sent

References WsfTask::GetResourceName(), WsfTask::GetTaskType(), WsfTask::GetTrackId(), and WsfTaskManager::ReportTaskProgress().

◆ SetAllocations()

void WsfQuantumTaskerProcessor::SetAllocations ( AllocationList & aList)
protected

◆ SetAssetRepresentation()

virtual void WsfQuantumTaskerProcessor::SetAssetRepresentation ( AssetRepresentationType aType)
inlinevirtual

WsfAssetPerception objects (that represent platforms) can be split into many smaller objects each representing their own platform subsystem

◆ SetIgnoreAllyTracks()

virtual void WsfQuantumTaskerProcessor::SetIgnoreAllyTracks ( bool aVal)
inlinevirtual

Sets whether or not ally tracks are passed to the generator (and subsequently tasks on those tracks will be used).

Referenced by ProcessInput().

◆ SetMatrixAssets()

void WsfQuantumTaskerProcessor::SetMatrixAssets ( double aSimTime)
protected

◆ SetMatrixTasks()

◆ SetReallocationStrategy()

virtual void WsfQuantumTaskerProcessor::SetReallocationStrategy ( ReallocationStrategyType aType)
inlinevirtual

See comments for ReallocationStrategyType enum.

Referenced by ProcessInput().

◆ TaskCompleted()

void WsfQuantumTaskerProcessor::TaskCompleted ( double aSimTime,
WsfTask & aTask )
overridevirtual

callback for extra processing when a task is marked complete

Callback used to record which tasks are rejected or completed.

Reimplemented from WsfTaskManager.

References WsfTask::GetAssigneePlatformIndex(), WsfPlatformPart::GetScenario(), WsfTask::GetStatus(), WsfTask::GetTaskId(), and WsfTaskManager::TaskCompleted().

Referenced by ProcessTaskStatusMessage().

◆ TaskListAssignedForResourceName()

std::list< WsfTask * > WsfQuantumTaskerProcessor::TaskListAssignedForResourceName ( WsfStringId aResourceName)

◆ TaskListAssignedForResourceType()

std::list< WsfTask * > WsfQuantumTaskerProcessor::TaskListAssignedForResourceType ( int aResourceType)

◆ TaskListAssignedForTrack()

std::list< WsfTask * > WsfQuantumTaskerProcessor::TaskListAssignedForTrack ( const WsfTrackId & aTrackId)

◆ TaskListAssignedOfType()

std::list< WsfTask * > WsfQuantumTaskerProcessor::TaskListAssignedOfType ( WsfStringId aTaskType)

◆ TaskListReceivedForResourceName()

std::list< WsfTask * > WsfQuantumTaskerProcessor::TaskListReceivedForResourceName ( WsfStringId aResourceName)

The list is not filtered by the resource name if it is zero.

References WsfTaskManager::mRcvdTaskList.

◆ TaskListReceivedForResourceType()

std::list< WsfTask * > WsfQuantumTaskerProcessor::TaskListReceivedForResourceType ( int aResourceType)

The list is not filtered by the ResourceType if it is cNONE.

References cTASK_RESOURCE_TYPE_NONE, and WsfTaskManager::mRcvdTaskList.

◆ TaskListReceivedForTrack()

std::list< WsfTask * > WsfQuantumTaskerProcessor::TaskListReceivedForTrack ( const WsfTrackId & aTrackId)

The list is not filtered by the WsfTrackId if it is null.

References WsfTrackId::IsNull(), and WsfTaskManager::mRcvdTaskList.

◆ TaskListReceivedOfType()

std::list< WsfTask * > WsfQuantumTaskerProcessor::TaskListReceivedOfType ( WsfStringId aTaskType)

The list is not filtered by the task type if it is zero.

Returns
list of tasks received or assigned that match specified parameters

References WsfTaskManager::mRcvdTaskList.

Referenced by WsfBrawlerProcessor::GetConsciousnessEventTime(), WsfBrawlerProcessor::GetTargetTrack(), and WsfBrawlerProcessor::UpdateMissileMode().

◆ TaskListReceivedOfTypeForTrack()

std::list< WsfTask * > WsfQuantumTaskerProcessor::TaskListReceivedOfTypeForTrack ( WsfStringId aTaskType,
const WsfTrackId & aTrackId )

The list is not filtered by the WsfTrackId if it is null.

References WsfTrackId::IsNull(), and WsfTaskManager::mRcvdTaskList.

◆ Update()

◆ UpdateEvaluations()

void WsfQuantumTaskerProcessor::UpdateEvaluations ( double aSimTime,
WsfQuantumEvaluator & aEvaluator,
std::vector< WsfLocalTrack * > & aPerception )
overridevirtual

This overwrites the WsfQuantumMatrix method so it can filter out any pairings between assets and tasks they have rejected.

uses the given evaluator to fill out the asset-task pairing values matrix

Parameters
aSimTime:: simulation time
aEvaluator:: evaluator to use for providing asset-task scoring
aPerception:: list of perception objects to use in evaluation

Reimplemented from WsfQuantumMatrix.

References WsfQuantumEvaluator::Evaluate(), WsfQuantumMatrix::mAssets, WsfQuantumMatrix::mProfits, WsfQuantumMatrix::mTasks, WsfQuantumMatrix::mValues, Rejected(), RejectedAnyTasks(), and WsfQuantumMatrix::UpdateEvaluations().

Referenced by Update().

◆ UpdateTaskCorrelation()

void WsfQuantumTaskerProcessor::UpdateTaskCorrelation ( double aSimTime,
WsfTask & aTask )
overridevirtual

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved