#include <WsfTaskCancelMessage.hpp>

Inheritance diagram for WsfTaskCancelMessage:

[legend]

Collaboration diagram for WsfTaskCancelMessage:

[legend]

Public Member Functions
	WsfTaskCancelMessage ()
	Constructor, for XIO (de)serialization.
	WsfTaskCancelMessage (WsfPlatform *aPlatformPtr)
	WsfTaskCancelMessage (WsfPlatform *aPlatformPtr, const WsfTask &aTask)
WsfMessage *	Clone () const override
const char *	GetScriptClassName () const override
unsigned int	GetTaskId () const
	Return the assigners task ID.
Public Member Functions inherited from WsfMessage
	WsfMessage (WsfStringId aType)
	Constructor for XIO (de)serialization.
	WsfMessage (WsfStringId aType, const wsf::comm::Address &aSrcAddr, WsfSimulation &aSimulation)
	WsfMessage (WsfPlatform *aPlatformPtr)
	WsfMessage (WsfStringId aType, WsfPlatform *aPlatformPtr)
	WsfMessage (WsfStringId aType, WsfStringId aSubType, WsfPlatform *aPlatformPtr)
	WsfMessage (WsfSimulation &aSimulation)
WsfMessage &	operator= (const WsfMessage &aRhs)=default
	~WsfMessage () override
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
	Get the simulation that owns the message.
void	SetSimulation (WsfSimulation *aSimulationPtr)
WsfStringId	GetOriginator () const
void	SetOriginator (WsfPlatform *aPlatformPtr)
	Set the originator of this message.
size_t	GetOriginatorIndex () const
int	GetSizeBits () const
void	SetSizeBits (int aSizeBits)
int	GetSizeBytes () const
void	SetSizeBytes (int aSizeBytes)
unsigned int	GetSerialNumber () const
void	SetSerialNumber (unsigned int aSerialNumber)
double	GetDataTag () const
void	SetDataTag (double aDataTag)
WsfStringId	GetStaticType () const
WsfStringId	GetType () const
void	SetType (WsfStringId aType)
WsfStringId	GetSubType () const
void	SetSubType (WsfStringId aSubType)
int	GetPriority () const
void	SetPriority (int aPriority)
const wsf::comm::Address &	GetSrcAddr () const
void	SetSrcAddr (const wsf::comm::Address &aSrcAddr)
const wsf::comm::Address &	GetDstAddr () const
void	SetDstAddr (const wsf::comm::Address &aDstAddr)
const wsf::comm::Address &	GetNextHopAddr () const
void	SetNextHopAddr (const wsf::comm::Address &aNextHopAddr)
virtual bool	CanBeReplacedBy (const WsfMessage &aMessage) const
WsfStringId	GetGroup () const
void	SetGroup (WsfStringId aGroup) const
void	PrintDataTagPrecise (std::ostream &aStream, std::streamsize aPrecision) const
template<typename T>
void	Serialize (T &aBuff)
	(De)serializer for XIO
virtual WsfStringId	GetComponentNameId () const
virtual WsfStringId	GetComponentTypeId () const
virtual WsfStringId	GetComponentModeId () const
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 std::unique_ptr< UtScriptClass >	CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
static WsfStringId	GetTypeId ()
Static Public Member Functions inherited from WsfMessage
static WsfStringId	GetTypeId ()

Resource methods.
A task may have an associated resource (sensor, processor, etc.)
unsigned int	mTaskId
	The assigners task ID.
size_t	mAssignerPlatformIndex
	The platform index of the assigner.
WsfStringId	mAssignerPlatformName
	The name of the assigner.
WsfStringId	mAssignerProcessorName
	The name of the processor on the assigner.
size_t	mAssigneePlatformIndex
	The platform index of the assignee.
WsfStringId	mAssigneePlatformName
	The name of the assignee.
WsfStringId	mAssigneeProcessorName
	The name of the processor on the assignee.
WsfTrackId	mTrackId
	The track ID of the track associated with the task.
WsfStringId	mTaskType
	The type of the task.
WsfStringId	mResourceName
	The resource assigned for the task.
WsfStringId	GetResourceName () const
	Get the resource name.
void	SetResourceName (WsfStringId aResourceName)
	Set the resource (ID form).
void	SetResourceName (const std::string &aResourceName)
	Set the resource (string form).
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.

Assigner methods.
WsfPlatform *	GetAssigner () const
size_t	GetAssignerPlatformIndex () const
	Get the platform index of the assigner.
void	SetAssignerPlatformIndex (size_t aIndex)
	Set the platform index of the assigner.
WsfStringId	GetAssignerPlatformName () const
	Get the name of the assigner.
