CorrectionCode.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef PATINTERFACES_CORRECTIONCODE_H
#define PATINTERFACES_CORRECTIONCODE_H
 
#include "CxxUtils/nodiscard.h"
 
namespace CP {

   class ATLAS_NODISCARD CorrectionCode {
 
   public:
      enum ErrorCode {
         Error = 0, 
         OutOfValidityRange = 1, 
         Ok = 2 
      };

      CorrectionCode( ErrorCode code = Ok ) noexcept : m_code( code ) { }

      ErrorCode code() const noexcept {return m_code;}

      operator ErrorCode() const noexcept { return code(); }

      bool operator < ( const CorrectionCode& rhs ) const noexcept {
         return m_code < rhs.m_code;
      }

      void ignore() const noexcept { }

      void setChecked() const noexcept { }
      static void enableFailure() noexcept {}
      static void disableFailure() noexcept {}
 
   private:
      ErrorCode m_code; 
 
   }; // class CorrectionCode
 
} // namespace CP
 
namespace asg
{
  template<typename T> struct CheckHelper;
 
  template<> struct CheckHelper<CP::CorrectionCode>
  {
    static inline bool isSuccess (const CP::CorrectionCode& sc) {
      return sc == CP::CorrectionCode::Ok; }

    static inline bool isOutOfValidityRange (const CP::CorrectionCode& sc) {
      return sc == CP::CorrectionCode::OutOfValidityRange; }

    static inline CP::CorrectionCode successCode () {
      return CP::CorrectionCode::Ok;}

    static inline CP::CorrectionCode failureCode () {
      return CP::CorrectionCode::Error;}
  };
}
 
#endif // not PATINTERFACES_CORRECTIONCODE_H