edm::ModuleCallingContext Class Reference

#include <ModuleCallingContext.h>

Public Types
enum	State { State::kPrefetching, State::kRunning, State::kInvalid }
typedef ParentContext::Type	Type

Public Member Functions
unsigned	depth () const
GlobalContext const *	getGlobalContext () const
StreamContext const *	getStreamContext () const
ModuleCallingContext const *	getTopModuleCallingContext () const
GlobalContext const *	globalContext () const
InternalContext const *	internalContext () const
	ModuleCallingContext (ModuleDescription const *moduleDescription)
	ModuleCallingContext (ModuleDescription const *moduleDescription, State state, ParentContext const &parent, ModuleCallingContext const *previousOnThread)
ModuleCallingContext const *	moduleCallingContext () const
ModuleDescription const *	moduleDescription () const
ParentContext const &	parent () const
PlaceInPathContext const *	placeInPathContext () const
ModuleCallingContext const *	previousModuleOnThread () const
void	setContext (State state, ParentContext const &parent, ModuleCallingContext const *previousOnThread)
void	setState (State state)
State	state () const
StreamContext const *	streamContext () const
Type	type () const

Private Attributes
ModuleDescription const *	moduleDescription_
ParentContext	parent_
ModuleCallingContext const *	previousModuleOnThread_
State	state_

Detailed Description

Description: This is intended primarily to be passed to Services as an argument to their callback functions.

Usage:

Definition at line 30 of file ModuleCallingContext.h.

Member Typedef Documentation

typedef ParentContext::Type edm::ModuleCallingContext::Type

Definition at line 33 of file ModuleCallingContext.h.

Member Enumeration Documentation

enum edm::ModuleCallingContext::State

strong

Enumerator
kPrefetching
kRunning
kInvalid

Definition at line 35 of file ModuleCallingContext.h.

                     {
      kPrefetching,  // prefetching products before starting to run
      kRunning,      // module actually running
      kInvalid
    };

Constructor & Destructor Documentation

edm::ModuleCallingContext::ModuleCallingContext

(

ModuleDescription const *

moduleDescription

)

Definition at line 12 of file ModuleCallingContext.cc.

                                                                                       :
    previousModuleOnThread_(nullptr),
    moduleDescription_(moduleDescription),
    parent_(),
    state_(State::kInvalid) {
  }

edm::ModuleCallingContext::ModuleCallingContext	(	ModuleDescription const *	moduleDescription,
		State	state,
		ParentContext const &	parent,
		ModuleCallingContext const *	previousOnThread
	)

Definition at line 19 of file ModuleCallingContext.cc.

                                                                                           :
    previousModuleOnThread_(previousOnThread),
    moduleDescription_(moduleDescription),
    parent_(parent),
    state_(state) {
  }

Member Function Documentation

unsigned edm::ModuleCallingContext::depth

(

void

)

const

Definition at line 74 of file ModuleCallingContext.cc.

References internalContext(), edm::ParentContext::kInternal, edm::ParentContext::kModule, edm::InternalContext::moduleCallingContext(), moduleCallingContext(), and type().

