DataSampling.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// 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 FRAMEWORK_DATASAMPLING_H
#define FRAMEWORK_DATASAMPLING_H
 
 
#include "Framework/WorkflowSpec.h"
#include "Framework/InputSpec.h"
#include <string>
#include <boost/property_tree/ptree_fwd.hpp>
#include <optional>
 
namespace o2::configuration
{
class ConfigurationInterface;
}
 
namespace o2::framework
{
class CompletionPolicy;
class ChannelConfigurationPolicy;
} // namespace o2::framework
 
namespace o2::utilities
{
 
class Dispatcher;
 
 
class DataSampling
{
 public:
  DataSampling() = delete;
  static void GenerateInfrastructure(framework::WorkflowSpec& workflow, const std::string& policiesSource, size_t threads = 1, const std::string& host = "");
 
  static void GenerateInfrastructure(framework::WorkflowSpec& workflow, boost::property_tree::ptree const& policies, size_t threads = 1, const std::string& host = "");
  static void CustomizeInfrastructure(std::vector<framework::CompletionPolicy>&);
  static void CustomizeInfrastructure(std::vector<framework::ChannelConfigurationPolicy>&);
  static std::vector<framework::InputSpec> InputSpecsForPolicy(const boost::property_tree::ptree& policiesTree, const std::string& policyName);
  static std::vector<framework::OutputSpec> OutputSpecsForPolicy(const boost::property_tree::ptree& policiesTree, const std::string& policyName);
  static std::optional<uint16_t> PortForPolicy(const boost::property_tree::ptree& policiesTree, const std::string& policyName);
  static std::vector<std::string> MachinesForPolicy(const boost::property_tree::ptree& policiesTree, const std::string& policyName);
  static std::string BindLocationForPolicy(const boost::property_tree::ptree& policiesTree, const std::string& policyName);
 
 private:
  static void DoGenerateInfrastructure(Dispatcher&, framework::WorkflowSpec& workflow, boost::property_tree::ptree const& policies, size_t threads = 1, const std::string& host = "");
  // Internal functions, used by GenerateInfrastructure()
  static std::string createDispatcherName();
};
 
} // namespace o2::utilities
 
#endif // FRAMEWORK_DATASAMPLING_H