Task.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#ifndef Q_MOC_RUN
#include <memory>
#endif
#include "MantidKernel/DllConfig.h"
#include "MantidKernel/Exception.h"
#include <mutex>
 
namespace Mantid {
 
namespace Kernel {
 
//==============================================================================================
class MANTID_KERNEL_DLL Task {
public:
  //---------------------------------------------------------------------------------------------
  Task() : m_cost(1.0) {}
 
  //---------------------------------------------------------------------------------------------
  Task(double cost) : m_cost(cost) {}
 
  virtual ~Task() = default;
 
  //---------------------------------------------------------------------------------------------
  virtual void run() = 0;
 
  //---------------------------------------------------------------------------------------------
  virtual double cost() { return m_cost; }
 
  //---------------------------------------------------------------------------------------------
  void setMutexObject(void *object) {
    UNUSED_ARG(object);
    throw Kernel::Exception::NotImplementedError("Not impl.");
  }
 
  //---------------------------------------------------------------------------------------------
  std::shared_ptr<std::mutex> getMutex() { return m_mutex; }
 
  //---------------------------------------------------------------------------------------------
  void setMutex(const std::shared_ptr<std::mutex> &mutex) { m_mutex = mutex; }
 
protected:
  double m_cost;
 
  std::shared_ptr<std::mutex> m_mutex;
};
 
} // namespace Kernel
} // namespace Mantid