Referenced by internalContext(), edm::service::Tracer::postEventReadFromSource(), edm::service::Tracer::postModuleEvent(), edm::service::Tracer::postModuleEventDelayedGet(), edm::service::Tracer::postModuleEventPrefetching(), edm::service::Tracer::postModuleGlobalBeginLumi(), edm::service::Tracer::postModuleGlobalBeginRun(), edm::service::Tracer::postModuleGlobalEndLumi(), edm::service::Tracer::postModuleGlobalEndRun(), edm::service::Tracer::postModuleStreamBeginLumi(), edm::service::Tracer::postModuleStreamBeginRun(), edm::service::Tracer::postModuleStreamEndLumi(), edm::service::Tracer::postModuleStreamEndRun(), edm::service::Tracer::preEventReadFromSource(), edm::service::Tracer::preModuleEvent(), edm::service::Tracer::preModuleEventDelayedGet(), edm::service::Tracer::preModuleEventPrefetching(), edm::service::Tracer::preModuleGlobalBeginLumi(), edm::service::Tracer::preModuleGlobalBeginRun(), edm::service::Tracer::preModuleGlobalEndLumi(), edm::service::Tracer::preModuleGlobalEndRun(), edm::service::Tracer::preModuleStreamBeginLumi(), edm::service::Tracer::preModuleStreamBeginRun(), edm::service::Tracer::preModuleStreamEndLumi(), and edm::service::Tracer::preModuleStreamEndRun().

                                    {
    unsigned depth = 0;
    ModuleCallingContext const* mcc = this;
    while(mcc->type() == ParentContext::Type::kModule) {
      ++depth;
      mcc = mcc->moduleCallingContext();
    }
    if(mcc->type() == ParentContext::Type::kInternal) {
      ++depth;
      mcc = mcc->internalContext()->moduleCallingContext();
    }
    while(mcc->type() == ParentContext::Type::kModule) {
      ++depth;
      mcc = mcc->moduleCallingContext();
    }
    return depth;
  }

GlobalContext const * edm::ModuleCallingContext::getGlobalContext

(

)

const

Definition at line 49 of file ModuleCallingContext.cc.

References Exception, getTopModuleCallingContext(), globalContext(), edm::ParentContext::kGlobal, edm::errors::LogicError, and type().

Referenced by internalContext().

                                               {
    ModuleCallingContext const* mcc = getTopModuleCallingContext();
    if (mcc->type() != ParentContext::Type::kGlobal) {
      throw Exception(errors::LogicError)
        << "ModuleCallingContext::getGlobalContext() called in context not linked to a GlobalContext\n";
    }
    return mcc->globalContext();
  }

StreamContext const * edm::ModuleCallingContext::getStreamContext

(

)

const

Definition at line 37 of file ModuleCallingContext.cc.

References Exception, getTopModuleCallingContext(), edm::ParentContext::kPlaceInPath, edm::ParentContext::kStream, edm::errors::LogicError, edm::PlaceInPathContext::pathContext(), placeInPathContext(), edm::PathContext::streamContext(), streamContext(), and type().

Referenced by edm::EventSignalsSentry::EventSignalsSentry(), edm::DelayedReader::getProduct(), internalContext(), edm::Worker::prefetchAsync(), edm::UnscheduledProductResolver::prefetchAsync_(), edm::ReducedProvenanceReader::ReducedProvenanceReader(), edm::InputProductResolver::resolveProduct_(), edm::UnscheduledProductResolver::resolveProduct_(), and edm::EventSignalsSentry::~EventSignalsSentry().

                                               {
    ModuleCallingContext const* mcc = getTopModuleCallingContext();
    if(mcc->type() == ParentContext::Type::kPlaceInPath) {
      return mcc->placeInPathContext()->pathContext()->streamContext();
    } else if (mcc->type() != ParentContext::Type::kStream) {
      throw Exception(errors::LogicError)
        << "ModuleCallingContext::getStreamContext() called in context not linked to a StreamContext\n";
    }
    return mcc->streamContext();
  }

ModuleCallingContext const * edm::ModuleCallingContext::getTopModuleCallingContext

(

)

const

Definition at line 59 of file ModuleCallingContext.cc.

References internalContext(), edm::ParentContext::kInternal, edm::ParentContext::kModule, edm::InternalContext::moduleCallingContext(), moduleCallingContext(), and type().

Referenced by getGlobalContext(), getStreamContext(), internalContext(), edm::service::MessageLogger::MessageLogger(), and edm::Worker::shouldRethrowException().

                                                         {
    ModuleCallingContext const* mcc = this;
    while(mcc->type() == ParentContext::Type::kModule) {
      mcc = mcc->moduleCallingContext();
    }
    if(mcc->type() == ParentContext::Type::kInternal) {
      mcc = mcc->internalContext()->moduleCallingContext();
    }
    while(mcc->type() == ParentContext::Type::kModule) {
      mcc = mcc->moduleCallingContext();
    }
    return mcc;
  }

