WSF: WsfXIO_TaskCommandPkt Class Reference

WSF

Requests a task manager processor to create or modify a task. More...

#include <WsfXIO_PacketRegistry.hpp>

Inheritance diagram for WsfXIO_TaskCommandPkt:

Inheritance graph

[legend]

Collaboration diagram for WsfXIO_TaskCommandPkt:

Collaboration graph

[legend]

Public Types
enum	{ cTASK_ASSIGN , cTASK_CANCEL , cTASK_COMPLETE , cTASK_PROGRESS , cCHANGE_OPERATING_LEVEL , cTASK_COMMAND_1 , cTASK_COMMAND_2 , cTASK_COMMAND_3 , cTASK_COMMAND_4 }
	Valid command types. More...
typedef WsfXIO_Packet	BaseType
typedef int32_t	CommandType
Public Types inherited from WsfXIO_Packet
enum	PacketFlags { cSYNCHRONIZED = 1 }
typedef bool	BaseType

Public Member Functions
	WsfXIO_TaskCommandPkt (int aPacketId=cPACKET_ID)
template<typename T>
void	Serialize (T &aBuff)
template<typename T>
void	DoSerialize (T &aBuff)
void	ReceiveCleanup () override
Public Member Functions inherited from WsfXIO_Packet
	WsfXIO_Packet (int aPacketId)
template<typename T>
void	Serialize (T &aBuff)
	Serializes the packet header. Must be called first from derived class Serialize().
float	GetTimeStamp () const
void	SetTimeStamp (float aTimeStamp)
void	SetFlags (uint32_t aFlags)
void	AddFlags (uint32_t aFlags)
uint32_t	GetFlags () const

