art::Observer Class Reference

#include <Observer.h>

Inheritance diagram for art::Observer:

Classes
struct	EOConfig

Public Member Functions
	~Observer () noexcept
	Observer (Observer const &)=delete
	Observer (Observer &&)=delete
Observer &	operator= (Observer const &)=delete
Observer &	operator= (Observer &&)=delete
void	registerProducts (ProductDescriptions &, ModuleDescription const &)
void	fillDescriptions (ModuleDescription const &)
fhicl::ParameterSetID	selectorConfig () const
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
std::string const &	processName () const
bool	wantAllEvents () const noexcept
bool	wantEvent (ScheduleID id, Event const &e) const
Handle< TriggerResults >	getTriggerResults (Event const &e) const
	Observer (fhicl::ParameterSet const &config)
	Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)
Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Private Attributes
bool	wantAllEvents_
std::string	process_name_
std::optional< detail::ProcessAndEventSelectors >	selectors_
std::optional< detail::ProcessAndEventSelectors >	rejectors_
fhicl::ParameterSetID	selector_config_id_

Detailed Description

Definition at line 20 of file Observer.h.

Constructor & Destructor Documentation

art::Observer::~Observer ( )

defaultnoexcept

art::Observer::Observer ( Observer const &  )

delete

art::Observer::Observer ( Observer &&  )

delete

art::Observer::Observer ( fhicl::ParameterSet const &  config )

explicitprotected

Definition at line 43 of file Observer.cc.

    : Observer{pset.get<vector<string>>("SelectEvents", {}),
               pset.get<vector<string>>("RejectEvents", {}),
               pset}
  {}

art::Observer::Observer ( std::vector< std::string > const &  select_paths, std::vector< std::string > const &  reject_paths, fhicl::ParameterSet const &  config  )

explicitprotected

Definition at line 49 of file Observer.cc.

    : wantAllEvents_{empty(select_paths) and empty(reject_paths)}
    , process_name_{Globals::instance()->processName()}
    , selectors_{make_selectors(select_paths, process_name_)}
    , rejectors_{make_selectors(reject_paths, process_name_)}
    , selector_config_id_{pset.id()}
  {}

Member Function Documentation

void art::Observer::fillDescriptions

(

ModuleDescription const &

)

Definition at line 64 of file Observer.cc.

  {}

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const &  e ) const

protected

Definition at line 92 of file Observer.cc.

  {
    if (selectors_) {
      return selectors_->getOneTriggerResults(e);
    }

    // The following applies for cases where no SelectEvents entries
    // exist.
    Handle<TriggerResults> h;
    if (e.get(empty_process_name, h)) {
      return h;
    }
    return Handle<TriggerResults>{};
  }

Observer& art::Observer::operator= ( Observer const &  )

delete

Observer& art::Observer::operator= ( Observer &&  )

delete

string const & art::Observer::processName ( ) const

protected

Definition at line 68 of file Observer.cc.

  {
    return process_name_;
  }

void art::Observer::registerProducts	(	ProductDescriptions &	,
		ModuleDescription const &
	)

Definition at line 60 of file Observer.cc.

  {}

fhicl::ParameterSetID art::Observer::selectorConfig

(

)

const

Definition at line 86 of file Observer.cc.

  {
    return selector_config_id_;
  }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexcept

Definition at line 37 of file Observer.h.

    {
      return wantAllEvents_;
    }

bool art::Observer::wantEvent ( ScheduleID  id, Event const &  e  ) const

protected

Definition at line 74 of file Observer.cc.

  {
    if (wantAllEvents_) {
      return true;
    }
    bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
    bool const reject_event =
      rejectors_ ? rejectors_->matchEvent(id, e) : false;
    return select_event and not reject_event;
  }

Member Data Documentation

std::string art::Observer::process_name_

private

Definition at line 83 of file Observer.h.

std::optional<detail::ProcessAndEventSelectors> art::Observer::rejectors_

private

Definition at line 87 of file Observer.h.

fhicl::ParameterSetID art::Observer::selector_config_id_

private

Definition at line 90 of file Observer.h.

std::optional<detail::ProcessAndEventSelectors> art::Observer::selectors_

private

Definition at line 86 of file Observer.h.

bool art::Observer::wantAllEvents_

private

Definition at line 82 of file Observer.h.

---

The documentation for this class was generated from the following files:

• art/art/Framework/Core/Observer.h
• art/art/Framework/Core/Observer.cc