GlobalContext const* edm::ModuleCallingContext::globalContext ( ) const

inline

Definition at line 61 of file ModuleCallingContext.h.

References edm::ParentContext::globalContext(), and parent_.

Referenced by edm::Worker::exceptionContext(), and getGlobalContext().

{ return parent_.globalContext(); }

InternalContext const* edm::ModuleCallingContext::internalContext ( ) const

inline

Definition at line 62 of file ModuleCallingContext.h.

References depth(), getGlobalContext(), getStreamContext(), getTopModuleCallingContext(), edm::ParentContext::internalContext(), and parent_.

Referenced by depth(), edm::Worker::exceptionContext(), and getTopModuleCallingContext().

{ return parent_.internalContext(); }

ModuleCallingContext const* edm::ModuleCallingContext::moduleCallingContext ( ) const

inline

Definition at line 58 of file ModuleCallingContext.h.

References edm::ParentContext::moduleCallingContext(), and parent_.

Referenced by depth(), edm::Worker::exceptionContext(), getTopModuleCallingContext(), and edm::operator<<().

{ return parent_.moduleCallingContext(); }

ModuleDescription const* edm::ModuleCallingContext::moduleDescription ( ) const

inline

Definition at line 54 of file ModuleCallingContext.h.

References moduleDescription_.

Referenced by DQMEDAnalyzer::beginRun(), DQMEDAnalyzer::endLuminosityBlockSummary(), DQMEDAnalyzer::endRunSummary(), edm::Worker::exceptionContext(), edm::service::RandomNumberGeneratorService::getEngine(), edm::service::MessageLogger::MessageLogger(), edm::service::RandomNumberGeneratorService::mySeed(), edm::operator<<(), edm::SystemTimeKeeper::pauseModuleEvent(), edm::service::Tracer::postEventReadFromSource(), edm::service::SimpleMemoryCheck::postModule(), edm::service::Tracer::postModuleBeginStream(), edm::service::MessageLogger::postModuleBeginStream(), edm::service::Tracer::postModuleEndStream(), edm::service::MessageLogger::postModuleEndStream(), FWPathsPopup::postModuleEvent(), edm::service::Timing::postModuleEvent(), TFileService::postModuleEvent(), edm::service::Tracer::postModuleEvent(), FastTimerService::postModuleEvent(), edm::service::Tracer::postModuleEventDelayedGet(), edm::service::Tracer::postModuleEventPrefetching(), TFileService::postModuleGlobal(), edm::service::Tracer::postModuleGlobalBeginLumi(), edm::service::Tracer::postModuleGlobalBeginRun(), edm::service::Tracer::postModuleGlobalEndLumi(), edm::service::Tracer::postModuleGlobalEndRun(), edm::service::Tracer::postModuleStreamBeginLumi(), edm::service::Tracer::postModuleStreamBeginRun(), edm::service::RandomNumberGeneratorService::postModuleStreamCheck(), edm::service::Tracer::postModuleStreamEndLumi(), edm::service::Tracer::postModuleStreamEndRun(), edm::service::Tracer::preEventReadFromSource(), VariableHelperService::preModule(), edm::service::SimpleMemoryCheck::preModule(), edm::service::Tracer::preModuleBeginStream(), edm::service::MessageLogger::preModuleBeginStream(), edm::service::Tracer::preModuleEndStream(), edm::service::MessageLogger::preModuleEndStream(), FWPathsPopup::preModuleEvent(), TFileService::preModuleEvent(), edm::service::Tracer::preModuleEvent(), evf::FastMonitoringService::preModuleEvent(), edm::service::Tracer::preModuleEventDelayedGet(), edm::service::Tracer::preModuleEventPrefetching(), TFileService::preModuleGlobal(), edm::service::Tracer::preModuleGlobalBeginLumi(), edm::service::Tracer::preModuleGlobalBeginRun(), edm::service::Tracer::preModuleGlobalEndLumi(), edm::service::Tracer::preModuleGlobalEndRun(), edm::service::Tracer::preModuleStreamBeginLumi(), edm::service::Tracer::preModuleStreamBeginRun(), edm::service::RandomNumberGeneratorService::preModuleStreamCheck(), edm::service::Tracer::preModuleStreamEndLumi(), edm::service::Tracer::preModuleStreamEndRun(), edm::SystemTimeKeeper::restartModuleEvent(), edm::SystemTimeKeeper::startModuleEvent(), edm::SystemTimeKeeper::stopModuleEvent(), and edm::service::ConcurrentModuleTimer::trackModule().

