edm::ParentContext Class Reference

#include <ParentContext.h>

Classes
union	Parent

Public Types
enum	Type {   Type::kGlobal, Type::kInternal, Type::kModule, Type::kPlaceInPath,   Type::kStream, Type::kInvalid }

Public Member Functions
GlobalContext const *	globalContext () const noexcept(false)
InternalContext const *	internalContext () const noexcept(false)
bool	isAtEndTransition () const noexcept
ModuleCallingContext const *	moduleCallingContext () const noexcept(false)
	ParentContext () noexcept
	ParentContext (GlobalContext const *) noexcept
	ParentContext (InternalContext const *) noexcept
	ParentContext (ModuleCallingContext const *) noexcept
	ParentContext (PlaceInPathContext const *) noexcept
	ParentContext (StreamContext const *) noexcept
PlaceInPathContext const *	placeInPathContext () const noexcept(false)
StreamContext const *	streamContext () const noexcept(false)
Type	type () const noexcept

Private Attributes
union edm::ParentContext::Parent	parent_
Type	type_

Detailed Description

Description: This is intended to be used as a member of ModuleCallingContext.

Usage:

Definition at line 27 of file ParentContext.h.

Member Enumeration Documentation

Type

enum edm::ParentContext::Type

strong

Enumerator
kGlobal
kInternal
kModule
kPlaceInPath
kStream
kInvalid

Definition at line 29 of file ParentContext.h.

{ kGlobal, kInternal, kModule, kPlaceInPath, kStream, kInvalid };

Constructor & Destructor Documentation

ParentContext() [1/6]

edm::ParentContext::ParentContext ( )

noexcept

Definition at line 15 of file ParentContext.cc.

References edm::ParentContext::Parent::global, and parent_.

: type_(Type::kInvalid) { parent_.global = nullptr; }

ParentContext() [2/6]

edm::ParentContext::ParentContext ( GlobalContext const *  global )

noexcept

Definition at line 17 of file ParentContext.cc.

: type_(Type::kGlobal) { parent_.global = global; }

ParentContext() [3/6]

edm::ParentContext::ParentContext ( InternalContext const *  internal )

noexcept

Definition at line 19 of file ParentContext.cc.

                                                                       : type_(Type::kInternal) {
    parent_.internal = internal;
  }

ParentContext() [4/6]

edm::ParentContext::ParentContext ( ModuleCallingContext const *  module )

noexcept

Definition at line 23 of file ParentContext.cc.

References callgraph::module.

                                                                          : type_(Type::kModule) {
    parent_.module = module;
  }

ParentContext() [5/6]

edm::ParentContext::ParentContext ( PlaceInPathContext const *  placeInPath )

noexcept

Definition at line 27 of file ParentContext.cc.

                                                                             : type_(Type::kPlaceInPath) {
    parent_.placeInPath = placeInPath;
  }

ParentContext() [6/6]

edm::ParentContext::ParentContext ( StreamContext const *  stream )

noexcept

Definition at line 31 of file ParentContext.cc.

References cms::cuda::stream.

: type_(Type::kStream) { parent_.stream = stream; }

Member Function Documentation

globalContext()

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

noexcept

Definition at line 54 of file ParentContext.cc.

References Exception, edm::ParentContext::Parent::global, kGlobal, edm::errors::LogicError, parent_, and type_.

Referenced by edm::ModuleCallingContext::globalContext(), edm::operator<<(), edm::PuttableProductResolver::prefetchAsync_(), edm::ParentProcessProductResolver::prefetchAsync_(), and edm::ParentProcessProductResolver::resolveProduct_().

                                                                          {
    if (type_ != Type::kGlobal) {
      throw Exception(errors::LogicError) << "ParentContext::globalContext called for incorrect type of context";
    }
    return parent_.global;
  }

internalContext()

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

noexcept

Definition at line 61 of file ParentContext.cc.

References Exception, edm::ParentContext::Parent::internal, kInternal, edm::errors::LogicError, parent_, and type_.

Referenced by edm::ModuleCallingContext::internalContext(), and edm::operator<<().

                                                                              {
    if (type_ != Type::kInternal) {
      throw Exception(errors::LogicError) << "ParentContext::internalContext called for incorrect type of context";
    }
    return parent_.internal;
  }

isAtEndTransition()

