DataProcessorMatchers.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 O2_FRAMEWORK_DATAPROCESSORMATCHER_H_
#define O2_FRAMEWORK_DATAPROCESSORMATCHER_H_
#include <functional>
 
namespace o2::framework
{
 
struct DataProcessorSpec;
struct DeviceSpec;
struct ConfigContext;
 
// A matcher for a given DataProcessorSpec @p spec.
using DataProcessorMatcher = std::function<bool(DataProcessorSpec const& spec)>;
// A matcher which is specific to a given DeviceSpec. @a context is the ConfigContext associated with the topology.
using DeviceMatcher = std::function<bool(DeviceSpec const& spec, ConfigContext const& context)>;
// A matcher which is specific to a given edge between two DataProcessors, described
// by @p source and @p dest. @p context is the ConfigContext associated with the topology.
// NOTE: we use DataProcessorSpecs rather than devices, because when we assign the policy
//       we do not have all the devices yet.
using EdgeMatcher = std::function<bool(DataProcessorSpec const& source, DataProcessorSpec const& dest, ConfigContext const& context)>;
 
struct DataProcessorMatchers {
  static DataProcessorMatcher matchByName(const char* name);
};
 
struct DeviceMatchers {
  static DeviceMatcher matchByName(const char* name);
};
 
struct EdgeMatchers {
  static EdgeMatcher matchSourceByName(const char* name);
  static EdgeMatcher matchDestByName(const char* name);
  static EdgeMatcher matchEndsByName(const char* sourceName, const char* destName);
};
 
} // namespace o2::framework
#endif // O2_FRAMEWORK_DATAPROCESSORMATCHER_H_