ActsFatras/Digitization/DigitizationError.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 ActsFatras {
0015
0016 /// Error codes for digitization operations
0017 /// @ingroup errors
0018 enum class DigitizationError {
0019   // ensure all values are non-zero
0020   /// Smeared out of surface bounds.
0021   SmearingOutOfRange = 1,
0022   /// Smearing error occurred.
0023   SmearingError,
0024   /// Surface undefined for this operation.
0025   UndefinedSurface,
0026   /// Surface mask could not be applied.
0027   MaskingError,
0028   /// Drift error
0029   DriftError,
0030   /// Maximum number of retries exceeded.
0031   MaximumRetriesExceeded,
0032 };
0033
0034 /// Create error code from DigitizationError
0035 /// @param e Digitization error enum value
0036 /// @return Error code corresponding to the error
0037 std::error_code make_error_code(DigitizationError e);
0038
0039 }  // namespace ActsFatras
0040
0041 namespace std {
0042 // register with STL
0043 template <>
0044 struct is_error_code_enum<ActsFatras::DigitizationError> : std::true_type {};
0045 }  // namespace std