DataFormats/Common/interface/ELseverityLevel.h - master - githubmirror/cmssw

DataFormats/Common/interface/ELseverityLevel.h
125 строк5 KB
Shahzad Malik Muzaffar
[CORE] Changes suggested by new llvm18 clang-format
05 сен 2024, 17:11
05 сен 2024, 17:11c249daf
#ifndef DataFormats_Common_ELseverityLevel_h
#define DataFormats_Common_ELseverityLevel_h

// ----------------------------------------------------------------------
//
// ELseverityLevel.h - declare objects that encode a message's urgency
//
//	Both frameworker and user will often pass one of the
//	instantiated severity levels to logger methods.
//
//	The only other methods of ELseverityLevel a frameworker
//	might use is to check the relative level of two severities
//	using operator< or the like.
//
// ----------------------------------------------------------------------

#include <string_view>
#include <cassert>

namespace edm {

  // ----------------------------------------------------------------------
  // ELseverityLevel:
  // ----------------------------------------------------------------------

  class ELseverityLevel {
  public:
    // ---  One ELseverityLevel is globally instantiated (see below)
    // ---  for each of the following levels:
    //
    enum ELsev_ {
      ELsev_noValueAssigned = 0,  // default returned by map when not found
      ELsev_zeroSeverity,         // threshold use only
      ELsev_success,              // report reaching a milestone
      ELsev_info,                 // information
      ELsev_fwkInfo,              // framework
      ELsev_warning,              // warning
      ELsev_error,                // error detected
      ELsev_unspecified,          // severity was not specified
      ELsev_severe,               // future results are suspect
      ELsev_highestSeverity,      // threshold use only
      // -----
      nLevels  // how many levels?
    };  // ELsev_

    // -----  Birth/death:
    //
    constexpr ELseverityLevel(ELsev_ lev = ELsev_unspecified) noexcept : myLevel(lev) {}
    constexpr ELseverityLevel(int lev) noexcept : myLevel(lev) {
      assert(lev >= ELsev_noValueAssigned);
      assert(lev < nLevels);
    }
    ~ELseverityLevel() noexcept = default;
    constexpr ELseverityLevel(const ELseverityLevel&) noexcept = default;
    constexpr ELseverityLevel(ELseverityLevel&&) noexcept = default;
    constexpr ELseverityLevel& operator=(const ELseverityLevel&) noexcept = default;
    constexpr ELseverityLevel& operator=(ELseverityLevel&&) noexcept = default;

    // -----  Comparator:
    //
    [[nodiscard]] constexpr int cmp(ELseverityLevel const& e) const noexcept { return myLevel - e.myLevel; }

    // -----  Accessors:
    //
    constexpr int getLevel() const noexcept { return myLevel; }
    std::string_view getName() const noexcept;

  private:
    // Data per ELseverityLevel object:
    //
    int myLevel;

  };  // ELseverityLevel

  // ----------------------------------------------------------------------
  // Declare the globally available severity objects,
  // one generator function and one proxy per non-default ELsev_:
  // ----------------------------------------------------------------------

  constexpr const ELseverityLevel ELzeroSeverity{ELseverityLevel::ELsev_zeroSeverity};

  constexpr const ELseverityLevel ELdebug{ELseverityLevel::ELsev_success};

  constexpr const ELseverityLevel ELinfo{ELseverityLevel::ELsev_info};

  constexpr const ELseverityLevel ELfwkInfo{ELseverityLevel::ELsev_fwkInfo};

  constexpr const ELseverityLevel ELwarning{ELseverityLevel::ELsev_warning};

  constexpr const ELseverityLevel ELerror{ELseverityLevel::ELsev_error};

  constexpr const ELseverityLevel ELunspecified{ELseverityLevel::ELsev_unspecified};

  constexpr const ELseverityLevel ELsevere{ELseverityLevel::ELsev_severe};

  constexpr const ELseverityLevel ELhighestSeverity{ELseverityLevel::ELsev_highestSeverity};

  // ----------------------------------------------------------------------
  // Comparators:
  // ----------------------------------------------------------------------

  constexpr inline bool operator==(ELseverityLevel const& e1, ELseverityLevel const& e2) noexcept {
    return e1.cmp(e2) == 0;
  }
  constexpr inline bool operator!=(ELseverityLevel const& e1, ELseverityLevel const& e2) noexcept {
    return e1.cmp(e2) != 0;
  }
  constexpr inline bool operator<(ELseverityLevel const& e1, ELseverityLevel const& e2) noexcept {
    return e1.cmp(e2) < 0;
  }
  constexpr inline bool operator<=(ELseverityLevel const& e1, ELseverityLevel const& e2) noexcept {
    return e1.cmp(e2) <= 0;
  }
  constexpr inline bool operator>(ELseverityLevel const& e1, ELseverityLevel const& e2) noexcept {
    return e1.cmp(e2) > 0;
  }
  constexpr inline bool operator>=(ELseverityLevel const& e1, ELseverityLevel const& e2) noexcept {
    return e1.cmp(e2) >= 0;
  }

  // ----------------------------------------------------------------------

}  // end of namespace edm

#endif  // DataFormats_Common_ELseverityLevel_h