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 /// @ingroup errors
0018 enum class KalmanFitterError {
0019   // ensure all values are non-zero
0020   /// Kalman update failed
0021   UpdateFailed = 1,
0022   /// Kalman smooth failed
0023   SmoothFailed,
0024   /// Kalman output conversion failed
0025   OutputConversionFailed,
0026   /// No measurement detected during the propagation
0027   NoMeasurementFound,
0028   /// Reverse propagation failed
0029   ReversePropagationFailed,
0030   InconsistentTrackStates,
0031 };
0032
0033 /// Create error code from @ref KalmanFitterError
0034 /// @param e The error code enum value
0035 /// @return Standard error code
0036 std::error_code make_error_code(Acts::KalmanFitterError e);
0037
0038 }  // namespace Acts
0039
0040 namespace std {
0041 // register with STL
0042 template <>
0043 struct is_error_code_enum<Acts::KalmanFitterError> : std::true_type {};
0044 }  // namespace std