Check.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_CHECKER_CHECK_H
#define QC_CHECKER_CHECK_H

// std
#include <functional>
#include <map>
#include <vector>
#include <memory>
#include <unordered_map>
// O2
#include <Framework/DataProcessorSpec.h>
// QC
#include "QualityControl/Quality.h"
#include "QualityControl/QualityObject.h"
#include "QualityControl/MonitorObject.h"
#include "QualityControl/CheckInterface.h"
#include "QualityControl/QcInfoLogger.h"
#include "QualityControl/CheckConfig.h"

namespace o2::quality_control::checker
{

class Check
{
 public:

  Check(std::string checkName, std::string configurationSource);

  void init();

  QualityObjectsType check(std::map<std::string, std::shared_ptr<o2::quality_control::core::MonitorObject>>& moMap);

  void updateRevision(unsigned int revision);

  const std::string& getName() const { return mCheckConfig.name; };
  o2::framework::OutputSpec getOutputSpec() const { return mOutputSpec; };
  o2::framework::Inputs getInputs() const { return mInputs; };

  //TODO: Unique Input string
  static o2::header::DataDescription createCheckerDataDescription(const std::string taskName);

  // For testing purpose
  void setCheckInterface(CheckInterface* checkInterface) { mCheckInterface = checkInterface; };

  std::string getPolicyName() const;
  std::vector<std::string> getObjectsNames() const;
  bool getAllObjectsOption() const;

 private:
  void initConfig(std::string checkName);

  void beautify(std::map<std::string, std::shared_ptr<MonitorObject>>& moMap, Quality quality);

  std::string mConfigurationSource;
  o2::quality_control::core::QcInfoLogger& mLogger;
  CheckConfig mCheckConfig;
  CheckInterface* mCheckInterface = nullptr;
  size_t mNumberOfTaskSources;

  // DPL information
  o2::framework::Inputs mInputs;
  std::vector<std::string> mInputsStringified;
  o2::framework::OutputSpec mOutputSpec;

  bool mBeautify = true;
};

} // namespace o2::quality_control::checker

#endif