Acts/TrackFitting/KalmanFitterError.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 Kalman filter operations
0017 enum class KalmanFitterError {
0018   // ensure all values are non-zero
0019   UpdateFailed = 1,
0020   SmoothFailed,
0021   OutputConversionFailed,
0022   NoMeasurementFound,
0023   ReversePropagationFailed,
0024 };
0025
0026 /// Create error code from @ref KalmanFitterError
0027 /// @param e The error code enum value
0028 /// @return Standard error code
0029 std::error_code make_error_code(Acts::KalmanFitterError e);
0030
0031 }  // namespace Acts
0032
0033 namespace std {
0034 // register with STL
0035 template <>
0036 struct is_error_code_enum<Acts::KalmanFitterError> : std::true_type {};
0037 }  // namespace std