Task.h

#pragma once
 
#include <Foundation/Strings/String.h>
#include <Foundation/Threading/AtomicInteger.h>
#include <Foundation/Threading/Implementation/TaskSystemDeclarations.h>
#include <Foundation/Types/RefCounted.h>
 
class PL_FOUNDATION_DLL plTask : public plRefCounted
{
  PL_DISALLOW_COPY_AND_ASSIGN(plTask);
 
public:
  plTask();
  virtual ~plTask();
 
  void ConfigureTask(const char* szTaskName, plTaskNesting nestingMode, plOnTaskFinishedCallback callback = plOnTaskFinishedCallback()); // [tested]
 
  void SetMultiplicity(plUInt32 uiMultiplicity); // [tested]
 
  plUInt32 GetMultiplicity() const { return m_uiMultiplicity; } // [tested]
 
  bool IsTaskFinished() const { return m_iRemainingRuns == 0; } // [tested]
 
  bool HasBeenCanceled() const { return m_bCancelExecution; } // [tested]
 
protected:
  virtual void Execute() {} // [tested]
 
  virtual void ExecuteWithMultiplicity(plUInt32 uiInvocation) const {} // [tested]
 
private:
  // The task system and its worker threads implement most of the functionality of the task handling.
  // Therefore they are allowed to modify all this internal state.
  friend class plTaskSystem;
 
  void Reset();
 
  void Run(plUInt32 uiInvocation);
 
  plAtomicInteger32 m_iRemainingRuns;
 
  bool m_bCancelExecution = false;
 
  bool m_bTaskIsScheduled = false;
 
  bool m_bUsesMultiplicity = false;
 
  plUInt32 m_uiMultiplicity = 0;
 
  plTaskNesting m_NestingMode = plTaskNesting::Maybe;
 
  plOnTaskFinishedCallback m_OnTaskFinished;
 
  plTaskGroupID m_BelongsToGroup;
 
  plString m_sTaskName;
};