Acts/MagneticField/MagneticFieldError.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 magnetic field operations
0017 enum class MagneticFieldError {
0018   OutOfBounds = 1,
0019   NotImplemented = 2,
0020 };
0021
0022 /// Create error code from MagneticFieldError
0023 /// @param e The error code enum value
0024 /// @return Standard error code
0025 std::error_code make_error_code(Acts::MagneticFieldError e);
0026
0027 }  // namespace Acts
0028
0029 namespace std {
0030 // register with STL
0031 template <>
0032 struct is_error_code_enum<Acts::MagneticFieldError> : std::true_type {};
0033 }  // namespace std