WsfStringId	GetAssignerProcessorName () const
	Get the name of the processor on the assigner.

Assignee methods.
WsfPlatform *	GetAssignee () const
size_t	GetAssigneePlatformIndex () const
	Get the platform index of the assignee.
void	SetAssigneePlatformIndex (size_t aIndex)
	Set the platform index of the assignee.
WsfStringId	GetAssigneePlatformName () const
	Get the name of the assignee.
WsfStringId	GetAssigneeProcessorName () const
	Get the name of the processor on the assignee.

Track ID methods.
const WsfTrackId &	GetTrackId () const
	Get the track ID to which the message applies.
void	SetTrackId (const WsfTrackId &aTrackId)
	Set the track ID to which the message applies.

Task type methods.
WsfStringId	GetTaskType () const
	Get the task type.
void	SetTaskType (WsfStringId aTaskType)
	Set the task type (ID form).
void	SetTaskType (const std::string &aTaskType)
	Set the task type (string form).

Additional Inherited Members
Static Public Attributes inherited from WsfMessage
static constexpr size_t	cBITS_IN_BYTE = 8U
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
	WsfMessage (const WsfMessage &aSrc)=default

Detailed Description

A message that is sent to cancel a task assignment.

See also: WsfTaskManager; WsfTaskAssignMessage

Constructor & Destructor Documentation

◆ WsfTaskCancelMessage() [1/3]

WsfTaskCancelMessage::WsfTaskCancelMessage ( )

Constructor, for XIO (de)serialization.

References GetTypeId(), mAssigneePlatformIndex, mAssigneePlatformName, mAssigneeProcessorName, mAssignerPlatformIndex, mAssignerPlatformName, mAssignerProcessorName, mResourceName, mTaskId, mTaskType, mTrackId, and WsfMessage::WsfMessage().

Referenced by Clone().

◆ WsfTaskCancelMessage() [2/3]

WsfTaskCancelMessage::WsfTaskCancelMessage ( WsfPlatform * aPlatformPtr )

Constructor

Parameters

aPlatformPtr The originator of the message.

References GetTypeId(), mAssigneePlatformIndex, mAssigneePlatformName, mAssigneeProcessorName, mAssignerPlatformIndex, mAssignerPlatformName, mAssignerProcessorName, mResourceName, mTaskId, mTaskType, mTrackId, and WsfMessage::WsfMessage().

◆ WsfTaskCancelMessage() [3/3]

WsfTaskCancelMessage::WsfTaskCancelMessage	(	WsfPlatform *	aPlatformPtr,
		const WsfTask &	aTask )

Constructor

Parameters

aPlatformPtr	The originator of the message.
aTask	The task to be canceled.

References GetAssigneePlatformIndex(), GetAssigneePlatformName(), GetAssigneeProcessorName(), GetAssignerProcessorName(), GetResourceName(), GetTaskId(), GetTaskType(), GetTrackId(), GetTypeId(), mAssigneePlatformIndex, mAssigneePlatformName, mAssigneeProcessorName, mAssignerPlatformIndex, mAssignerPlatformName, mAssignerProcessorName, mResourceName, mTaskId, mTaskType, mTrackId, and WsfMessage::WsfMessage().

Member Function Documentation

◆ Clone()

WsfMessage * WsfTaskCancelMessage::Clone ( ) const

overridevirtual

Create a clone of this message (the 'virtual copy constructor').

Returns: The pointer to the copy of this message.

Reimplemented from WsfMessage.

References WsfMessage::WsfMessage(), and WsfTaskCancelMessage().

◆ CreateScriptClass()

std::unique_ptr< UtScriptClass > WsfTaskCancelMessage::CreateScriptClass	(	const std::string &	aClassName,
		UtScriptTypes *	aScriptTypesPtr )

static

Create the 'class' object for the script system. This is invoked once by WsfScriptManager to create the 'class' object that defines the interface to instances of this class from the script system.

Referenced by WsfScriptManager::RegisterTypes().

◆ GetAssignee()

WsfPlatform * WsfTaskCancelMessage::GetAssignee ( ) const

Return the pointer to the assigned platform.

Returns: The pointer to the assigned platform, or zero if the platform has been deleted.

References WsfSimulation::GetPlatformByIndex(), WsfMessage::GetSimulation(), and mAssigneePlatformIndex.

◆ GetAssigneePlatformIndex()

size_t WsfTaskCancelMessage::GetAssigneePlatformIndex ( ) const

inline

Get the platform index of the assignee.

References mAssigneePlatformIndex.