Public Attributes
CommandType	mCommandType
	{ Note: '[]' denotes optional
unsigned int	mAssignerPlatformIndex
	Platform Index of the assigner platform. Required.
WsfStringId	mAssignerProcessorName
	Name of the assigner's task manager processor. Required.
WsfTrackId	mTrackId
	The subject track ID. *Required.
WsfStringId	mTargetNameId
	The name of the target platform for this track. Used if mTrackId is not given.
WsfStringId	mTaskType
	Type of task. For cTASK_ASSIGN cTASK_COMPLETE cTASK_PROGRESS cCHANGE_OPERATING_LEVEL [cTASK_CANCEL].
unsigned int	mAssigneePlatformIndex
WsfStringId	mAssigneeProcessorName
	Name of the processor on the assigned platform. For cTASK_ASSIGN.
WsfTaskResource *	mResourcePtr
	Name of the resource to route the task to. For cTASK_ASSIGN.
WsfStringId	mCommName
	Name of the comm device to use. For [cTASK_ASSIGN].
WsfStringId	mStatus
	Status message. For [cTASK_COMPLETE] [cTASK_PROGRESS].
int32_t	mOperatingLevel
	For only cCHANGE_OPERATING_LEVEL.
Public Attributes inherited from WsfXIO_Packet
GenUniqueId	mApplicationId

Static Public Attributes
static const int	cPACKET_ID = 35
Static Public Attributes inherited from WsfXIO_Packet
static const int	cPACKET_ID = -1

Additional Inherited Members
Protected Attributes inherited from WsfXIO_Packet
uint32_t	mFlags
float	mTimeStamp

Detailed Description

Requests a task manager processor to create or modify a task.

Member Typedef Documentation

◆ BaseType

typedef WsfXIO_Packet WsfXIO_TaskCommandPkt::BaseType

◆ CommandType

typedef int32_t WsfXIO_TaskCommandPkt::CommandType

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Valid command types.

Enumerator
cTASK_ASSIGN	Assign a task.
cTASK_CANCEL	Cancel an assigned task.
cTASK_COMPLETE	Report a received task as complete.
cTASK_PROGRESS	Report progress on a received task.
cCHANGE_OPERATING_LEVEL	Change operating level.
cTASK_COMMAND_1
cTASK_COMMAND_2
cTASK_COMMAND_3
cTASK_COMMAND_4

Constructor & Destructor Documentation

◆ WsfXIO_TaskCommandPkt()

WsfXIO_TaskCommandPkt::WsfXIO_TaskCommandPkt ( int aPacketId = cPACKET_ID )

inline

References cPACKET_ID, and mResourcePtr.

Member Function Documentation

◆ DoSerialize()

template<typename T>

void WsfXIO_TaskCommandPkt::DoSerialize ( T & aBuff )

inline

References mAssigneePlatformIndex, mAssigneeProcessorName, mAssignerPlatformIndex, mAssignerProcessorName, mCommandType, mCommName, mOperatingLevel, mResourcePtr, mStatus, mTargetNameId, mTaskType, and mTrackId.

Referenced by Serialize().

◆ ReceiveCleanup()

void WsfXIO_TaskCommandPkt::ReceiveCleanup ( )

inlineoverride

References mResourcePtr.

◆ Serialize()

template<typename T>

void WsfXIO_TaskCommandPkt::Serialize ( T & aBuff )

inline

References DoSerialize(), and WsfXIO_Packet::Serialize().

Member Data Documentation

◆ cPACKET_ID

const int WsfXIO_TaskCommandPkt::cPACKET_ID = 35

static

Referenced by WsfXIO_TaskCommandPkt().

◆ mAssigneePlatformIndex

unsigned int WsfXIO_TaskCommandPkt::mAssigneePlatformIndex

Index of the assigned platform. For cTASK_ASSIGN, cCHANGE_OPERATING_LEVEL. A value of 0 assumes the assignee is the assigner

Referenced by DoSerialize(), and WsfXIO_TaskService::HandleCommand().

◆ mAssigneeProcessorName

WsfStringId WsfXIO_TaskCommandPkt::mAssigneeProcessorName

Name of the processor on the assigned platform. For cTASK_ASSIGN.

Referenced by DoSerialize(), and WsfXIO_TaskService::HandleCommand().

◆ mAssignerPlatformIndex

unsigned int WsfXIO_TaskCommandPkt::mAssignerPlatformIndex

Platform Index of the assigner platform. Required.

Referenced by DoSerialize(), and WsfXIO_TaskService::HandleCommand().

◆ mAssignerProcessorName

WsfStringId WsfXIO_TaskCommandPkt::mAssignerProcessorName

Name of the assigner's task manager processor. Required.

Referenced by DoSerialize(), and WsfXIO_TaskService::HandleCommand().

◆ mCommandType

CommandType WsfXIO_TaskCommandPkt::mCommandType

{ Note: '[]' denotes optional

Type of task update. Required.

Referenced by DoSerialize(), WsfXIO_TaskService::HandleCommand(), and WsfXIO_WeaponComponent::HandleTaskCommand().

◆ mCommName

WsfStringId WsfXIO_TaskCommandPkt::mCommName

Name of the comm device to use. For [cTASK_ASSIGN].

Referenced by DoSerialize(), and WsfXIO_TaskService::HandleCommand().

◆ mOperatingLevel

int32_t WsfXIO_TaskCommandPkt::mOperatingLevel

For only cCHANGE_OPERATING_LEVEL.

Referenced by DoSerialize(), and WsfXIO_TaskService::HandleCommand().

◆ mResourcePtr

WsfTaskResource* WsfXIO_TaskCommandPkt::mResourcePtr

Name of the resource to route the task to. For cTASK_ASSIGN.

Referenced by DoSerialize(), WsfXIO_TaskService::HandleCommand(), ReceiveCleanup(), and WsfXIO_TaskCommandPkt().

◆ mStatus

WsfStringId WsfXIO_TaskCommandPkt::mStatus

Status message. For [cTASK_COMPLETE] [cTASK_PROGRESS].

Referenced by DoSerialize(), and WsfXIO_TaskService::HandleCommand().

◆ mTargetNameId

WsfStringId WsfXIO_TaskCommandPkt::mTargetNameId

The name of the target platform for this track. Used if mTrackId is not given.

Referenced by DoSerialize(), and WsfXIO_TaskService::HandleCommand().

◆ mTaskType

WsfStringId WsfXIO_TaskCommandPkt::mTaskType

Type of task. For cTASK_ASSIGN cTASK_COMPLETE cTASK_PROGRESS cCHANGE_OPERATING_LEVEL [cTASK_CANCEL].

Referenced by DoSerialize(), and WsfXIO_TaskService::HandleCommand().

◆ mTrackId

WsfTrackId WsfXIO_TaskCommandPkt::mTrackId

The subject track ID. *Required.

Referenced by DoSerialize(), and WsfXIO_TaskService::HandleCommand().

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

WsfXIO_PacketRegistry.hpp

Copyrights Multiple, All Rights Reserved