bool edm::ParentContext::isAtEndTransition ( ) const

noexcept

Definition at line 68 of file ParentContext.cc.

References edm::ParentContext::Parent::global, isAtEndTransition(), edm::StreamContext::isAtEndTransition(), edm::GlobalContext::isAtEndTransition(), kGlobal, kModule, kPlaceInPath, kStream, edm::ParentContext::Parent::module, edm::ModuleCallingContext::parent(), parent_, edm::PlaceInPathContext::pathContext(), edm::ParentContext::Parent::placeInPath, edm::ParentContext::Parent::stream, edm::PathContext::streamContext(), and type_.

Referenced by isAtEndTransition(), edm::PuttableProductResolver::prefetchAsync_(), and edm::SwitchProducerProductResolver::prefetchAsync_().

                                                       {
    switch (type_) {
      case Type::kGlobal: {
        return parent_.global->isAtEndTransition();
      }
      case Type::kModule: {
        return parent_.module->parent().isAtEndTransition();
      }
      case Type::kStream: {
        return parent_.stream->isAtEndTransition();
      }
      case Type::kPlaceInPath: {
        return parent_.placeInPath->pathContext()->streamContext()->isAtEndTransition();
      }
      default:
        break;
    }
    return false;
  }

moduleCallingContext()

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

noexcept

Definition at line 33 of file ParentContext.cc.

References Exception, kModule, edm::errors::LogicError, edm::ParentContext::Parent::module, parent_, and type_.

Referenced by edm::ModuleCallingContext::moduleCallingContext(), and edm::operator<<().

                                                                                        {
    if (type_ != Type::kModule) {
      throw Exception(errors::LogicError) << "ParentContext::moduleCallingContext called for incorrect type of context";
    }
    return parent_.module;
  }

placeInPathContext()

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

noexcept

Definition at line 40 of file ParentContext.cc.

References Exception, kPlaceInPath, edm::errors::LogicError, parent_, edm::ParentContext::Parent::placeInPath, and type_.

Referenced by edm::operator<<(), and edm::ModuleCallingContext::placeInPathContext().

                                                                                    {
    if (type_ != Type::kPlaceInPath) {
      throw Exception(errors::LogicError) << "ParentContext::placeInPathContext called for incorrect type of context";
    }
    return parent_.placeInPath;
  }

streamContext()

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

noexcept

Definition at line 47 of file ParentContext.cc.

References Exception, kStream, edm::errors::LogicError, parent_, edm::ParentContext::Parent::stream, and type_.

Referenced by edm::operator<<(), and edm::ModuleCallingContext::streamContext().

                                                                          {
    if (type_ != Type::kStream) {
      throw Exception(errors::LogicError) << "ParentContext::streamContext called for incorrect type of context";
    }
    return parent_.stream;
  }

type()

Type edm::ParentContext::type ( ) const

inlinenoexcept

Definition at line 38 of file ParentContext.h.

References type_.

Referenced by edm::operator<<(), and edm::ModuleCallingContext::type().

{ return type_; }

Member Data Documentation

parent_

union edm::ParentContext::Parent edm::ParentContext::parent_

private

Referenced by globalContext(), internalContext(), isAtEndTransition(), moduleCallingContext(), ParentContext(), placeInPathContext(), and streamContext().

type_

Type edm::ParentContext::type_

private

Definition at line 49 of file ParentContext.h.

Referenced by Modules.Service::__str__(), Modules.Service::_placeImpl(), Modules.ESSource::_placeImpl(), Modules.ESProducer::_placeImpl(), Modules.ESPrefer::copy(), Mixins._TypedParameterizable::dumpPython(), Modules.ESPrefer::dumpPythonAs(), Modules.Service::dumpSequencePython(), globalContext(), RandomRunSource.RandomRunSource::insertInto(), Modules.Service::insertInto(), ExternalGeneratorFilter.ExternalGeneratorFilter::insertInto(), Mixins._TypedParameterizable::insertInto(), internalContext(), isAtEndTransition(), moduleCallingContext(), Modules.ESSource::moduleLabel_(), Modules.ESProducer::moduleLabel_(), Modules.ESSource::nameInProcessDesc_(), Modules.ESProducer::nameInProcessDesc_(), Modules.ESPrefer::nameInProcessDesc_(), placeInPathContext(), streamContext(), and type().