art::ModuleContext Class Reference

#include "ModuleContext.h"

Public Member Functions
	ModuleContext (PathContext const &pathContext, ModuleDescription const &md)
	ModuleContext (ModuleDescription const &md)
auto	scheduleID () const
auto const &	pathName () const
auto const &	moduleDescription () const
auto const &	moduleLabel () const
auto const &	moduleName () const
bool	onEndPath () const
bool	onTriggerPath () const
bool	onSamePathAs (std::string const &module_label) const

Static Public Member Functions
static ModuleContext	invalid ()

Private Member Functions
	ModuleContext ()=default

Private Attributes
PathContext	pathContext_ {PathContext::invalid()}
ModuleDescription	md_ {}

Detailed Description

Definition at line 8 of file ModuleContext.h.

Constructor & Destructor Documentation

art::ModuleContext::ModuleContext ( )

explicitprivatedefault

art::ModuleContext::ModuleContext ( PathContext const &  pathContext, ModuleDescription const &  md  )

inlineexplicit

Definition at line 12 of file ModuleContext.h.

References md_.

      : pathContext_{pathContext}, md_{md}
    {}

art::ModuleContext::ModuleContext ( ModuleDescription const &  md )

inlineexplicit

Definition at line 19 of file ModuleContext.h.

: md_{md} {}

Member Function Documentation

static ModuleContext art::ModuleContext::invalid ( )

inlinestatic

Definition at line 22 of file ModuleContext.h.

Referenced by art::TriggerPathsExecutor::process_event().

    {
      return ModuleContext{};
    }

auto const& art::ModuleContext::moduleDescription ( ) const

inline

Definition at line 38 of file ModuleContext.h.

References md_.

Referenced by rndm::NuRandomService::preModule(), rndm::NuRandomService::preModuleBeginRun(), and art::MemoryTracker::recordOtherData().

    {
      return md_;
    }

auto const& art::ModuleContext::moduleLabel ( ) const

inline

Definition at line 43 of file ModuleContext.h.

References md_, and art::ModuleDescription::moduleLabel().

Referenced by art::Tracer::postModuleBeginRun(), art::Tracer::postModuleBeginSubRun(), art::Tracer::postModuleEndRun(), art::Tracer::postModuleEndSubRun(), art::Tracer::postModuleEvent(), rndm::NuRandomService::preModule(), art::Tracer::preModuleBeginRun(), art::Tracer::preModuleBeginSubRun(), art::Tracer::preModuleEndRun(), art::Tracer::preModuleEndSubRun(), art::Tracer::preModuleEvent(), art::MemoryTracker::recordModuleData(), and art::TimeTracker::recordTime().

    {
      return md_.moduleLabel();
    }

auto const& art::ModuleContext::moduleName ( ) const

inline

Definition at line 48 of file ModuleContext.h.

References md_, and art::ModuleDescription::moduleName().

Referenced by art::MemoryTracker::recordModuleData(), and art::TimeTracker::recordTime().

    {
      return md_.moduleName();
    }

bool art::ModuleContext::onEndPath ( ) const

inline

Definition at line 53 of file ModuleContext.h.

References art::PathContext::end_path(), and pathName().

Referenced by art::Worker::runWorker().

    {
      return pathName() == PathContext::end_path();
    }

bool art::ModuleContext::onSamePathAs ( std::string const &  module_label ) const

inline

Definition at line 64 of file ModuleContext.h.

References art::PathContext::contains(), and pathContext_.

Referenced by art::Principal::findGroupsForProcess().

    {
      return pathContext_.contains(module_label);
    }

bool art::ModuleContext::onTriggerPath ( ) const

inline

Definition at line 58 of file ModuleContext.h.

References art::PathContext::art_path(), art::PathContext::end_path(), and pathName().

Referenced by art::Principal::findGroupsForProcess().

    {
      return pathName() != PathContext::end_path() &&
             pathName() != PathContext::art_path() && !pathName().empty();
    }

auto const& art::ModuleContext::pathName ( ) const

inline

Definition at line 33 of file ModuleContext.h.

References pathContext_, and art::PathContext::pathName().

Referenced by onEndPath(), onTriggerPath(), art::MemoryTracker::recordModuleData(), and art::TimeTracker::recordTime().

    {
      return pathContext_.pathName();
    }

auto art::ModuleContext::scheduleID ( ) const

inline

Definition at line 28 of file ModuleContext.h.

References pathContext_, and art::PathContext::scheduleID().

Referenced by art::detail::Producer::doBeginRun(), art::detail::Filter::doBeginRun(), art::detail::Analyzer::doBeginRun(), art::detail::Producer::doBeginSubRun(), art::detail::Filter::doBeginSubRun(), art::detail::Analyzer::doBeginSubRun(), art::detail::Producer::doEndRun(), art::detail::Filter::doEndRun(), art::detail::Analyzer::doEndRun(), art::detail::Producer::doEndSubRun(), art::detail::Filter::doEndSubRun(), art::detail::Analyzer::doEndSubRun(), art::detail::Producer::doEvent(), art::detail::Filter::doEvent(), art::detail::Analyzer::doEvent(), art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), art::Worker::isUnique(), art::Worker::runWorker(), and art::TimeTracker::startTime().

    {
      return pathContext_.scheduleID();
    }

Member Data Documentation

ModuleDescription art::ModuleContext::md_ {}

private

Definition at line 71 of file ModuleContext.h.

Referenced by ModuleContext(), moduleDescription(), moduleLabel(), and moduleName().

PathContext art::ModuleContext::pathContext_ {PathContext::invalid()}

private

Definition at line 70 of file ModuleContext.h.

Referenced by onSamePathAs(), pathName(), and scheduleID().

---

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

• art/Persistency/Provenance/ModuleContext.h