Error.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#ifndef O2_MCH_BASE_ERROR_H
#define O2_MCH_BASE_ERROR_H
 
#include <cstdint>
#include <map>
#include <string>
 
#include <Rtypes.h>
 
namespace o2::mch
{
 
enum class ErrorGroup : uint8_t {
  Unassigned,
  Decoding,
  Filtering,
  TimeClustering,
  PreClustering,
  Clustering,
  Tracking
};
 
namespace internal
{
constexpr uint32_t buildTypeGID(ErrorGroup group, uint32_t id) { return (static_cast<uint32_t>(group) << 24) + id; }
} // namespace internal
 
enum class ErrorType : uint32_t {
  PreClustering_MultipleDigitsInSamePad = internal::buildTypeGID(ErrorGroup::PreClustering, 0),
  PreClustering_LostDigit = internal::buildTypeGID(ErrorGroup::PreClustering, 1),
  Clustering_TooManyLocalMaxima = internal::buildTypeGID(ErrorGroup::Clustering, 0),
  Tracking_TooManyCandidates = internal::buildTypeGID(ErrorGroup::Tracking, 0),
  Tracking_TooLong = internal::buildTypeGID(ErrorGroup::Tracking, 1)
};
 
constexpr ErrorGroup errorGroup(ErrorType error) { return static_cast<ErrorGroup>(static_cast<uint32_t>(error) >> 24); }
 
struct Error {
  static const std::map<ErrorGroup, std::string> groupNames;      
  static const std::map<ErrorType, std::string> typeNames;        
  static const std::map<ErrorType, std::string> typeDescriptions; 
 
  ErrorType type{0};  
  uint32_t id0 = 0;   
  uint32_t id1 = 0;   
  uint64_t count = 0; 
 
  static const std::map<ErrorType, std::string> getTypeNames(ErrorGroup group);
 
  ErrorGroup getGroup() const { return o2::mch::errorGroup(type); }
  std::string getGroupName() const;
  std::string getTypeName() const;
  std::string getTypeDescription() const;
  std::string asString() const;
 
  ClassDefNV(Error, 1)
};
 
} // namespace o2::mch
 
#endif // O2_MCH_BASE_ERROR_H