Referenced by WsfTaskManager::ReceiveMessage(), WsfXIO_AutoDisMapping::TranslateTaskCancelMessage(), and WsfTaskCancelMessage().

◆ GetAssigneePlatformName()

WsfStringId WsfTaskCancelMessage::GetAssigneePlatformName ( ) const

inline

Get the name of the assignee.

References mAssigneePlatformName.

Referenced by WsfTaskCancelMessage().

◆ GetAssigneeProcessorName()

WsfStringId WsfTaskCancelMessage::GetAssigneeProcessorName ( ) const

inline

Get the name of the processor on the assignee.

References mAssigneeProcessorName.

Referenced by WsfTaskManager::ReceiveMessage(), and WsfTaskCancelMessage().

◆ GetAssigner()

WsfPlatform * WsfTaskCancelMessage::GetAssigner ( ) const

Return the pointer to the assigning platform.

Returns: The pointer to the assigning platform, or zero if the platform has been deleted.

References WsfSimulation::GetPlatformByIndex(), WsfMessage::GetSimulation(), and mAssignerPlatformIndex.

◆ GetAssignerPlatformIndex()

size_t WsfTaskCancelMessage::GetAssignerPlatformIndex ( ) const

inline

Get the platform index of the assigner.

References mAssignerPlatformIndex.

Referenced by WsfTaskManager::DropFromPurgedTaskList(), WsfTaskManager::ProcessTaskCancelMessage(), and WsfXIO_AutoDisMapping::TranslateTaskCancelMessage().

◆ GetAssignerPlatformName()

WsfStringId WsfTaskCancelMessage::GetAssignerPlatformName ( ) const

inline

Get the name of the assigner.

References mAssignerPlatformName.

◆ GetAssignerProcessorName()

WsfStringId WsfTaskCancelMessage::GetAssignerProcessorName ( ) const

inline

Get the name of the processor on the assigner.

References mAssignerProcessorName.

Referenced by WsfTaskCancelMessage().

◆ GetResourceName()

WsfStringId WsfTaskCancelMessage::GetResourceName ( ) const

inline

Get the resource name.

References mResourceName.

Referenced by WsfTaskManager::ProcessTaskCancelMessage(), and WsfTaskCancelMessage().

◆ GetScriptClassName()

const char * WsfTaskCancelMessage::GetScriptClassName ( ) const

override

◆ GetTaskId()

unsigned int WsfTaskCancelMessage::GetTaskId ( ) const

inline

Return the assigners task ID.

References mTaskId.

Referenced by WsfTaskManager::DropFromPurgedTaskList(), WsfTaskManager::ProcessTaskCancelMessage(), and WsfTaskCancelMessage().

◆ GetTaskType()

WsfStringId WsfTaskCancelMessage::GetTaskType ( ) const

inline

Get the task type.

References mTaskType.

Referenced by WsfTaskManager::ProcessTaskCancelMessage(), and WsfTaskCancelMessage().

◆ GetTrackId()

const WsfTrackId & WsfTaskCancelMessage::GetTrackId ( ) const

inline

Get the track ID to which the message applies.

References mTrackId.

Referenced by WsfTaskManager::ProcessTaskCancelMessage(), and WsfTaskCancelMessage().

◆ GetTypeId()

WsfStringId WsfTaskCancelMessage::GetTypeId ( )

static

Get the type ID associated with this message.

Returns: The string ID of this message.

