WsfXIO_TaskService Class Reference

#include <WsfXIO_TaskService.hpp>

Inheritance diagram for WsfXIO_TaskService:

Collaboration diagram for WsfXIO_TaskService:

Classes
struct	SubscriptionData

Public Member Functions
	WsfXIO_TaskService (WsfXIO_Simulation &aXIO_Simulation)
	~WsfXIO_TaskService () override
Public Member Functions inherited from WsfXIO_Service
	WsfXIO_Service (WsfXIO_Interface *aInterfacePtr)
virtual	~WsfXIO_Service ()
WsfXIO_Subscription *	FindSubscription (WsfXIO_Connection *aConnectionPtr, int aSubscriptionId)
WsfXIO_Interface *	GetInterface () const

Static Public Member Functions
static WsfTaskProcessor *	FindTaskProcessor (WsfSimulation &aSimulation, size_t aPlatformIndex, WsfStringId &aProcessorNameId)

Protected Types
typedef std::vector< SubscriptionData * >	SubscriptionList
typedef std::pair< size_t, WsfStringId >	ProcessorId
typedef std::map< ProcessorId, SubscriptionData >	SubscriptionDataMap
Protected Types inherited from WsfXIO_Service
using	SubscriptionMap = std::map<WsfXIO_SubscriptionId, WsfXIO_Subscription*>

Protected Member Functions
void	HandleRequest (WsfXIO_TaskRequestPkt &aPkt)
void	HandleCommand (WsfXIO_TaskCommandPkt &aPkt)
void	UpdateCallbacks ()
void	SendInitial (SubscriptionData &aData)
void	TaskAccepted (double aSimTime, const WsfTask *aTaskPtr, const WsfTrack *aTrackPtr)
	Simulation observer for TaskAccepted.
void	TaskAssigned (double aSimTime, const WsfTask *aTaskPtr, const WsfTrack *aTrackPtr)
	Simulation observer for TaskAssigned.
void	TaskCanceled (double aSimTime, const WsfTask *aTaskPtr)
	Simulation observer for TaskCanceled.
void	TaskCompleted (double aSimTime, const WsfTask *aTaskPtr, WsfStringId aStatus)
	Simulation observer for TaskCompleted.
void	GetProcessorIds (const WsfTask &aTask, ProcessorId &aAssigner, ProcessorId &aAssignee)
void	GetSubscriptions (const WsfTask &aTask, SubscriptionList &aAssignerSubscriptions, SubscriptionList &aAssigneeSubscriptions)
void	SubscriptionCancelled (WsfXIO_Subscription *aSubscriptionPtr) override
Protected Member Functions inherited from WsfXIO_Service
void	DenyRequest (WsfXIO_RequestDataPkt &aRequest)
void	HandleDisconnect (WsfXIO_Connection *aConnection)
void	AddSubscription (WsfXIO_Subscription *aSubscriptionPtr)
bool	RemoveSubscription (WsfXIO_Subscription *aSubscriptionPtr)
WsfXIO_Subscription *	CreateSubscription (WsfXIO_RequestDataPkt &aRequest)
void	HandleCancellation (WsfXIO_SubscriptionCancelPkt &aPkt)
const SubscriptionMap	GetSubscriptions () const
WsfXIO_Subscription *	FindSubscription (const WsfXIO_SubscriptionId &aSubscriptionId)
virtual void	RemovingSubscription (WsfXIO_Subscription *aSubscriptionPtr)

Protected Attributes
WsfXIO_Simulation &	mXIO_Simulation
WsfSimulation &	mSimulation
SubscriptionDataMap	mSubscriptionsInfo
UtCallbackHolder	mTaskCallbacks
Protected Attributes inherited from WsfXIO_Service
UtCallbackHolder	mCallbacks
WsfXIO_Interface *	mInterfacePtr

Member Typedef Documentation

ProcessorId

typedef std::pair<size_t, WsfStringId> WsfXIO_TaskService::ProcessorId

protected

SubscriptionDataMap

typedef std::map<ProcessorId, SubscriptionData> WsfXIO_TaskService::SubscriptionDataMap

protected

SubscriptionList

typedef std::vector<SubscriptionData*> WsfXIO_TaskService::SubscriptionList

protected

Constructor & Destructor Documentation

WsfXIO_TaskService()

WsfXIO_TaskService::WsfXIO_TaskService

(

WsfXIO_Simulation &

aXIO_Simulation

)

References WsfXIO_Service::GetInterface(), HandleCommand(), HandleRequest(), WsfXIO_Service::mCallbacks, mSimulation, mXIO_Simulation, and WsfXIO_Service::WsfXIO_Service().

~WsfXIO_TaskService()

WsfXIO_TaskService::~WsfXIO_TaskService ( )

