Quality.h

Go to the documentation of this file.

// Copyright CERN and copyright holders of ALICE O2. This software is
// distributed under the terms of the GNU General Public License v3 (GPL
// Version 3), copied verbatim in the file "COPYING".
//
// See http://alice-o2.web.cern.ch/license for full licensing information.
//
// 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 QC_CORE_QUALITY_H
#define QC_CORE_QUALITY_H

#include <Rtypes.h>
#include <string>
#include <map>

namespace o2::quality_control::core
{

class Quality
{
 public:
  Quality(unsigned int level = Quality::NullLevel, std::string name = "");
  virtual ~Quality() = default;
  // Copy constructor
  Quality(const Quality& q);

  Quality(Quality&& other) /*noexcept*/ = default;
  Quality& operator=(const Quality& other) = default;
  Quality& operator=(Quality&& other) /*noexcept*/ = default;

  unsigned int getLevel() const;
  const std::string& getName() const;

  static const Quality Null;
  static const Quality Good;
  static const Quality Medium;
  static const Quality Bad;
  static const unsigned int NullLevel;

  friend bool operator==(const Quality& lhs, const Quality& rhs)
  {
    return (lhs.getName() == rhs.getName() && lhs.getLevel() == rhs.getLevel());
  }
  friend bool operator!=(const Quality& lhs, const Quality& rhs) { return !operator==(lhs, rhs); }
  friend std::ostream& operator<<(std::ostream& out, const Quality& q); // output

  bool isWorseThan(const Quality& quality) const { return this->mLevel > quality.getLevel(); }
  bool isBetterThan(const Quality& quality) const { return this->mLevel < quality.getLevel(); }

  void addMetadata(std::string key, std::string value);
  void addMetadata(std::map<std::string, std::string> pairs);
  void updateMetadata(std::string key, std::string value);
  const std::map<std::string, std::string>& getMetadataMap() const;
  void overwriteMetadata(std::map<std::string, std::string> pairs);
  const std::string getMetadata(std::string key);

 private:
  unsigned int mLevel; 
  std::string mName;
  std::map<std::string, std::string> mUserMetadata;

  ClassDef(Quality, 2);
};

} // namespace o2::quality_control::core

#endif // QC_CORE_QUALITY_H