WSF
WsfTaskData Class Reference

#include <WsfTaskData.hpp>

Inheritance diagram for WsfTaskData:
Collaboration diagram for WsfTaskData:

Public Member Functions

 WsfTaskData ()
 WsfTaskData (const WsfTaskData &aSrc)
 WsfTaskData (const WsfTaskResource &aTaskResource)
WsfTaskDataoperator= (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
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 Attributes

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

Additional Inherited Members

Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)> AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)> AuxDataDestroyed

Constructor & Destructor Documentation

◆ WsfTaskData() [1/3]

◆ WsfTaskData() [2/3]

◆ WsfTaskData() [3/3]

◆ ~WsfTaskData()

WsfTaskData::~WsfTaskData ( )
virtual

References mResourcePtr.

Member Function Documentation

◆ operator=()

◆ SerializeP()

Member Data Documentation

◆ mAssigneePlatformIndex

size_t WsfTaskData::mAssigneePlatformIndex

◆ mAssigneePlatformName

WsfStringId WsfTaskData::mAssigneePlatformName

◆ mAssigneeProcessorName

WsfStringId WsfTaskData::mAssigneeProcessorName

The name of the processor on the assigned platform (string ID).

Referenced by WsfTask::GetAssigneeProcessorName(), operator=(), SerializeP(), WsfTask::SetAssignee(), WsfTask::SetAssigneeProcessorName(), WsfTaskData(), and WsfTaskData().

◆ mAssignerPlatformIndex

size_t WsfTaskData::mAssignerPlatformIndex

◆ mAssignerPlatformName

WsfStringId WsfTaskData::mAssignerPlatformName

◆ mAssignerProcessorName

WsfStringId WsfTaskData::mAssignerProcessorName

The name of the processor on the assigning platform (string ID).

Referenced by WsfTask::GetAssignerProcessorName(), WsfTask::Initialize(), operator=(), WsfTask::operator==(), SerializeP(), WsfTask::SetAssigner(), WsfTaskData(), and WsfTaskData().

◆ mAssignTime

double WsfTaskData::mAssignTime

◆ mCommName

WsfStringId WsfTaskData::mCommName

The name of the comm device on which the task assignment was received (string ID). This is used by the assignee for sending status messages.

Referenced by WsfTask::GetCommName(), operator=(), SerializeP(), WsfTask::SetCommName(), WsfTaskData(), and WsfTaskData().

◆ mLocalTrackId

WsfTrackId WsfTaskData::mLocalTrackId

The local track ID that is associated with the track ID in the assignment. For instance, when command CMDR assigns local track CMDR.x to subordinate SUB, this field will be the local track ID of the local track that was created which contains CMDR.x as a constituent track.

Referenced by WsfTask::GetLocalTrackId(), operator=(), SerializeP(), WsfTask::SetLocalTrackId(), WsfTaskData(), and WsfTaskData().

◆ mObjectsPending

int WsfTaskData::mObjectsPending

The number of objects that are pending (requested but not yet in operation).

Referenced by WsfTask::GetObjectsPending(), operator=(), SerializeP(), WsfTask::SetObjectsPending(), WsfTaskData(), WsfTaskData(), and WsfTaskData().

◆ mResourcePtr

◆ mTargetName

WsfStringId WsfTaskData::mTargetName

The name of the target (string ID) IF it is known.

Referenced by WsfTask::GetTargetName(), operator=(), SerializeP(), WsfTask::SetTargetName(), WsfTaskData(), and WsfTaskData().

◆ mTaskId

◆ mTaskStatus

◆ mTaskSubStatus

WsfStringId WsfTaskData::mTaskSubStatus

Task sub status reported by assignee. (User Defined).

Referenced by WsfTask::GetSubStatus(), operator=(), SerializeP(), WsfTask::SetSubStatus(), WsfTaskData(), WsfTaskData(), and WsfTaskData().

◆ mTaskType

WsfStringId WsfTaskData::mTaskType

◆ mTrackId

WsfTrackId WsfTaskData::mTrackId

The track ID of the track that is associated with the task. This is the ID of the track as submitted in the task assignment request.

Referenced by WsfTask::GetTrackId(), operator=(), SerializeP(), WsfTask::SetTrackId(), WsfTaskData(), and WsfTaskData().

◆ mUpdateTime

double WsfTaskData::mUpdateTime

The simulation time when an update was last sent or received.

Referenced by WsfTask::GetUpdateTime(), WsfTask::Initialize(), operator=(), SerializeP(), WsfTask::SetUpdateTime(), WsfTaskData(), WsfTaskData(), and WsfTaskData().


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