art::WorkerInPath Class Reference

#include "WorkerInPath.h"

Public Types
enum	FilterAction { Normal = 0, Ignore, Veto }

Public Member Functions
	WorkerInPath (cet::exempt_ptr< Worker >)
	WorkerInPath (cet::exempt_ptr< Worker > worker, FilterAction theAction)
template<typename T >
bool	runWorker (typename T::MyPrincipal &, CurrentProcessingContext const *cpc)
void	clearCounters ()
std::size_t	timesVisited () const
std::size_t	timesPassed () const
std::size_t	timesFailed () const
std::size_t	timesExcept () const
FilterAction	filterAction () const
cet::exempt_ptr< Worker >	getWorker () const
std::string const &	label () const
bool	modifiesEvent () const

Private Types
using	Counts_t = ExecutionCounts< stats::Visited, stats::Passed, stats::Failed, stats::ExceptionThrown >

Private Attributes
Counts_t	counts_ {}
FilterAction	filterAction_ {Normal}
cet::exempt_ptr< Worker >	worker_

Detailed Description

Definition at line 23 of file WorkerInPath.h.

Member Typedef Documentation

using art::WorkerInPath::Counts_t = ExecutionCounts<stats::Visited, stats::Passed, stats::Failed, stats::ExceptionThrown>

private

Definition at line 87 of file WorkerInPath.h.

Member Enumeration Documentation

enum art::WorkerInPath::FilterAction

Enumerator
Normal
Ignore
Veto

Definition at line 25 of file WorkerInPath.h.

{ Normal = 0, Ignore, Veto };

Constructor & Destructor Documentation

WorkerInPath::WorkerInPath ( cet::exempt_ptr< Worker >  w )

explicit

Definition at line 17 of file WorkerInPath.cc.

: worker_{w} {}

WorkerInPath::WorkerInPath	(	cet::exempt_ptr< Worker >	worker,
		FilterAction	theAction
	)

Definition at line 12 of file WorkerInPath.cc.

References w, and worker_.

  : filterAction_{theFilterAction}, worker_{w}
{}

Member Function Documentation

void art::WorkerInPath::clearCounters ( )

inline

Definition at line 35 of file WorkerInPath.h.

References counts_.

    {
      counts_ = Counts_t{};
    }

FilterAction art::WorkerInPath::filterAction ( ) const

inline

Definition at line 62 of file WorkerInPath.h.

References filterAction_.

    {
      return filterAction_;
    }

cet::exempt_ptr<Worker> art::WorkerInPath::getWorker ( ) const

inline

Definition at line 67 of file WorkerInPath.h.

References worker_.

    {
      return worker_;
    }

std::string const& art::WorkerInPath::label ( ) const

inline

Definition at line 73 of file WorkerInPath.h.

References worker_.

    {
      return worker_->label();
    }

bool art::WorkerInPath::modifiesEvent ( ) const

inline

Definition at line 78 of file WorkerInPath.h.

References worker_.

    {
      return worker_->modifiesEvent();
    }

template<typename T >

bool art::WorkerInPath::runWorker	(	typename T::MyPrincipal &	ep,
		CurrentProcessingContext const *	cpc
	)

Definition at line 96 of file WorkerInPath.h.

References counts_, art::Event, filterAction_, Ignore, Veto, and worker_.

  {
    MaybeIncrementCounts<T::level, decltype(counts_)> counts{counts_};
    counts.template increment<stats::Visited>();

    bool rc{true};
    try {
      // may want to change the return value from the worker to be the
      // Worker::FilterAction so conditions in the path will be easier
      // to identify
      rc = worker_->doWork<T>(ep, cpc);
    }
    catch (...) {
      counts.template increment<stats::ExceptionThrown>();
      throw;
    }

    // Ignore return code for non-event (e.g. run, subRun) calls
    if (T::level == Level::Event && filterAction_ == Veto)
      rc = !rc;
    else if (T::level != Level::Event || filterAction_ == Ignore)
      rc = true;

    counts.update(rc);
    return rc;
  } // runWorker<>()

std::size_t art::WorkerInPath::timesExcept ( ) const

inline

Definition at line 56 of file WorkerInPath.h.

References counts_, and art::ExecutionCounts< ARGS >::times().

    {
      return counts_.times<stats::ExceptionThrown>();
    }

std::size_t art::WorkerInPath::timesFailed ( ) const

inline

Definition at line 51 of file WorkerInPath.h.

References counts_, and art::ExecutionCounts< ARGS >::times().

    {
      return counts_.times<stats::Failed>();
    }

std::size_t art::WorkerInPath::timesPassed ( ) const

inline

Definition at line 46 of file WorkerInPath.h.

References counts_, and art::ExecutionCounts< ARGS >::times().

    {
      return counts_.times<stats::Passed>();
    }

std::size_t art::WorkerInPath::timesVisited ( ) const

inline

Definition at line 41 of file WorkerInPath.h.

References counts_, and art::ExecutionCounts< ARGS >::times().

    {
      return counts_.times<stats::Visited>();
    }

Member Data Documentation

Counts_t art::WorkerInPath::counts_ {}

private

Definition at line 88 of file WorkerInPath.h.

Referenced by clearCounters(), runWorker(), timesExcept(), timesFailed(), timesPassed(), and timesVisited().

FilterAction art::WorkerInPath::filterAction_ {Normal}

private

Definition at line 90 of file WorkerInPath.h.

Referenced by filterAction(), and runWorker().

cet::exempt_ptr<Worker> art::WorkerInPath::worker_

private

Definition at line 91 of file WorkerInPath.h.

Referenced by getWorker(), label(), modifiesEvent(), runWorker(), and WorkerInPath().

---

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

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