Files
geant4/source/externals/ptl/include/PTL/VTask.hh
T
2022-12-09 14:43:28 +01:00

81 lines
2.5 KiB
C++

//
// MIT License
// Copyright (c) 2020 Jonathan R. Madsen
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
// Tasking class header file
//
// Class Description:
//
// This file creates an abstract base class for the thread-pool tasking
// system
//
// ---------------------------------------------------------------
// Author: Jonathan Madsen (Feb 13th 2018)
// ---------------------------------------------------------------
#pragma once
#include <cstddef>
#include <cstdint>
#include <functional>
#include <thread>
namespace PTL
{
//======================================================================================//
/// \brief VTask is the abstract class stored in thread_pool
class VTask
{
public:
using tid_type = std::thread::id;
using size_type = size_t;
using void_func_t = std::function<void()>;
public:
VTask(bool _is_native, intmax_t _depth)
: m_is_native{ _is_native }
, m_depth{ _depth }
{}
VTask() = default;
virtual ~VTask() = default;
VTask(const VTask&) = delete;
VTask& operator=(const VTask&) = delete;
VTask(VTask&&) = default;
VTask& operator=(VTask&&) = default;
public:
// execution operator
virtual void operator()() = 0;
public:
bool is_native_task() const { return m_is_native; }
intmax_t depth() const { return m_depth; }
protected:
bool m_is_native = false;
intmax_t m_depth = 0;
void_func_t m_func = []() {};
};
//======================================================================================//
} // namespace PTL