art::PathContext Class Reference

#include "PathContext.h"

Public Member Functions
	PathContext (ScheduleContext const &scheduleContext, PathSpec const &pathSpec, std::vector< std::string > sortedModuleNames)
auto	scheduleID () const
auto const &	pathSpec () const
auto const &	pathName () const
PathID	pathID () const noexcept
bool	contains (std::string const &module_label) const

Static Public Member Functions
static std::string	end_path ()
static auto	end_path_spec ()
static std::string	art_path ()
static auto	art_path_spec ()
static PathContext	invalid ()

Private Member Functions
	PathContext ()=default

Private Attributes
ScheduleContext	scheduleContext_ {ScheduleContext::invalid()}
PathSpec	pathSpec_ {"", PathID::invalid()}
std::vector< std::string >	sortedModuleLabels_ {}

Detailed Description

Definition at line 9 of file PathContext.h.

Constructor & Destructor Documentation

art::PathContext::PathContext ( )

explicitprivatedefault

art::PathContext::PathContext ( ScheduleContext const &  scheduleContext, PathSpec const &  pathSpec, std::vector< std::string >  sortedModuleNames  )

inlineexplicit

Definition at line 37 of file PathContext.h.

References pathSpec(), pathSpec_, and sortedModuleLabels_.

      : scheduleContext_{scheduleContext}
      , pathSpec_{pathSpec}
      , sortedModuleLabels_{std::move(sortedModuleNames)}
    {}

Member Function Documentation

static std::string art::PathContext::art_path ( )

inlinestatic

Definition at line 26 of file PathContext.h.

Referenced by art_path_spec(), and art::ModuleContext::onTriggerPath().

    {
      return "[art]";
    }

static auto art::PathContext::art_path_spec ( )

inlinestatic

Definition at line 32 of file PathContext.h.

References art_path(), and art::PathID::invalid().

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

    {
      return PathSpec{art_path(), PathID::invalid()};
    }

bool art::PathContext::contains ( std::string const &  module_label ) const

inline

Definition at line 74 of file PathContext.h.

References sortedModuleLabels_.

Referenced by art::ModuleContext::onSamePathAs().

    {
      return cet::binary_search_all(sortedModuleLabels_, module_label);
    }

static std::string art::PathContext::end_path ( )

inlinestatic

Definition at line 14 of file PathContext.h.

Referenced by end_path_spec(), art::PathManager::getModuleGraphInfoCollection_(), art::ModuleContext::onEndPath(), and art::ModuleContext::onTriggerPath().

    {
      return "end_path";
    }

static auto art::PathContext::end_path_spec ( )

inlinestatic

Definition at line 20 of file PathContext.h.

References end_path().

Referenced by art::PathManager::createModulesAndWorkers(), and art::EndPathExecutor::writeEvent().

    {
      return PathSpec{end_path(), PathID{0}};
    }

static PathContext art::PathContext::invalid ( )

inlinestatic

Definition at line 46 of file PathContext.h.

    {
      return PathContext{};
    }

PathID art::PathContext::pathID ( ) const

inlinenoexcept

Definition at line 68 of file PathContext.h.

References art::PathSpec::path_id, and pathSpec_.

Referenced by art::PathsInfo::add_path(), and art::PathManager::fillWorkers_().

    {
      return pathSpec_.path_id;
    }

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

inline

Definition at line 63 of file PathContext.h.

References art::PathSpec::name, and pathSpec_.

Referenced by art::PathsInfo::add_path(), art::ModuleContext::pathName(), art::Tracer::postPathEvent(), and art::Tracer::prePathEvent().

    {
      return pathSpec_.name;
    }

auto const& art::PathContext::pathSpec ( ) const

inline

Definition at line 57 of file PathContext.h.

References pathSpec_.

Referenced by PathContext().

    {
      return pathSpec_;
    }

auto art::PathContext::scheduleID ( ) const

inline

Definition at line 52 of file PathContext.h.

References art::ScheduleContext::id(), and scheduleContext_.

Referenced by art::PathsInfo::add_path(), art::PathManager::fillWorkers_(), and art::ModuleContext::scheduleID().

    {
      return scheduleContext_.id();
    }

Member Data Documentation

PathSpec art::PathContext::pathSpec_ {"", PathID::invalid()}

private

Definition at line 81 of file PathContext.h.

Referenced by PathContext(), pathID(), pathName(), and pathSpec().

ScheduleContext art::PathContext::scheduleContext_ {ScheduleContext::invalid()}

private

Definition at line 80 of file PathContext.h.

Referenced by scheduleID().

std::vector<std::string> art::PathContext::sortedModuleLabels_ {}

private

Definition at line 82 of file PathContext.h.

Referenced by contains(), and PathContext().

---

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

• art/Persistency/Provenance/PathContext.h