#include <WsfTaskAssignMessage.hpp>

Inheritance diagram for WsfTaskAssignMessage:

[legend]

Collaboration diagram for WsfTaskAssignMessage:

[legend]

Public Member Functions
	WsfTaskAssignMessage ()
	Constructor, for XIO (de)serialization.
	WsfTaskAssignMessage (WsfPlatform *aPlatformPtr)
	WsfTaskAssignMessage (const WsfTaskAssignMessage &aSrc)
	Copy constructor.
WsfTaskAssignMessage &	operator= (const WsfTaskAssignMessage &)=delete
WsfMessage *	Clone () const override
const char *	GetScriptClassName () const override
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 ()

Track methods.
WsfTask	mTask
WsfTrack	mTrack
const WsfTrack &	GetTrack () const
	Get the track that was sent (const form).
WsfTrack &	GetTrack ()
	Get the track that was sent (non-const form).
void	SetTrack (const WsfTrack &aTrack)
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.

Task methods.
const WsfTask &	GetTask () const
	Get the task that was sent (const form).
WsfTask &	GetTask ()
	Get the task that was sent (non-const form).
void	SetTask (const WsfTask &aTask)

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 assign a task.

This message is sent to initiate a task. The task is can be simple (start tracking a particular object) or vague (execute the kill chain against a target), but the key point is that the task is related to a track is to be done as soon as possible. As implemented it does not provide for a complex mission as it does not provide the ability to specify timing constraints, routes, or multiple tasks.

A task is uniquely identified by:

A track ID.
A task type.
A resource. The name of a particular component to be applied to the task.

See also: WsfTaskManager; WsfTaskCancelMessage; WsfTaskStatusMessage

Constructor & Destructor Documentation

◆ WsfTaskAssignMessage() [1/3]

WsfTaskAssignMessage::WsfTaskAssignMessage ( )

Constructor, for XIO (de)serialization.

References GetTypeId(), mTask, mTrack, and WsfMessage::WsfMessage().

Referenced by Clone(), operator=(), and WsfTaskAssignMessage().

◆ WsfTaskAssignMessage() [2/3]

WsfTaskAssignMessage::WsfTaskAssignMessage ( WsfPlatform * aPlatformPtr )

Constructor

Parameters

aPlatformPtr The originator of the message.

References GetTypeId(), mTask, mTrack, and WsfMessage::WsfMessage().

◆ WsfTaskAssignMessage() [3/3]

WsfTaskAssignMessage::WsfTaskAssignMessage ( const WsfTaskAssignMessage & aSrc )

Copy constructor.

References mTask, mTrack, WsfMessage::WsfMessage(), and WsfTaskAssignMessage().

Member Function Documentation

◆ Clone()

WsfMessage * WsfTaskAssignMessage::Clone ( ) const

overridevirtual

Clone this object by creating an identical copy and returning a pointer to it.

Returns: A pointer to the cloned object.

Reimplemented from WsfMessage.

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

◆ CreateScriptClass()

std::unique_ptr< UtScriptClass > WsfTaskAssignMessage::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 operator=(), and WsfScriptManager::RegisterTypes().

◆ GetScriptClassName()

const char * WsfTaskAssignMessage::GetScriptClassName ( ) const

override

◆ GetTask() [1/2]

WsfTask & WsfTaskAssignMessage::GetTask ( )

inline

Get the task that was sent (non-const form).

References mTask.

◆ GetTask() [2/2]

const WsfTask & WsfTaskAssignMessage::GetTask ( ) const

inline

Get the task that was sent (const form).

References mTask.

Referenced by WsfTaskManager::CheckMessageAcknowledged(), WsfQuantumTaskerProcessor::ProcessTaskAssignMessage(), WsfTaskManager::ProcessTaskAssignMessage(), WsfTaskManager::ReceiveMessage(), and WsfXIO_AutoDisMapping::TranslateTaskAssignMessage().

◆ GetTrack() [1/2]

WsfTrack & WsfTaskAssignMessage::GetTrack ( )

inline

Get the track that was sent (non-const form).

References mTrack.

◆ GetTrack() [2/2]

const WsfTrack & WsfTaskAssignMessage::GetTrack ( ) const

inline

Get the track that was sent (const form).

References mTrack.

Referenced by WsfQuantumTaskerProcessor::ProcessTaskAssignMessage(), WsfTaskManager::ProcessTaskAssignMessage(), and WsfXIO_AutoDisMapping::TranslateTaskAssignMessage().

◆ GetTypeId()

WsfStringId WsfTaskAssignMessage::GetTypeId ( )

static

Get the type ID associated with this message.

Returns: The string ID of this message.

Referenced by WsfTaskManager::CheckMessageAcknowledged(), WsfXIO_MessageService::HandleMessage(), WsfXIO_AutoDisMapping::Initialize(), WsfTaskAssignMessage(), and WsfTaskAssignMessage().

◆ operator=()

WsfTaskAssignMessage & WsfTaskAssignMessage::operator= ( const WsfTaskAssignMessage & )

delete

References CreateScriptClass(), WsfMessage::WsfMessage(), and WsfTaskAssignMessage().

◆ Serialize()

template<typename T>

void WsfTaskAssignMessage::Serialize ( T & aBuff )

inline

For XIO (de)serialization.

References mTask, mTrack, and WsfMessage::Serialize().

◆ SetTask()

void WsfTaskAssignMessage::SetTask ( const WsfTask & aTask )

Set the task to be assigned.

Parameters

aTask The task to be assigned.

References WsfTask::GetLocalTrackId(), and mTask.

Referenced by WsfQuantumTaskerProcessor::AssignTask(), and WsfTaskManager::AssignTask().

◆ SetTrack()

void WsfTaskAssignMessage::SetTrack ( const WsfTrack & aTrack )

Set the track to be sent.

Parameters

aTrack the track to be associated with the assignment.

References mTrack.

Referenced by WsfQuantumTaskerProcessor::AssignTask(), and WsfTaskManager::AssignTask().

Member Data Documentation

◆ mTask

WsfTask WsfTaskAssignMessage::mTask

protected

Referenced by GetTask(), GetTask(), Serialize(), SetTask(), WsfTaskAssignMessage(), WsfTaskAssignMessage(), and WsfTaskAssignMessage().

◆ mTrack

WsfTrack WsfTaskAssignMessage::mTrack

protected

Referenced by GetTrack(), GetTrack(), Serialize(), SetTrack(), WsfTaskAssignMessage(), WsfTaskAssignMessage(), and WsfTaskAssignMessage().

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

Public Member Functions

Static Public Member Functions

Track methods.

Task methods.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfTaskAssignMessage() [1/3]

◆ WsfTaskAssignMessage() [2/3]

◆ WsfTaskAssignMessage() [3/3]

Member Function Documentation

◆ Clone()

◆ CreateScriptClass()

◆ GetScriptClassName()

◆ GetTask() [1/2]

◆ GetTask() [2/2]

◆ GetTrack() [1/2]

◆ GetTrack() [2/2]

◆ GetTypeId()

◆ operator=()

◆ Serialize()

◆ SetTask()

◆ SetTrack()

Member Data Documentation

◆ mTask

◆ mTrack