ArrayPtrTask< ElemType > Class Template Reference

Inheritance diagram for ArrayPtrTask< ElemType >:

Public Member Functions
	ArrayPtrTask (xiiArrayPtr< ElemType > payload, xiiParallelForFunction< ElemType > taskCallback, xiiUInt32 uiItemsPerInvocation)
void	Execute () override
	Override this to implement the task's supposed functionality.
void	ExecuteWithMultiplicity (xiiUInt32 uiInvocation) const override
	Override this to implement the task's supposed functionality.
Public Member Functions inherited from xiiTask
void	ConfigureTask (xiiStringView sTaskName, xiiTaskNesting nestingMode, xiiOnTaskFinishedCallback callback=xiiOnTaskFinishedCallback())
	Sets the most important task properties. This has to be done before the task is added to a task group for the first time.
void	SetMultiplicity (xiiUInt32 uiMultiplicity)
	Changes the multiplicity of this task.
xiiUInt32	GetMultiplicity () const
bool	IsTaskFinished () const
	Returns whether the task has been finished. This includes being canceled.
bool	HasBeenCanceled () const
	Can be used inside an overridden 'Execute' function to terminate execution prematurely.
Public Member Functions inherited from xiiRefCounted
virtual	~xiiRefCounted ()=default
	Adds a virtual destructor.
Public Member Functions inherited from xiiRefCountingImpl
	xiiRefCountingImpl ()=default
	Constructor.
	xiiRefCountingImpl (const xiiRefCountingImpl &rhs)
void	operator= (const xiiRefCountingImpl &rhs)
xiiUInt32	AddRef () const
	Increments the reference counter. Returns the new reference count.
xiiUInt32	ReleaseRef () const
	Decrements the reference counter. Returns the new reference count.
bool	IsReferenced () const
	Returns true if the reference count is greater than 0, false otherwise.
xiiUInt32	GetRefCount () const
	Returns the current reference count.

Member Function Documentation

Execute()

template<typename ElemType>

void ArrayPtrTask< ElemType >::Execute ( )

inlineoverridevirtual

Override this to implement the task's supposed functionality.

This function is called for tasks that do not use multiplicity. They are executed a single time for each time they are added to the xiiTaskSystem.

Reimplemented from xiiTask.

ExecuteWithMultiplicity()

template<typename ElemType>

void ArrayPtrTask< ElemType >::ExecuteWithMultiplicity ( xiiUInt32 uiInvocation ) const

inlineoverridevirtual

Override this to implement the task's supposed functionality.

This function is called for tasks that use multiplicity. A task that uses multiplicity is automatically run N times by the xiiTaskSystem, each time with an increasing invocation index. This allows to have a single task to handle something, but then decide dynamically how often to execute it, to subdivide the workload into multiple pieces. Since the same task is executed multiple times in parallel, tasks with multiplicity should not have any mutable state, which is why this function is const.

Reimplemented from xiiTask.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/Threading/Implementation/ParallelFor_inl.h