CBaseTask Class Reference

Base task descriptor. More...

#include <BaseTask.h>

Public Member Functions
	CBaseTask ()
	Default constructor. More...
virtual void	Perform ()
	Perform this task. More...
const size_t	GetTaskId () const
	Get task identifier. More...
void	SetThreadId (const size_t)
	Set thread identifier. More...
const size_t	GetThreadId () const
	Get thread identifier. More...

Protected Attributes
size_t	m_nTaskId = 0
	Task identifier.
size_t	m_nThreadId = max_size_t
	Identifier of thread that performed task.

Static Private Attributes
static std::atomic< size_t >	m_nNumTasks {0}
	Number of tasks extant. More...

Detailed Description

The base task descriptor describes a base task, including a task identifier, a thread identifier which is to be set by the thread that performs this task, and a function to perform the task. You should derive your task desciptor from this class.

Your task descriptor should implement a constructor for any task-related initialization and it should override function Perform() with the code to perform your task. Each task descriptor you instantiate will automatically get a unique task identifier m_nTaskId which can be read using GetTaskId(). This is maintained using a private static atomic member variable m_nNumTasks that is incremented and copied to m_nTaskId by the CBaseTask constructor. It is recommended that you do not interfere with this process. You are responsible for setting the thread identifier by calling SetThreadId() when this task descriptor is assigned to a thread. The thread identifier can be read later by calling GetThreadId(). The task and thread identifiers are there for debugging purposes and do not impose a significant load on time or memory requirements.

Constructor & Destructor Documentation

CBaseTask()

CBaseTask::CBaseTask

(

)

The default constructor.

Member Function Documentation

GetTaskId()

const size_t CBaseTask::GetTaskId

(

)

const

Reader function for the task identifier.

Returns

The task identifier.

GetThreadId()

const size_t CBaseTask::GetThreadId

(

)

const

Reader function for the thread identifier. If this is not correctly set by the processing thread, then this will be a very large number.

Returns

The thread identifier.

Perform()

void CBaseTask::Perform ( )

virtual

Perform the task. This function is a stub that is to be overridden in derived classes.

SetThreadId()

void CBaseTask::SetThreadId

(

const size_t

id

)

Set the thread identifier. This is to be called by the processing thread.

Parameters

id	Thread identifier for of the processing thread.

Member Data Documentation

m_nNumTasks

std::atomic< size_t > CBaseTask::m_nNumTasks {0}

staticprivate

Number of tasks.