{ return moduleDescription_; }

ParentContext const& edm::ModuleCallingContext::parent ( void  ) const

inline

Definition at line 57 of file ModuleCallingContext.h.

References parent_.

Referenced by Vispa.Gui.ConnectableWidget.ConnectableWidget::addMenuEntry(), Vispa.Views.LineDecayView.LineDecayContainer::applyFilter(), Vispa.Views.BoxDecayView.BoxDecayContainer::arrangeUsingRelations(), Vispa.Views.BoxDecayView.BoxDecayContainer::autolayoutAlgorithm(), Vispa.Gui.ZoomableScrollableWidgetOwner.ZoomableScrollableWidgetOwner::autosizeScrollArea(), Vispa.Views.BoxDecayView.BoxDecayContainer::autosizeScrollArea(), Vispa.Gui.PortWidget.PortWidget::connectionPoint(), Vispa.Main.StartupScreen.StartupScreen::createDescriptionWidget(), Vispa.Views.BoxDecayView.BoxDecayContainer::dataAccessor(), Vispa.Views.LineDecayView.LineDecayContainer::dataAccessor(), Vispa.Views.LineDecayView.LineDecayContainer::delete(), Vispa.Gui.VispaWidget.VispaWidget::delete(), Vispa.Gui.VispaWidget.VispaWidget::dragWidget(), Vispa.Share.ImageExporter.ImageExporter::exportImageDialog(), Vispa.Gui.VispaWidget.VispaWidget::keyPressEvent(), Vispa.Gui.MenuWidget.MenuWidget::leaveEvent(), Vispa.Gui.ConnectableWidget.ConnectableWidget::leaveEvent(), Vispa.Gui.PortWidget.PortWidget::moduleParent(), Vispa.Gui.WidgetContainer.WidgetContainer::mouseDoubleClickEvent(), Vispa.Gui.VispaWidget.VispaWidget::mouseDoubleClickEvent(), Vispa.Gui.PortConnection.PointToPointConnection::mousePressEvent(), Vispa.Gui.VispaWidget.VispaWidget::mousePressEvent(), Vispa.Views.LineDecayView.ParticleWidget::mousePressEvent(), Vispa.Views.LineDecayView.LineDecayContainer::noDecorationsMode(), Vispa.Views.LineDecayView.LineDecayContainer::operationId(), edm::operator<<(), Vispa.Gui.VispaWidget.VispaWidget::paintEvent(), Vispa.Gui.ConnectableWidget.ConnectableWidget::positionizeMenuWidget(), edm::Worker::resetModuleDescription(), Vispa.Views.WidgetView.WidgetView::restoreSelection(), Vispa.Views.WidgetView.WidgetView::select(), Vispa.Gui.PortConnection.PointToPointConnection::select(), Vispa.Gui.VispaWidget.VispaWidget::select(), Vispa.Views.LineDecayView.LineDecayContainer::select(), setContext(), Vispa.Views.LineDecayView.LineDecayContainer::sizeHint(), Vispa.Views.LineDecayView.LineDecayContainer::tabController(), Vispa.Views.BoxDecayView.BoxDecayContainer::toggleCollapsed(), Vispa.Views.PropertyView.PropertyView::valueChanged(), Vispa.Views.BoxDecayView.BoxDecayContainer::widgetByObject(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::widgetDoubleClicked(), and Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::widgetDragged().

{ return parent_; }

PlaceInPathContext const* edm::ModuleCallingContext::placeInPathContext ( ) const

inline

Definition at line 59 of file ModuleCallingContext.h.

References parent_, and edm::ParentContext::placeInPathContext().

Referenced by edm::Worker::exceptionContext(), HLTPrescaler::filter(), getStreamContext(), edm::SystemTimeKeeper::pauseModuleEvent(), edm::Worker::shouldRethrowException(), and edm::SystemTimeKeeper::stopModuleEvent().

{ return parent_.placeInPathContext(); }

ModuleCallingContext const* edm::ModuleCallingContext::previousModuleOnThread ( ) const

inline

Definition at line 79 of file ModuleCallingContext.h.

References previousModuleOnThread_.

Referenced by edm::service::MessageLogger::MessageLogger(), edm::operator<<(), TFileService::postModuleEvent(), TFileService::postModuleGlobal(), and edm::Worker::resetModuleDescription().

{ return previousModuleOnThread_; }

void edm::ModuleCallingContext::setContext	(	State	state,
		ParentContext const &	parent,
		ModuleCallingContext const *	previousOnThread
	)

Definition at line 29 of file ModuleCallingContext.cc.

References parent(), parent_, previousModuleOnThread_, state(), and state_.

Referenced by edm::Worker::doWork(), edm::Worker::doWorkAsync(), edm::Worker::prefetchAsync(), and edm::Worker::runModuleAfterAsyncPrefetch().

                                                                                      {
    state_ = state;
    parent_ = parent;
    previousModuleOnThread_ = previousOnThread;
  }

void edm::ModuleCallingContext::setState ( State  state )

inline

Definition at line 52 of file ModuleCallingContext.h.

References state(), and state_.

Referenced by edm::Worker::beginStream(), and edm::Worker::endStream().

{ state_ = state; }

State edm::ModuleCallingContext::state ( ) const

inline

Definition at line 55 of file ModuleCallingContext.h.

References state_.

Referenced by edm::service::ConcurrentModuleTimer::ConcurrentModuleTimer(), edm::Worker::exceptionContext(), edm::operator<<(), edm::Worker::resetModuleDescription(), setContext(), and setState().

{ return state_; }

StreamContext const* edm::ModuleCallingContext::streamContext ( ) const

inline

Definition at line 60 of file ModuleCallingContext.h.

References parent_, and edm::ParentContext::streamContext().

Referenced by edm::Worker::exceptionContext(), and getStreamContext().

{ return parent_.streamContext(); }

Type edm::ModuleCallingContext::type ( ) const

inline

Definition at line 56 of file ModuleCallingContext.h.

References parent_, and edm::ParentContext::type().

Referenced by depth(), edm::Worker::exceptionContext(), getGlobalContext(), getStreamContext(), getTopModuleCallingContext(), edm::operator<<(), edm::SystemTimeKeeper::pauseModuleEvent(), edm::Worker::shouldRethrowException(), and edm::SystemTimeKeeper::stopModuleEvent().

{ return parent_.type(); }

Member Data Documentation

ModuleDescription const* edm::ModuleCallingContext::moduleDescription_

private

Definition at line 83 of file ModuleCallingContext.h.

Referenced by moduleDescription().

ParentContext edm::ModuleCallingContext::parent_

private

Definition at line 84 of file ModuleCallingContext.h.

Referenced by globalContext(), internalContext(), moduleCallingContext(), parent(), placeInPathContext(), setContext(), streamContext(), and type().

ModuleCallingContext const* edm::ModuleCallingContext::previousModuleOnThread_

private

Definition at line 82 of file ModuleCallingContext.h.

Referenced by previousModuleOnThread(), and setContext().

State edm::ModuleCallingContext::state_

private

Definition at line 85 of file ModuleCallingContext.h.

Referenced by setContext(), setState(), and state().