override

Member Function Documentation

FindTaskProcessor()

WsfTaskProcessor * WsfXIO_TaskService::FindTaskProcessor ( WsfSimulation & aSimulation, size_t aPlatformIndex, WsfStringId & aProcessorNameId )

static

Find a task processor on a platform.

Parameters

aSimulation	The simulation containing the platform.
aPlatformIndex	The index of the platform to be searched.
aProcessorNameId	The name of the task processor on the platform.

Returns

Pointer to the task processor, or nullptr if it could not be found.

References WsfComponentList::RoleIterator< T >::AtEnd(), WsfSimulation::GetPlatformByIndex(), and platformPtr.

Referenced by HandleCommand(), and HandleRequest().

GetProcessorIds()

void WsfXIO_TaskService::GetProcessorIds ( const WsfTask & aTask, ProcessorId & aAssigner, ProcessorId & aAssignee )

protected

References WsfTask::GetAssigneePlatformIndex(), WsfTask::GetAssigneeProcessorName(), WsfTask::GetAssignerPlatformIndex(), and WsfTask::GetAssignerProcessorName().

Referenced by GetSubscriptions().

GetSubscriptions()

void WsfXIO_TaskService::GetSubscriptions ( const WsfTask & aTask, SubscriptionList & aAssignerSubscriptions, SubscriptionList & aAssigneeSubscriptions )

protected

References GetProcessorIds(), and mSubscriptionsInfo.

HandleCommand()

void WsfXIO_TaskService::HandleCommand ( WsfXIO_TaskCommandPkt & aPkt )

protected

References WsfTaskManager::AssignTask(), WsfComponentListT< COMPONENT_TYPE >::Begin(), WsfTaskManager::CancelTask(), WsfXIO_TaskCommandPkt::cCHANGE_OPERATING_LEVEL, WsfTaskManager::ChangeOperatingLevel(), WsfXIO_TaskCommandPkt::cTASK_ASSIGN, WsfXIO_TaskCommandPkt::cTASK_CANCEL, WsfXIO_TaskCommandPkt::cTASK_COMPLETE, WsfXIO_TaskCommandPkt::cTASK_PROGRESS, WsfComponentListT< COMPONENT_TYPE >::End(), FindTaskProcessor(), WsfTrackManager::FindTrack(), WsfPlatformPart::GetPlatform(), WsfTrack::GetTargetName(), WsfTrackListT< T >::GetTrackCount(), WsfTrackListT< T >::GetTrackEntry(), WsfTrackManager::GetTrackList(), WsfPlatform::GetTrackManager(), WsfXIO_TaskCommandPkt::mAssigneePlatformIndex, WsfXIO_TaskCommandPkt::mAssigneeProcessorName, WsfXIO_TaskCommandPkt::mAssignerPlatformIndex, WsfXIO_TaskCommandPkt::mAssignerProcessorName, WsfXIO_TaskCommandPkt::mCommandType, WsfXIO_TaskCommandPkt::mCommName, WsfXIO_TaskCommandPkt::mOperatingLevel, WsfXIO_TaskCommandPkt::mResourcePtr, mSimulation, WsfXIO_TaskCommandPkt::mStatus, WsfXIO_TaskCommandPkt::mTargetNameId, WsfXIO_TaskCommandPkt::mTaskType, WsfXIO_TaskCommandPkt::mTrackId, mXIO_Simulation, WsfTaskManager::ReportTaskComplete(), WsfTaskManager::ReportTaskProgress(), simTime, and trackPtr.

Referenced by WsfXIO_TaskService().

HandleRequest()

void WsfXIO_TaskService::HandleRequest ( WsfXIO_TaskRequestPkt & aPkt )

protected

