edm::ESModuleCallingContext Class Reference

#include <ESModuleCallingContext.h>

Public Types
enum	State { State::kPrefetching, State::kRunning, State::kInvalid }
using	Type = ESParentContext::Type

Public Member Functions
edm::eventsetup::ComponentDescription const *	componentDescription () const
unsigned	depth () const
ESModuleCallingContext const *	esmoduleCallingContext () const
	ESModuleCallingContext (edm::eventsetup::ComponentDescription const *moduleDescription)
	ESModuleCallingContext (edm::eventsetup::ComponentDescription const *moduleDescription, State state, ESParentContext const &parent)
ModuleCallingContext const *	getTopModuleCallingContext () const
ModuleCallingContext const *	moduleCallingContext () const
ESParentContext const &	parent () const
void	setContext (State state, ESParentContext const &parent)
void	setState (State state)
State	state () const
Type	type () const

Private Attributes
edm::eventsetup::ComponentDescription const *	componentDescription_
ESParentContext	parent_
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 27 of file ESModuleCallingContext.h.

Member Typedef Documentation

Type

using edm::ESModuleCallingContext::Type = ESParentContext::Type

Definition at line 29 of file ESModuleCallingContext.h.

Member Enumeration Documentation

State

enum edm::ESModuleCallingContext::State

strong

Enumerator
kPrefetching
kRunning
kInvalid

Definition at line 31 of file ESModuleCallingContext.h.

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

Constructor & Destructor Documentation

ESModuleCallingContext() [1/2]

edm::ESModuleCallingContext::ESModuleCallingContext

(

edm::eventsetup::ComponentDescription const *

moduleDescription

)

Definition at line 10 of file ESModuleCallingContext.cc.

      : componentDescription_(componentDescription), parent_(), state_(State::kInvalid) {}

ESModuleCallingContext() [2/2]

edm::ESModuleCallingContext::ESModuleCallingContext	(	edm::eventsetup::ComponentDescription const *	moduleDescription,
		State	state,
		ESParentContext const &	parent
	)

Definition at line 13 of file ESModuleCallingContext.cc.

      : componentDescription_(componentDescription), parent_(parent), state_(state) {}

Member Function Documentation

componentDescription()

edm::eventsetup::ComponentDescription const* edm::ESModuleCallingContext::componentDescription ( ) const

inline

Definition at line 47 of file ESModuleCallingContext.h.

{ return componentDescription_; }

References componentDescription_.

Referenced by edm::service::Tracer::postESModule(), edm::service::Tracer::postESModulePrefetching(), edm::service::Tracer::preESModule(), and edm::service::Tracer::preESModulePrefetching().

depth()

unsigned edm::ESModuleCallingContext::depth

(

void

)

const

Definition at line 31 of file ESModuleCallingContext.cc.

                                               {
    unsigned depth = 0;
    ESModuleCallingContext const* mcc = this;
    while (mcc->type() == ESParentContext::Type::kESModule) {
      ++depth;
      mcc = mcc->esmoduleCallingContext();
    }
    return depth + mcc->moduleCallingContext()->depth();
  }

References edm::ModuleCallingContext::depth(), esmoduleCallingContext(), edm::ESParentContext::kESModule, moduleCallingContext(), and type().

Referenced by edm::service::Tracer::postESModule(), edm::service::Tracer::postESModulePrefetching(), edm::service::Tracer::preESModule(), and edm::service::Tracer::preESModulePrefetching().

esmoduleCallingContext()

ESModuleCallingContext const* edm::ESModuleCallingContext::esmoduleCallingContext ( ) const

inline

Definition at line 52 of file ESModuleCallingContext.h.

{ return parent_.esmoduleCallingContext(); }

References edm::ESParentContext::esmoduleCallingContext(), and parent_.

Referenced by depth(), and getTopModuleCallingContext().

getTopModuleCallingContext()

ModuleCallingContext const * edm::ESModuleCallingContext::getTopModuleCallingContext

(

)

const

Definition at line 23 of file ESModuleCallingContext.cc.

                                                                                       {
    ESModuleCallingContext const* mcc = this;
    while (mcc->type() == ESParentContext::Type::kESModule) {
      mcc = mcc->esmoduleCallingContext();
    }
    return mcc->moduleCallingContext()->getTopModuleCallingContext();
  }

References esmoduleCallingContext(), edm::ModuleCallingContext::getTopModuleCallingContext(), edm::ESParentContext::kESModule, moduleCallingContext(), and type().

moduleCallingContext()

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

inline

Definition at line 51 of file ESModuleCallingContext.h.

{ return parent_.moduleCallingContext(); }

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

Referenced by depth(), and getTopModuleCallingContext().

parent()

ESParentContext const& edm::ESModuleCallingContext::parent ( void  ) const

inline

Definition at line 50 of file ESModuleCallingContext.h.

{ return parent_; }

References parent_.

Referenced by setContext().

setContext()

void edm::ESModuleCallingContext::setContext	(	State	state,
		ESParentContext const &	parent
	)

Definition at line 18 of file ESModuleCallingContext.cc.

                                                                                    {
    state_ = state;
    parent_ = parent;
  }

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

Referenced by edm::eventsetup::Callback< T, TReturn, TRecord, TDecorator >::prefetchAsync().

setState()

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

inline

Definition at line 45 of file ESModuleCallingContext.h.

{ state_ = state; }

References state(), and state_.

Referenced by edm::eventsetup::Callback< T, TReturn, TRecord, TDecorator >::runProducerAsync().

state()

State edm::ESModuleCallingContext::state ( ) const

inline

Definition at line 48 of file ESModuleCallingContext.h.

{ return state_; }

References state_.

Referenced by setContext(), and setState().

type()

Type edm::ESModuleCallingContext::type ( ) const

inline

Definition at line 49 of file ESModuleCallingContext.h.

{ return parent_.type(); }

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

Referenced by depth(), and getTopModuleCallingContext().

Member Data Documentation

componentDescription_

edm::eventsetup::ComponentDescription const* edm::ESModuleCallingContext::componentDescription_

private

Definition at line 63 of file ESModuleCallingContext.h.

Referenced by componentDescription().

parent_

ESParentContext edm::ESModuleCallingContext::parent_

private

Definition at line 64 of file ESModuleCallingContext.h.

Referenced by esmoduleCallingContext(), moduleCallingContext(), parent(), setContext(), and type().

state_

State edm::ESModuleCallingContext::state_

private

Definition at line 65 of file ESModuleCallingContext.h.

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