EventObserverBase.h

Go to the documentation of this file.

#ifndef art_Framework_Core_EventObserverBase_h
#define art_Framework_Core_EventObserverBase_h

// Common base class for module which do not modify events, such as
// OutputModule and EDAnalyzer.

#include "art/Framework/Core/CachedProducts.h"
#include "canvas/Persistency/Provenance/BranchDescription.h"
#include "fhiclcpp/ParameterSet.h"
#include "fhiclcpp/ParameterSetID.h"
#include "fhiclcpp/types/OptionalTable.h"
#include "fhiclcpp/types/Sequence.h"

#include <string>

namespace art {
  class EventObserverBase;
  class MasterProductRegistry;
  class ModuleDescription;
}

class art::EventObserverBase {
public:
  bool
  modifiesEvent() const
  {
    return false;
  }

  // FIXME: One could obviate the need for this trivial implementation
  // by putting some type logic in WorkerT.
  void
  registerProducts(MasterProductRegistry&,
                   ProductDescriptions&,
                   ModuleDescription const&)
  {}
  //
  // SelectEvents handling
  //
  std::string const&
  processName() const
  {
    return process_name_;
  }
  bool
  wantAllEvents() const
  {
    return wantAllEvents_;
  }
  bool
  wantEvent(Event const& e)
  {
    return selectors_.wantEvent(e);
  }
  fhicl::ParameterSetID
  selectorConfig() const
  {
    return selector_config_id_;
  }
  art::Handle<art::TriggerResults>
  getTriggerResults(Event const& e) const
  {
    return selectors_.getOneTriggerResults(e);
  }

protected:
  struct EOConfig {
    fhicl::Sequence<std::string> selectEvents{
      fhicl::Name("SelectEvents"),
      fhicl::Comment("The following parameter is a user-provided list\n"
                     "of filter paths. The default list is empty."),
      std::vector<std::string>{}};
  };

  explicit EventObserverBase(std::vector<std::string> const& paths,
                             fhicl::ParameterSet const& config);
  explicit EventObserverBase(fhicl::ParameterSet const& config);
  detail::CachedProducts&
  cachedProducts()
  {
    return selectors_;
  }

private:
  // True if no selectors configured.
  bool wantAllEvents_{false};
  // The process and event selectors, as specified by the SelectEvents
  // configuration parameter.
  detail::CachedProducts selectors_{};
  std::string process_name_{};
  // ID of the ParameterSet that configured the event selector
  // subsystem.
  fhicl::ParameterSetID selector_config_id_;

  void init_(std::vector<std::string> const& paths);
};

#endif /* art_Framework_Core_EventObserverBase_h */

// Local Variables:
// mode: c++
// End: