Acts/Propagator/MultiStepperError.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 multi-stepper operations
0017 /// @ingroup errors
0018 enum class MultiStepperError {
0019   // ensure all values are non-zero
0020   /// Component is not on a surface
0021   ComponentNotOnSurface = 1,
0022   /// The global BoundState/CurvilinearState can only be computed if only one
0023   /// component exists
0024   StateOfMultipleComponentsRequested = 2,
0025   /// The average track has left the current volume
0026   AverageTrackLeftCurrentVolume = 3,
0027   /// Stepping error occurred in all components
0028   AllComponentsSteppingError = 4,
0029   /// The conversion to the bound state failed for all components
0030   AllComponentsConversionToBoundFailed = 5,
0031   /// The conversion to the bound state failed for some components
0032   SomeComponentsConversionToBoundFailed = 6
0033 };
0034
0035 /// Create error code from MultiStepperError
0036 /// @param e The error code enum value
0037 /// @return Standard error code
0038 std::error_code make_error_code(Acts::MultiStepperError e);
0039
0040 }  // namespace Acts
0041
0042 // register with STL
0043 namespace std {
0044 template <>
0045 struct is_error_code_enum<Acts::MultiStepperError> : std::true_type {};
0046 }  // namespace std