Referenced by WsfTaskManager::DropFromPurgedTaskList(), WsfXIO_MessageService::HandleMessage(), WsfXIO_AutoDisMapping::Initialize(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

◆ Serialize()

template<typename T>

void WsfTaskCancelMessage::Serialize ( T & aBuff )

inline

For XIO (de)serialization.

References mAssigneePlatformIndex, mAssigneePlatformName, mAssigneeProcessorName, mAssignerPlatformIndex, mAssignerPlatformName, mAssignerProcessorName, mResourceName, mTaskId, mTaskType, mTrackId, and WsfMessage::Serialize().

◆ SetAssigneePlatformIndex()

void WsfTaskCancelMessage::SetAssigneePlatformIndex ( size_t aIndex )

inline

Set the platform index of the assignee.

References mAssigneePlatformIndex.

Referenced by WsfXIO_AutoDisMapping::TranslateTaskCancelMessage().

◆ SetAssignerPlatformIndex()

void WsfTaskCancelMessage::SetAssignerPlatformIndex ( size_t aIndex )

inline

Set the platform index of the assigner.

References mAssignerPlatformIndex.

Referenced by WsfXIO_AutoDisMapping::TranslateTaskCancelMessage().

◆ SetResourceName() [1/2]

void WsfTaskCancelMessage::SetResourceName ( const std::string & aResourceName )

inline

Set the resource (string form).

References mResourceName.

◆ SetResourceName() [2/2]

void WsfTaskCancelMessage::SetResourceName ( WsfStringId aResourceName )

inline

Set the resource (ID form).

References mResourceName.

◆ SetTaskType() [1/2]

void WsfTaskCancelMessage::SetTaskType ( const std::string & aTaskType )

inline

Set the task type (string form).

References mTaskType.

◆ SetTaskType() [2/2]

void WsfTaskCancelMessage::SetTaskType ( WsfStringId aTaskType )

inline

Set the task type (ID form).

References mTaskType.

◆ SetTrackId()

void WsfTaskCancelMessage::SetTrackId ( const WsfTrackId & aTrackId )

inline

Set the track ID to which the message applies.

References mTrackId.

Member Data Documentation

◆ mAssigneePlatformIndex

size_t WsfTaskCancelMessage::mAssigneePlatformIndex

protected

The platform index of the assignee.

Referenced by GetAssignee(), GetAssigneePlatformIndex(), Serialize(), SetAssigneePlatformIndex(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

◆ mAssigneePlatformName

WsfStringId WsfTaskCancelMessage::mAssigneePlatformName

protected

The name of the assignee.

Referenced by GetAssigneePlatformName(), Serialize(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

◆ mAssigneeProcessorName

WsfStringId WsfTaskCancelMessage::mAssigneeProcessorName

protected

The name of the processor on the assignee.

Referenced by GetAssigneeProcessorName(), Serialize(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

◆ mAssignerPlatformIndex

size_t WsfTaskCancelMessage::mAssignerPlatformIndex

protected

The platform index of the assigner.

Referenced by GetAssigner(), GetAssignerPlatformIndex(), Serialize(), SetAssignerPlatformIndex(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

◆ mAssignerPlatformName

WsfStringId WsfTaskCancelMessage::mAssignerPlatformName

protected

The name of the assigner.

Referenced by GetAssignerPlatformName(), Serialize(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

◆ mAssignerProcessorName

WsfStringId WsfTaskCancelMessage::mAssignerProcessorName

protected

The name of the processor on the assigner.

Referenced by GetAssignerProcessorName(), Serialize(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

◆ mResourceName

WsfStringId WsfTaskCancelMessage::mResourceName

protected

The resource assigned for the task.

Referenced by GetResourceName(), Serialize(), SetResourceName(), SetResourceName(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

◆ mTaskId

unsigned int WsfTaskCancelMessage::mTaskId

protected

The assigners task ID.

Referenced by GetTaskId(), Serialize(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

◆ mTaskType

WsfStringId WsfTaskCancelMessage::mTaskType

protected

The type of the task.

Referenced by GetTaskType(), Serialize(), SetTaskType(), SetTaskType(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

◆ mTrackId

WsfTrackId WsfTaskCancelMessage::mTrackId

protected

The track ID of the track associated with the task.

Referenced by GetTrackId(), Serialize(), SetTrackId(), WsfTaskCancelMessage(), WsfTaskCancelMessage(), and WsfTaskCancelMessage().

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

Public Member Functions

Static Public Member Functions

Resource methods.

Assigner methods.

Assignee methods.

Track ID methods.

Task type methods.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfTaskCancelMessage() [1/3]

◆ WsfTaskCancelMessage() [2/3]

◆ WsfTaskCancelMessage() [3/3]

Member Function Documentation

◆ Clone()

◆ CreateScriptClass()

◆ GetAssignee()

◆ GetAssigneePlatformIndex()

◆ GetAssigneePlatformName()

◆ GetAssigneeProcessorName()

◆ GetAssigner()

◆ GetAssignerPlatformIndex()

◆ GetAssignerPlatformName()

◆ GetAssignerProcessorName()

◆ GetResourceName()

◆ GetScriptClassName()

◆ GetTaskId()

◆ GetTaskType()

◆ GetTrackId()

◆ GetTypeId()

◆ Serialize()

◆ SetAssigneePlatformIndex()

◆ SetAssignerPlatformIndex()

◆ SetResourceName() [1/2]

◆ SetResourceName() [2/2]

◆ SetTaskType() [1/2]

◆ SetTaskType() [2/2]

◆ SetTrackId()

Member Data Documentation

◆ mAssigneePlatformIndex

◆ mAssigneePlatformName

◆ mAssigneeProcessorName

◆ mAssignerPlatformIndex

◆ mAssignerPlatformName

◆ mAssignerProcessorName

◆ mResourceName

◆ mTaskId

◆ mTaskType

◆ mTrackId