Acts/TrackFinding/CombinatorialKalmanFilterError.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 combinatorial Kalman filter operations
0017 /// @ingroup errors
0018 enum class CombinatorialKalmanFilterError {
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   /// Measurement selection failed
0027   MeasurementSelectionFailed,
0028   /// Propagation reaches max steps before track finding is finished
0029   PropagationReachesMaxSteps,
0030   /// No measurement expected on the current surface
0031   NoMeasurementExpected
0032 };
0033
0034 /// Create error code from @ref CombinatorialKalmanFilterError
0035 /// @param e The error code enum value
0036 /// @return Standard error code
0037 std::error_code make_error_code(Acts::CombinatorialKalmanFilterError e);
0038
0039 }  // namespace Acts
0040
0041 namespace std {
0042 // register with STL
0043 template <>
0044 struct is_error_code_enum<Acts::CombinatorialKalmanFilterError>
0045     : std::true_type {};
0046 }  // namespace std