QualityObject.h

// 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_QUALITYOBJECT_H
#define QC_CORE_QUALITYOBJECT_H

// std
#include <map>
// ROOT
#include <TObject.h>
// O2
#include <Common/Exceptions.h>
// QC
#include "QualityControl/Quality.h"

namespace o2::quality_control::core
{

class QualityObject : public TObject
{
 public:
  QualityObject();

  QualityObject(
    Quality quality,
    std::string checkName,
    std::string detectorName = "DET",
    std::string policyName = "",
    std::vector<std::string> inputs = {},
    std::vector<std::string> monitorObjectsNames = {},
    std::map<std::string, std::string> metadata = {});

  ~QualityObject() override;

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

  friend std::ostream& operator<<(std::ostream& out, const QualityObject& q); // output

  std::string getName() const;

  const char* GetName() const override;

  void updateQuality(Quality quality);
  Quality getQuality() const;

  void setInputs(std::vector<std::string> inputs) { mInputs = inputs; }
  std::vector<std::string> getInputs() const { return mInputs; }

  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;
  const std::string getMetadata(std::string key);

  std::string getPath() const;

  const std::string& getDetectorName() const;
  void setDetectorName(const std::string& detectorName);

  void setQuality(const Quality& quality);
  const std::string& getCheckName() const;

  const std::string& getPolicyName() const;

  const std::vector<std::string> getMonitorObjectsNames() const;

 private:
  Quality mQuality;
  std::string mCheckName;
  std::string mDetectorName;
  std::string mPolicyName;
  std::vector<std::string> mInputs;
  std::vector<std::string> mMonitorObjectsNames;

  ClassDefOverride(QualityObject, 3);
};

using QualityObjectsType = std::vector<std::shared_ptr<QualityObject>>;
using QualityObjectsMapType = std::map<std::string, std::shared_ptr<const QualityObject>>;

} // namespace o2::quality_control::core

#endif