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 /// @ingroup errors
0018 enum class MagneticFieldError {
0019   /// The lookup position was outside of the validitiy domain of the underlying
0020   /// magnetic field instance.
0021   OutOfBounds = 1,
0022   /// An operation for this magnetic field type is not implemented.
0023   NotImplemented = 2,
0024 };
0025
0026 /// @cond
0027 /// Create error code from MagneticFieldError
0028 /// @param e The error code enum value
0029 /// @return Standard error code
0030 std::error_code make_error_code(Acts::MagneticFieldError e);
0031 /// @endcond
0032
0033 }  // namespace Acts
0034
0035 namespace std {
0036 // register with STL
0037 template <>
0038 struct is_error_code_enum<Acts::MagneticFieldError> : std::true_type {};
0039 }  // namespace std