Kernel/detail/SimulationError.hpp

0001 // This file is part of the ACTS project.
0002 //
0003 // Copyright (C) 2016 CERN for the benefit of the ACTS project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include <system_error>
0012 #include <type_traits>
0013
0014 namespace ActsFatras::detail {
0015
0016 /// @ingroup errors
0017 enum class SimulationError {
0018   // ensure all values are non-zero
0019   /// Input particle id with non-zero generation or sub-particle
0020   InvalidInputParticleId = 1,
0021 };
0022
0023 /// Construct and error_code from the enum.
0024 ///
0025 /// Must use snake_case naming for STL compatibility.
0026 std::error_code make_error_code(SimulationError e);
0027
0028 }  // namespace ActsFatras::detail
0029
0030 // Register the error enum as STL-compatible.
0031 namespace std {
0032 template <>
0033 struct is_error_code_enum<ActsFatras::detail::SimulationError>
0034     : std::true_type {};
0035 }  // namespace std