References WsfXIO_Service::CreateSubscription(), WsfXIO_Service::DenyRequest(), FindTaskProcessor(), WsfObject::GetNameId(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::IsExternallyControlled(), WsfXIO_TaskService::SubscriptionData::mHasControl, WsfXIO_TaskRequestPkt::mPlatformIndex, WsfXIO_TaskService::SubscriptionData::mPlatformIndex, mSimulation, WsfXIO_TaskService::SubscriptionData::mSubscriptionPtr, mSubscriptionsInfo, WsfXIO_TaskRequestPkt::mTakeControl, WsfXIO_TaskRequestPkt::mTaskProcessorName, WsfXIO_TaskService::SubscriptionData::mTaskProcessorPtr, platformPtr, processorId(), SendInitial(), WsfTaskProcessor::SetExternallyControlled(), and UpdateCallbacks().

Referenced by WsfXIO_TaskService().

SendInitial()

void WsfXIO_TaskService::SendInitial ( SubscriptionData & aData )

protected

References WsfTaskManager::AssignedTaskList(), WsfXIO_Subscription::GetConnection(), WsfXIO_Subscription::GetRequestId(), WsfXIO_TaskInitPkt::mAssignedTasks, WsfXIO_TaskInitPkt::mReceivedTasks, WsfXIO_ResponsePkt::mRequestId, WsfXIO_TaskService::SubscriptionData::mSubscriptionPtr, WsfXIO_TaskService::SubscriptionData::mTaskProcessorPtr, WsfTaskManager::ReceivedTaskList(), and WsfXIO_Connection::Send().

Referenced by HandleRequest().

SubscriptionCancelled()

void WsfXIO_TaskService::SubscriptionCancelled ( WsfXIO_Subscription * aSubscriptionPtr )

overrideprotectedvirtual

Reimplemented from WsfXIO_Service.

References mSimulation, mSubscriptionsInfo, and UpdateCallbacks().

TaskAccepted()

void WsfXIO_TaskService::TaskAccepted ( double aSimTime, const WsfTask * aTaskPtr, const WsfTrack * aTrackPtr )

protected

Simulation observer for TaskAccepted.

References WsfXIO_TaskUpdatePkt::cTASK_ACCEPTED, WsfXIO_Service::GetSubscriptions(), WsfXIO_TaskUpdatePkt::mTaskPtr, WsfXIO_TaskUpdatePkt::mTrackPtr, and WsfXIO_TaskUpdatePkt::mUpdateType.

Referenced by UpdateCallbacks().

TaskAssigned()

void WsfXIO_TaskService::TaskAssigned ( double aSimTime, const WsfTask * aTaskPtr, const WsfTrack * aTrackPtr )

protected

Simulation observer for TaskAssigned.

References WsfXIO_TaskUpdatePkt::cTASK_ASSIGNED, WsfXIO_Service::GetSubscriptions(), WsfXIO_TaskUpdatePkt::mTaskPtr, WsfXIO_TaskUpdatePkt::mTrackPtr, and WsfXIO_TaskUpdatePkt::mUpdateType.

Referenced by UpdateCallbacks().

TaskCanceled()

void WsfXIO_TaskService::TaskCanceled ( double aSimTime, const WsfTask * aTaskPtr )

protected

Simulation observer for TaskCanceled.

References WsfXIO_TaskUpdatePkt::cTASK_CANCELED, WsfXIO_Service::GetSubscriptions(), WsfXIO_TaskUpdatePkt::mTaskPtr, WsfXIO_TaskUpdatePkt::mTrackPtr, and WsfXIO_TaskUpdatePkt::mUpdateType.

Referenced by UpdateCallbacks().

TaskCompleted()

void WsfXIO_TaskService::TaskCompleted ( double aSimTime, const WsfTask * aTaskPtr, WsfStringId aStatus )

protected

Simulation observer for TaskCompleted.

References WsfXIO_TaskUpdatePkt::cTASK_COMPLETED, WsfXIO_Service::GetSubscriptions(), WsfXIO_TaskUpdatePkt::mTaskPtr, WsfXIO_TaskUpdatePkt::mTaskStatus, WsfXIO_TaskUpdatePkt::mTrackPtr, and WsfXIO_TaskUpdatePkt::mUpdateType.

Referenced by UpdateCallbacks().

UpdateCallbacks()

void WsfXIO_TaskService::UpdateCallbacks ( )

protected

References mSimulation, mSubscriptionsInfo, mTaskCallbacks, WsfObserver::TaskAccepted(), TaskAccepted(), WsfObserver::TaskAssigned(), TaskAssigned(), WsfObserver::TaskCanceled(), TaskCanceled(), WsfObserver::TaskCompleted(), and TaskCompleted().

Referenced by HandleRequest(), and SubscriptionCancelled().

Member Data Documentation

mSimulation

WsfSimulation& WsfXIO_TaskService::mSimulation

protected

Referenced by HandleCommand(), HandleRequest(), SubscriptionCancelled(), UpdateCallbacks(), and WsfXIO_TaskService().

mSubscriptionsInfo

SubscriptionDataMap WsfXIO_TaskService::mSubscriptionsInfo

protected

Referenced by GetSubscriptions(), HandleRequest(), SubscriptionCancelled(), and UpdateCallbacks().

mTaskCallbacks

UtCallbackHolder WsfXIO_TaskService::mTaskCallbacks

protected

Referenced by UpdateCallbacks().

mXIO_Simulation

WsfXIO_Simulation& WsfXIO_TaskService::mXIO_Simulation

protected

Referenced by HandleCommand(), and WsfXIO_TaskService().

---

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

• WsfXIO_TaskService.hpp
• WsfXIO_TaskService.cpp