AggregatorRunner.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_AGGREGATORRUNNER_H
#define QC_CHECKER_AGGREGATORRUNNER_H

// O2
#include <Framework/Task.h>
#include <Framework/DataProcessorSpec.h>
#include <Common/Timer.h>
// QC
#include "QualityControl/QualityObject.h"
#include "QualityControl/UpdatePolicyManager.h"

namespace o2::framework
{
struct InputSpec;
struct OutputSpec;
class DataAllocator;
} // namespace o2::framework

namespace o2::monitoring
{
class Monitoring;
}

namespace o2::configuration
{
class ConfigurationInterface;
}

namespace AliceO2::Common
{
class Timer;
}

namespace o2::quality_control
{
namespace core
{
class ServiceDiscovery;
}
namespace checker
{
class Aggregator;
}
namespace repository
{
class DatabaseInterface;
}
} // namespace o2::quality_control

class TClass;

namespace o2::quality_control::checker
{

class AggregatorRunner : public framework::Task
{
 public:

  AggregatorRunner(const std::string& configurationSource, const vector<framework::OutputSpec> checkRunnerOutputs);

  ~AggregatorRunner() override;

  void init(framework::InitContext& ctx) override;

  void run(framework::ProcessingContext& ctx) override;

  framework::Inputs getInputs() { return mInputs; };
  std::string getDeviceName() { return mDeviceName; };

  static std::string createAggregatorRunnerIdString() { return "QC-AGGREGATOR-RUNNER"; };
  static std::string createAggregatorRunnerName();
  static header::DataDescription createAggregatorRunnerDataDescription(const std::string& aggregatorName);

 private:
  core::QualityObjectsType aggregate();

  void store(core::QualityObjectsType& qualityObjects);

  inline void initDatabase();
  inline void initMonitoring();
  inline void initServiceDiscovery();
  inline void initAggregators();

  void sendPeriodicMonitoring();

  // General state
  std::string mDeviceName;
  std::map<std::string, std::shared_ptr<Aggregator>> mAggregatorsMap;
  std::shared_ptr<o2::quality_control::repository::DatabaseInterface> mDatabase;
  std::shared_ptr<o2::configuration::ConfigurationInterface> mConfigFile;
  core::QualityObjectsMapType mQualityObjects; // where we cache the incoming quality objects and the output of the aggregators
  UpdatePolicyManager updatePolicyManager;

  // DPL
  o2::framework::Inputs mInputs;

  // monitoring
  std::shared_ptr<o2::monitoring::Monitoring> mCollector;
  AliceO2::Common::Timer mTimer;
  int mTotalNumberObjectsReceived;
  int mTotalNumberAggregatorExecuted;
  int mTotalNumberObjectsProduced;

  // Service discovery
  std::shared_ptr<core::ServiceDiscovery> mServiceDiscovery;
};

} // namespace o2::quality_control::checker

#endif // QC_CHECKER_AGGREGATORRUNNER_H