Acts/Propagator/PropagatorError.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 Acts {
0015
0016 /// Error codes for propagator operations
0017 enum class PropagatorError {
0018   // ensure all values are non-zero
0019   Failure = 1,
0020   StepCountLimitReached,
0021   NextTargetLimitReached,
0022 };
0023
0024 /// Create error code from PropagatorError
0025 /// @param e The error code enum value
0026 /// @return Standard error code
0027 std::error_code make_error_code(Acts::PropagatorError e);
0028
0029 }  // namespace Acts
0030
0031 namespace std {
0032 // register with STL
0033 template <>
0034 struct is_error_code_enum<Acts::PropagatorError> : std::true_type {};
0035 }  // namespace std