|
WSF
|
A class that defines a task to be performed. More...
#include <WsfTask.hpp>


Public Member Functions | |
| WsfTask () | |
| WsfTask (const WsfTask &aSrc) | |
| WsfTask (const WsfTaskResource &aTaskResource) | |
| WsfTask & | operator= (const WsfTask &aRhs) |
| ~WsfTask () override=default | |
| bool | operator== (const WsfTask &aRhs) const |
| bool | operator!= (const WsfTask &aRhs) const |
| const char * | GetScriptClassName () const override |
| void | Initialize (double aSimTime, unsigned long aTaskId, WsfProcessor *aAssignerPtr) |
| unsigned int | GetTaskId () const |
| Return the task ID assigned to the task. | |
| const WsfTrackId & | GetTrackId () const |
| void | SetTrackId (const WsfTrackId &aTrackId) |
| const WsfTrackId & | GetLocalTrackId () const |
| void | SetLocalTrackId (const WsfTrackId &aLocalTrackId) |
| WsfStringId | GetTaskType () const |
| void | SetTaskType (WsfStringId aTaskType) |
| WsfStringId | GetTargetName () const |
| void | SetTargetName (WsfStringId aTargetName) |
| Set the name of the target. | |
| Public Member Functions inherited from WsfTaskData | |
| WsfTaskData () | |
| WsfTaskData (const WsfTaskData &aSrc) | |
| WsfTaskData (const WsfTaskResource &aTaskResource) | |
| WsfTaskData & | operator= (const WsfTaskData &aRhs) |
| virtual | ~WsfTaskData () |
| template<typename T> | |
| void | SerializeP (T &aBuff) |
| For XIO (de)serialization. | |
| Public Member Functions inherited from WsfAuxDataEnabled | |
| WsfAuxDataEnabled ()=default | |
| WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default | |
| WsfAuxDataEnabled & | operator= (const WsfAuxDataEnabled &aRhs) |
| WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default | |
| WsfAuxDataEnabled & | operator= (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 | |
| WsfAttributeContainer & | GetAuxData () |
| const WsfAttributeContainer & | GetAuxData () const noexcept |
| const WsfAttributeContainer & | GetAuxDataConst () const noexcept |
Static Public Member Functions | |
| static void | RegisterScriptTypes (UtScriptTypes *aScriptTypesPtr) |
Assigner methods. | |
| void | SetAssigner (const WsfTask &aTask) |
| WsfStringId | GetAssignerPlatformName () const |
| size_t | GetAssignerPlatformIndex () const |
| WsfStringId | GetAssignerProcessorName () const |
Assignee methods. | |
| void | SetAssignee (WsfPlatform *aAssigneePtr) |
| WsfStringId | GetAssigneePlatformName () const |
| size_t | GetAssigneePlatformIndex () const |
| WsfStringId | GetAssigneeProcessorName () const |
| void | SetAssigneeProcessorName (WsfStringId aAssigneeProcessorName) |
Resource methods. | |
| WsfTaskResource & | GetResource () |
| const WsfTaskResource & | GetResource () const |
| void | SetResource (const WsfTaskResource &aResource) |
| WsfStringId | GetResourceName () const |
| void | SetResourceName (WsfStringId aResourceName) |
| int | GetResourceType () const |
| bool | IsResourceTypeOf (const int aResourceType) const |
| WsfStringId | GetResourceMode () const |
| void | SetResourceMode (WsfStringId aResourceMode) |
Communications methods. | |
For an inter-platform assignment, this is the local name over which task messages are sent. For an intra-platform assignment, this is the name of the assigning processor. | |
| WsfStringId | GetCommName () const |
| void | SetCommName (WsfStringId aCommName) |
Update time methods. | |
Set or get the time when a status report was last sent. | |
| void | SetUpdateTime (double aUpdateTime) |
| double | GetUpdateTime () const |
Assignment time methods | |
Set or get the time when the task was assigned. | |
| void | SetAssignTime (double aAssignTime) |
| double | GetAssignTime () const |
Status methods | |
Set or get the task status string id. | |
| void | SetStatus (WsfStringId aStatusId) |
| WsfStringId | GetStatus () const |
SubStatus methods | |
Set or get the task status string id. | |
| void | SetSubStatus (WsfStringId aSubStatusId) |
| WsfStringId | GetSubStatus () const |
Object methods. | |
These methods are used to keep track of objects associated with this track. | |
| int | GetObjectsPending () const |
| Return the number of objects that have been assigned but not yet in operation. | |
| void | SetObjectsPending (int aObjectsPending) |
| Set the number of objects that have been assigned but not yet in operation. | |
| void | SetAssignerPlatformIndex (size_t aIndex) |
| void | SetAssigneePlatformIndex (size_t aIndex) |
Additional Inherited Members | |
| Public Attributes inherited from WsfTaskData | |
| unsigned int | mTaskId |
| The serial number of the task. | |
| WsfTrackId | mTrackId |
| WsfTrackId | mLocalTrackId |
| WsfStringId | mTaskType |
| The task type (string ID). | |
| WsfStringId | mTargetName |
| The name of the target (string ID) IF it is known. | |
| WsfStringId | mAssignerPlatformName |
| The name of the assigning platform (string ID). | |
| size_t | mAssignerPlatformIndex |
| The platform index of the assigning platform. | |
| WsfStringId | mAssignerProcessorName |
| The name of the processor on the assigning platform (string ID). | |
| WsfStringId | mAssigneePlatformName |
| The name of the assigned platform (string ID). | |
| size_t | mAssigneePlatformIndex |
| The platform index of the assigned platform. | |
| WsfStringId | mAssigneeProcessorName |
| The name of the processor on the assigned platform (string ID). | |
| WsfTaskResource * | mResourcePtr |
| Attributes of the assigned resource. | |
| WsfStringId | mCommName |
| double | mAssignTime |
| The simulation time when the assignment was made. | |
| double | mUpdateTime |
| The simulation time when an update was last sent or received. | |
| int | mObjectsPending |
| The number of objects that are pending (requested but not yet in operation). | |
| WsfStringId | mTaskStatus |
| Task status. | |
| WsfStringId | mTaskSubStatus |
| Task sub status reported by assignee. (User Defined). | |
| Static Public Attributes inherited from WsfAuxDataEnabled | |
| static UtCallbackListN< void(const WsfAuxDataEnabled *)> | AuxDataAccessed |
| static UtCallbackListN< void(const WsfAuxDataEnabled *)> | AuxDataDestroyed |
A class that defines a task to be performed.
|
inline |
|
inline |
References WsfTask(), and WsfTaskData::WsfTaskData().
|
inline |
References WsfTaskData::WsfTaskData().
|
overridedefault |
|
inline |
References WsfTaskData::mAssigneePlatformIndex.
Referenced by WsfQuantumTaskerProcessor::AssignTask(), WsfTaskManager::AssignTask(), WsfWeaponTaskManager::AssignTask(), WsfTaskManager::CancelTask(), WsfTaskManager::CancelTask(), WsfTaskManager::CheckMessageAcknowledged(), WsfXIO_TaskService::GetProcessorIds(), WsfQuantumTaskerProcessor::ProcessTaskStatusMessage(), WsfTaskManager::ProcessTaskStatusMessage(), WsfQuantumTaskerProcessor::PurgeReceivedTask(), WsfTaskManager::ReceiveMessage(), WsfTaskManager::SendTrackUpdate(), WsfWeaponTaskManager::StartingWeaponTask(), WsfQuantumTaskerProcessor::TaskCompleted(), WsfXIO_AutoDisMapping::TranslateTaskAssignMessage(), WsfQuantumTaskerProcessor::Update(), and UT_DEFINE_SCRIPT_METHOD().
|
inline |
|
inline |
References WsfTaskData::mAssigneeProcessorName.
Referenced by WsfXIO_TaskService::GetProcessorIds(), and WsfTaskManager::ReceiveMessage().
|
inline |
References WsfTaskData::mAssignerPlatformIndex.
Referenced by WsfTaskManager::DropFromPurgedTaskList(), WsfXIO_TaskService::GetProcessorIds(), WsfQuantumTaskerProcessor::ProcessTaskAssignMessage(), WsfTaskManager::ProcessTaskAssignMessage(), WsfTaskManager::ProcessTaskCancelMessage(), WsfQuantumTaskerProcessor::PurgeReceivedTask(), WsfQuantumTaskerProcessor::RejectTask(), WsfTaskManager::ReportTaskComplete(), WsfTaskManager::ReportTaskProgress(), and WsfXIO_AutoDisMapping::TranslateTaskAssignMessage().
|
inline |
References WsfTaskData::mAssignerPlatformName.
Referenced by WsfScriptTaskClass::ToString().
|
inline |
|
inline |
References WsfTaskData::mAssignTime.
|
inline |
References WsfTaskData::mCommName.
Referenced by WsfQuantumTaskerProcessor::AssignTask(), WsfTaskManager::AssignTask(), WsfTaskManager::CancelTask(), WsfTaskManager::ProcessTaskCancelMessage(), WsfQuantumTaskerProcessor::ProcessTaskStatusMessage(), WsfTaskManager::ProcessTaskStatusMessage(), WsfTaskManager::ReportTaskComplete(), WsfTaskManager::ReportTaskProgress(), and WsfTaskManager::SendTrackUpdate().
|
inline |
References WsfTaskData::mLocalTrackId.
Referenced by WsfWeaponTaskManager::AbortFiring(), WsfTaskManager::CancelTask(), WsfBrawlerProcessor::GetConsciousnessEventTime(), WsfTaskManager::ProcessTaskAssignMessage(), WsfQuantumTaskerProcessor::PurgeReceivedTask(), WsfWeaponTaskManager::ReleaseResource(), WsfTaskManager::SendTrackUpdate(), WsfTaskAssignMessage::SetTask(), WsfTaskProcessor::TaskCompleted(), WsfBrawlerProcessor::UpdateMissileMode(), and WsfWeaponTaskManager::UplinkStart().
|
inline |
Return the number of objects that have been assigned but not yet in operation.
References WsfTaskData::mObjectsPending.
|
inline |
References WsfTaskData::mResourcePtr.
Referenced by WsfWeaponTaskManager::AcquireResource(), WsfTaskManager::AssignTask(), WsfTaskManager::CancelTask(), WsfTaskManager::CancelTask(), GetResourceMode(), GetResourceName(), GetResourceType(), WsfTaskManager::ProcessTaskAssignMessage(), WsfWeaponTaskManager::ProcessTaskStatusMessage(), WsfWeaponTaskManager::ReleaseResource(), WsfTaskManager::ReportTaskComplete(), WsfTaskManager::ReportTaskProgress(), SetResourceMode(), SetResourceName(), WsfWeaponTaskManager::StartingWeaponTask(), WsfWeaponTaskManager::TaskCorrelated(), and WsfWeaponTaskManager::UplinkStart().
|
inline |
References WsfTaskData::mResourcePtr.
|
inline |
References GetResource().
Referenced by WsfTaskManager::AcquireResource().
|
inline |
References GetResource().
Referenced by WsfTaskManager::AcquireResource(), WsfWeaponTaskManager::AcquireResource(), WsfQuantumTaskerProcessor::AssignTask(), WsfTaskManager::AssignTask(), WsfWeaponTaskManager::AssignTask(), WsfTaskManager::CancelTask(), WsfTaskManager::CheckMessageAcknowledged(), WsfTaskManager::ProcessTaskAssignMessage(), WsfQuantumTaskerProcessor::PurgeReceivedTask(), WsfMilEventPipe::QuantumTaskerUpdate(), WsfQuantumTaskerProcessor::RejectTask(), WsfTaskManager::ReleaseResource(), WsfWeaponTaskManager::ReleaseResource(), WsfQuantumTaskerProcessor::ReportTaskComplete(), WsfTaskManager::ReportTaskComplete(), WsfQuantumTaskerProcessor::ReportTaskProgress(), WsfTaskManager::ReportTaskProgress(), WsfWeaponTaskManager::StartingWeaponTask(), and WsfWeaponTaskManager::TaskCanceled().
|
inline |
|
inlineoverride |
|
inline |
References WsfTaskData::mTaskStatus.
Referenced by WsfQuantumTaskerProcessor::TaskCompleted().
|
inline |
References WsfTaskData::mTaskSubStatus.
|
inline |
Get the name of the target. The name is the 'truth name' from the track. This may be zero if not correlated with a real platform.
References WsfTaskData::mTargetName.
Referenced by WsfTaskManager::CancelTask(), WsfBrawlerProcessor::GetTargetTrack(), WsfQuantumTask::GetUniqueId(), WsfQuantumTask::operator==(), WsfTaskManager::ProcessTaskAssignMessage(), WsfMilEventPipe::QuantumTaskerUpdate(), WsfTaskManager::ReportTaskComplete(), WsfTaskManager::ReportTaskProgress(), WsfQuantumTaskerProcessor::SetMatrixTasks(), and WsfQuantumTaskerProcessor::Update().
|
inline |
Return the task ID assigned to the task.
References WsfTaskData::mTaskId.
Referenced by WsfQuantumTaskerProcessor::AssigneesForTask(), WsfQuantumTaskerProcessor::AssignTask(), WsfTaskManager::DropFromPurgedTaskList(), WsfScriptTaskClass::OnNewScriptRef(), WsfQuantumTaskerProcessor::ProcessTaskStatusMessage(), WsfTaskManager::ProcessTaskStatusMessage(), WsfWeaponTaskManager::PurgeReceivedTask(), WsfQuantumTaskerProcessor::RejectTask(), WsfTaskManager::ReleaseResource(), WsfTaskManager::SendTrackUpdate(), WsfQuantumTaskerProcessor::SetMatrixTasks(), WsfQuantumTaskerProcessor::TaskCompleted(), WsfWeaponTaskManager::TaskCorrelated(), WsfScriptTaskClass::ToString(), and WsfQuantumTaskerProcessor::Update().
|
inline |
References WsfTaskData::mTaskType.
Referenced by WsfQuantumTaskerProcessor::AssignTask(), WsfTaskManager::AssignTask(), WsfWeaponTaskManager::AssignTask(), WsfTaskManager::CancelTask(), WsfTaskManager::CancelTask(), WsfTaskManager::CheckMessageAcknowledged(), WsfQuantumTask::GetUniqueId(), WsfTaskManager::ProcessTaskAssignMessage(), WsfQuantumTaskerProcessor::PurgeReceivedTask(), WsfWeaponTaskManager::PurgeTransmittedTask(), WsfMilEventPipe::QuantumTaskerUpdate(), WsfQuantumTaskerProcessor::RejectTask(), WsfQuantumTaskerProcessor::ReportTaskComplete(), WsfTaskManager::ReportTaskComplete(), WsfQuantumTaskerProcessor::ReportTaskProgress(), WsfTaskManager::ReportTaskProgress(), WsfWeaponTaskManager::StartingWeaponTask(), WsfScriptTaskClass::ToString(), and WsfQuantumTaskerProcessor::UpdateTaskCorrelation().
|
inline |
References WsfTaskData::mTrackId.
Referenced by WsfTaskManager::CancelTask(), WsfTaskManager::CancelTask(), WsfTaskManager::CheckMessageAcknowledged(), WsfQuantumTaskerProcessor::ProcessTaskAssignMessage(), WsfTaskManager::ProcessTaskAssignMessage(), WsfQuantumTaskerProcessor::PurgeReceivedTask(), WsfWeaponTaskManager::PurgeTransmittedTask(), WsfQuantumTaskerProcessor::RejectTask(), WsfTaskManager::ReleaseResource(), WsfWeaponTaskManager::ReleaseResource(), WsfQuantumTaskerProcessor::ReportTaskComplete(), WsfTaskManager::ReportTaskComplete(), WsfQuantumTaskerProcessor::ReportTaskProgress(), WsfTaskManager::ReportTaskProgress(), WsfWeaponTaskManager::StartingWeaponTask(), WsfWeaponTaskManager::TaskCanceled(), WsfQuantumTaskerProcessor::UpdateTaskCorrelation(), and WsfWeaponTaskManager::UplinkStart().
|
inline |
References WsfTaskData::mUpdateTime.
Referenced by WsfWeaponTaskManager::AssignTask().
| void WsfTask::Initialize | ( | double | aSimTime, |
| unsigned long | aTaskId, | ||
| WsfProcessor * | aAssignerPtr ) |
References WsfPlatform::GetIndex(), WsfObject::GetNameId(), WsfPlatformPart::GetPlatform(), WsfTaskData::mAssignerPlatformIndex, WsfTaskData::mAssignerPlatformName, WsfTaskData::mAssignerProcessorName, WsfTaskData::mAssignTime, WsfTaskData::mTaskId, and WsfTaskData::mUpdateTime.
Referenced by WsfQuantumTaskerProcessor::AssignTask(), and WsfTaskManager::AssignTask().
|
inline |
|
inline |
References operator==(), and WsfTask().
References WsfTaskData::operator=(), and WsfTask().
|
inline |
References WsfTaskData::mAssignerProcessorName, WsfTaskData::mTaskId, and WsfTask().
|
static |
Register the types ('class' objects) for the scripting systems.
This is invoked once by WsfScriptManager to create the 'class' objects that are implemented by this file.
Referenced by WsfScriptManager::RegisterTypes().
| void WsfTask::SetAssignee | ( | WsfPlatform * | aAssigneePtr | ) |
References WsfPlatform::GetIndex(), WsfObject::GetNameId(), WsfTaskData::mAssigneePlatformIndex, WsfTaskData::mAssigneePlatformName, and WsfTaskData::mAssigneeProcessorName.
Referenced by WsfTaskManager::AssignTask(), WsfQuantumTaskerProcessor::Update(), UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().
|
inline |
|
inline |
References WsfTaskData::mAssigneeProcessorName.
Referenced by WsfTaskManager::AssignTask(), and WsfQuantumTaskerProcessor::SetMatrixTasks().
| void WsfTask::SetAssigner | ( | const WsfTask & | aTask | ) |
Copy the assigner from another task. This is used to transfer an assignment.
References WsfTaskData::mAssignerPlatformIndex, WsfTaskData::mAssignerPlatformName, WsfTaskData::mAssignerProcessorName, and WsfTask().
|
inline |
|
inline |
References WsfTaskData::mAssignTime.
|
inline |
|
inline |
|
inline |
Set the number of objects that have been assigned but not yet in operation.
References WsfTaskData::mObjectsPending.
Referenced by WsfWeaponTaskManager::AcquireResource().
| void WsfTask::SetResource | ( | const WsfTaskResource & | aResource | ) |
References WsfTaskResource::Clone(), and WsfTaskData::mResourcePtr.
|
inline |
References GetResource().
|
inline |
References GetResource().
Referenced by WsfQuantumTaskerProcessor::SetMatrixTasks(), and WsfQuantumTaskerProcessor::Update().
|
inline |
References WsfTaskData::mTaskStatus.
Referenced by WsfQuantumTaskerProcessor::ProcessTaskStatusMessage(), and WsfTaskManager::ProcessTaskStatusMessage().
|
inline |
References WsfTaskData::mTaskSubStatus.
Referenced by WsfQuantumTaskerProcessor::ProcessTaskStatusMessage(), and WsfTaskManager::ProcessTaskStatusMessage().
|
inline |
Set the name of the target.
References WsfTaskData::mTargetName.
Referenced by WsfTaskManager::AssignTask(), and WsfQuantumTask::WsfQuantumTask().
|
inline |
References WsfTaskData::mTaskType.
Referenced by WsfTaskManager::AssignTask(), WsfQuantumGeneratorSimpleJammer::GenerateTasks(), WsfQuantumGeneratorSimpleSensor::GenerateTasks(), WsfQuantumGeneratorSimpleWeapon::GenerateTasks(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().
|
inline |
References WsfTaskData::mTrackId.
Referenced by WsfTaskManager::AssignTask(), and WsfQuantumTask::WsfQuantumTask().
|
inline |
References WsfTaskData::mUpdateTime.
Referenced by WsfQuantumTaskerProcessor::ProcessTaskStatusMessage(), and WsfTaskManager::ProcessTaskStatusMessage().