CheckInterface.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_CHECKER_CHECKINTERFACE_H
#define QC_CHECKER_CHECKINTERFACE_H

#include <unordered_map>

#include "QualityControl/MonitorObject.h"
#include "QualityControl/Quality.h"

using namespace o2::quality_control::core;

namespace o2::quality_control::checker
{

class CheckInterface
{
 public:
  CheckInterface() = default;
  virtual ~CheckInterface() = default;

  virtual void configure(std::string name) = 0;

  virtual Quality check(std::map<std::string, std::shared_ptr<MonitorObject>>* moMap) = 0;

  virtual void beautify(std::shared_ptr<MonitorObject> mo, Quality checkResult = Quality::Null) = 0;

  virtual std::string getAcceptedType();

  bool isObjectCheckable(const std::shared_ptr<MonitorObject> mo);
  bool isObjectCheckable(const MonitorObject* mo);

  void setCustomParameters(const std::unordered_map<std::string, std::string>& parameters);

 protected:
  std::unordered_map<std::string, std::string> mCustomParameters;

  ClassDef(CheckInterface, 2)
};

} // namespace o2::quality_control::checker

#endif /* QC_CHECKER_CHECKINTERFACE_H */