Defines a change in a task. Assignment, cancellation, or completion. Response to WsfXIO_TaskRequestPkt. More...

#include <WsfXIO_PacketRegistry.hpp>

Inheritance diagram for WsfXIO_TaskUpdatePkt:

[legend]

Collaboration diagram for WsfXIO_TaskUpdatePkt:

[legend]

Public Types
enum	{ cTASK_ACCEPTED = 1 , cTASK_ASSIGNED = 2 , cTASK_CANCELED = 3 , cTASK_COMPLETED = 4 , cTASK_UPDATE_TYPE_1 = 5 , cTASK_UPDATE_TYPE_2 = 6 , cTASK_UPDATE_TYPE_3 = 7 , cTASK_UPDATE_TYPE_4 = 8 }
	Allowed UpdateType values. More...
typedef int32_t	UpdateType
Public Types inherited from WsfXIO_Packet
enum	PacketFlags { cSYNCHRONIZED = 1 }
typedef bool	BaseType

Public Member Functions
	XIO_DEFINE_PACKET (WsfXIO_TaskUpdatePkt, WsfXIO_ResponsePkt, 34)
void	ReceiveCleanup () override
Public Member Functions inherited from WsfXIO_ResponsePkt
	XIO_DEFINE_PACKET_CTOR (WsfXIO_ResponsePkt, WsfXIO_Packet, 5)
	mFromProvider (false)
	mCompletesRequest (false)
	mRequestId (0)
	XIO_DEFINE_PACKET_SERIALIZE ()
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
UpdateType	mUpdateType
	Type of task update.
const WsfTaskData *	mTaskPtr
	The Task.
const WsfTrack *	mTrackPtr
	Track associated with task (valid for cTASK_ASSIGNED & cTASK_ACCEPTED).
WsfStringId	mTaskStatus
	Status of task (valid for cTASK_COMPLETED).
Public Attributes inherited from WsfXIO_ResponsePkt
bool	mFromProvider
bool	mCompletesRequest
	If true, the receipt of this response indicates the request has been satisfied and should be closed.
int32_t	mRequestId
	Request ID. If this is 0, the packet is for any receiver.
Public Attributes inherited from WsfXIO_Packet
GenUniqueId	mApplicationId

Additional Inherited Members
Static Public Attributes inherited from WsfXIO_Packet
static const int	cPACKET_ID = -1
Protected Attributes inherited from WsfXIO_Packet
uint32_t	mFlags
float	mTimeStamp

Detailed Description

Defines a change in a task. Assignment, cancellation, or completion. Response to WsfXIO_TaskRequestPkt.

Member Typedef Documentation

◆ UpdateType

typedef int32_t WsfXIO_TaskUpdatePkt::UpdateType

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Allowed UpdateType values.

Enumerator
cTASK_ACCEPTED
cTASK_ASSIGNED
cTASK_CANCELED
cTASK_COMPLETED
cTASK_UPDATE_TYPE_1	The following status types are reserved for extensions.
cTASK_UPDATE_TYPE_2
cTASK_UPDATE_TYPE_3
cTASK_UPDATE_TYPE_4

Member Function Documentation

◆ ReceiveCleanup()

void WsfXIO_TaskUpdatePkt::ReceiveCleanup ( )

inlineoverride

References mTaskPtr, and mTrackPtr.

◆ XIO_DEFINE_PACKET()

WsfXIO_TaskUpdatePkt::XIO_DEFINE_PACKET	(	WsfXIO_TaskUpdatePkt	,
		WsfXIO_ResponsePkt	,
		34	)

inline

References mTaskPtr, mTaskStatus, mTrackPtr, and mUpdateType.

Member Data Documentation

◆ mTaskPtr

const WsfTaskData* WsfXIO_TaskUpdatePkt::mTaskPtr

The Task.

Referenced by ReceiveCleanup(), WsfXIO_TaskService::TaskAccepted(), WsfXIO_TaskService::TaskAssigned(), WsfXIO_TaskService::TaskCanceled(), WsfXIO_TaskService::TaskCompleted(), and XIO_DEFINE_PACKET().

◆ mTaskStatus

WsfStringId WsfXIO_TaskUpdatePkt::mTaskStatus

Status of task (valid for cTASK_COMPLETED).

Referenced by WsfXIO_TaskService::TaskCompleted(), and XIO_DEFINE_PACKET().

◆ mTrackPtr

const WsfTrack* WsfXIO_TaskUpdatePkt::mTrackPtr

Track associated with task (valid for cTASK_ASSIGNED & cTASK_ACCEPTED).

Referenced by ReceiveCleanup(), WsfXIO_TaskService::TaskAccepted(), WsfXIO_TaskService::TaskAssigned(), WsfXIO_TaskService::TaskCanceled(), WsfXIO_TaskService::TaskCompleted(), and XIO_DEFINE_PACKET().

◆ mUpdateType

UpdateType WsfXIO_TaskUpdatePkt::mUpdateType

Type of task update.

Referenced by WsfXIO_TaskService::TaskAccepted(), WsfXIO_TaskService::TaskAssigned(), WsfXIO_TaskService::TaskCanceled(), WsfXIO_TaskService::TaskCompleted(), and XIO_DEFINE_PACKET().

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

WsfXIO_PacketRegistry.hpp

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members