edm::ModuleDescription Class Reference

#include <ModuleDescription.h>

Public Member Functions
unsigned int	id () const
ParameterSetID const &	mainParameterSetID () const
	ModuleDescription ()
	ModuleDescription (std::string const &modName, std::string const &modLabel)
	ModuleDescription (std::string const &modName, std::string const &modLabel, ProcessConfiguration const *procConfig)
	ModuleDescription (ParameterSetID const &pid, std::string const &modName, std::string const &modLabel)
	ModuleDescription (ParameterSetID const &pid, std::string const &modName, std::string const &modLabel, ProcessConfiguration const *procConfig, unsigned int modID)
std::string const &	moduleLabel () const
std::string const &	moduleName () const
bool	operator!= (ModuleDescription const &rh) const
bool	operator< (ModuleDescription const &rh) const
bool	operator== (ModuleDescription const &rh) const
ParameterSetID const &	parameterSetID () const
std::string const &	passID () const
ProcessConfiguration const &	processConfiguration () const
std::string const &	processName () const
std::string const &	releaseVersion () const
void	write (std::ostream &os) const
	~ModuleDescription ()

Static Public Member Functions
static unsigned int	getUniqueID ()
	Returns a unique id each time called. Intended to be passed to ModuleDescription's constructor's modID argument. Thread safe. More...
static constexpr unsigned int	invalidID ()
	Returns a value identifying an invalid id (the max unsigned int value) More...

Private Attributes
unsigned int	id_
std::string	moduleLabel_
std::string	moduleName_
ParameterSetID	parameterSetID_
ProcessConfiguration const *	processConfigurationPtr_

Detailed Description

Definition at line 21 of file ModuleDescription.h.

Constructor & Destructor Documentation

ModuleDescription() [1/5]

edm::ModuleDescription::ModuleDescription

(

)

Definition at line 16 of file ModuleDescription.cc.

      : parameterSetID_(), moduleName_(), moduleLabel_(), processConfigurationPtr_(nullptr), id_(invalidID()) {}

ModuleDescription() [2/5]

edm::ModuleDescription::ModuleDescription	(	std::string const &	modName,
		std::string const &	modLabel
	)

Definition at line 35 of file ModuleDescription.cc.

References invalidID().

      : ModuleDescription{ParameterSetID(), modName, modLabel, nullptr, invalidID()} {}

ModuleDescription() [3/5]

edm::ModuleDescription::ModuleDescription	(	std::string const &	modName,
		std::string const &	modLabel,
		ProcessConfiguration const *	procConfig
	)

Definition at line 38 of file ModuleDescription.cc.

References invalidID().

      : ModuleDescription{ParameterSetID(), modName, modLabel, procConfig, invalidID()} {}

ModuleDescription() [4/5]

edm::ModuleDescription::ModuleDescription	(	ParameterSetID const &	pid,
		std::string const &	modName,
		std::string const &	modLabel
	)

Definition at line 19 of file ModuleDescription.cc.

References invalidID().

      : ModuleDescription{pid, modName, modLabel, nullptr, invalidID()} {}

ModuleDescription() [5/5]

edm::ModuleDescription::ModuleDescription	(	ParameterSetID const &	pid,
		std::string const &	modName,
		std::string const &	modLabel,
		ProcessConfiguration const *	procConfig,
		unsigned int	modID
	)

Definition at line 24 of file ModuleDescription.cc.

      : parameterSetID_(pid),
        moduleName_(modName),
        moduleLabel_(modLabel),
        processConfigurationPtr_(procConfig),
        id_(iID) {}

~ModuleDescription()

edm::ModuleDescription::~ModuleDescription

(

)

Definition at line 43 of file ModuleDescription.cc.

{}

Member Function Documentation

getUniqueID()

unsigned int edm::ModuleDescription::getUniqueID ( )

static

Returns a unique id each time called. Intended to be passed to ModuleDescription's constructor's modID argument. Thread safe.

Definition at line 87 of file ModuleDescription.cc.

References s_id.

Referenced by edm::Maker::createModuleDescription(), and edm::EventProcessor::init().

{ return s_id++; }

id()

unsigned int edm::ModuleDescription::id ( ) const

inline

A unique ID for a module declared in the Process. The id is only unique for the Process and not across different Processes. If the id is invalid, will return the max unsigned int value.

Definition at line 46 of file ModuleDescription.h.

References id_.

Referenced by DQMOneEDAnalyzer< edm::LuminosityBlockCache< totemds::Cache > >::accumulate(), DQMOneLumiEDAnalyzer<>::beginLuminosityBlock(), DQMOneEDAnalyzer< edm::LuminosityBlockCache< totemds::Cache > >::beginRun(), FastTimerService::PlotsPerJob::book(), DQMOneLumiEDAnalyzer<>::endLuminosityBlockProduce(), DQMOneEDAnalyzer< edm::LuminosityBlockCache< totemds::Cache > >::endRunProduce(), edm::service::RandomNumberGeneratorService::getEngine(), DQMGlobalEDAnalyzerBase< dtsegment2dsl::Histograms, Args... >::meId(), edm::SystemTimeKeeper::pauseModuleEvent(), edm::service::Tracer::postEventReadFromSource(), FastTimerService::postEventReadFromSource(), edm::service::SimpleMemoryCheck::postModule(), edm::service::Tracer::postModuleAccessInputProcessBlock(), edm::service::Tracer::postModuleBeginProcessBlock(), NVProfilerService::postModuleBeginStream(), edm::service::Tracer::postModuleEndProcessBlock(), NVProfilerService::postModuleEndStream(), edm::service::Tracer::postModuleEvent(), FastTimerService::postModuleEvent(), NVProfilerService::postModuleEvent(), FastTimerService::postModuleEventAcquire(), edm::service::Tracer::postModuleEventAcquire(), NVProfilerService::postModuleEventAcquire(), edm::service::Tracer::postModuleEventDelayedGet(), edm::service::Tracer::postModuleEventPrefetching(), NVProfilerService::postModuleEventPrefetching(), edm::service::Tracer::postModuleGlobalBeginLumi(), NVProfilerService::postModuleGlobalBeginLumi(), edm::service::Tracer::postModuleGlobalBeginRun(), NVProfilerService::postModuleGlobalBeginRun(), edm::service::Tracer::postModuleGlobalEndLumi(), NVProfilerService::postModuleGlobalEndLumi(), edm::service::Tracer::postModuleGlobalEndRun(), NVProfilerService::postModuleGlobalEndRun(), edm::service::Tracer::postModuleGlobalPrefetching(), edm::service::Tracer::postModuleStreamBeginLumi(), NVProfilerService::postModuleStreamBeginLumi(), edm::service::Tracer::postModuleStreamBeginRun(), NVProfilerService::postModuleStreamBeginRun(), edm::service::RandomNumberGeneratorService::postModuleStreamCheck(), edm::service::Tracer::postModuleStreamEndLumi(), NVProfilerService::postModuleStreamEndLumi(), edm::service::Tracer::postModuleStreamEndRun(), NVProfilerService::postModuleStreamEndRun(), edm::service::Tracer::postModuleStreamPrefetching(), edm::service::Tracer::postModuleWriteLumi(), edm::service::Tracer::postModuleWriteProcessBlock(), edm::service::Tracer::postModuleWriteRun(), FastTimerService::postSourceEvent(), ProcessCallGraph::preBeginJob(), edm::service::Tracer::preEventReadFromSource(), edm::service::SimpleMemoryCheck::preModule(), edm::service::Tracer::preModuleAccessInputProcessBlock(), edm::service::Tracer::preModuleBeginProcessBlock(), NVProfilerService::preModuleBeginStream(), edm::service::StallMonitor::preModuleConstruction(), edm::service::StallMonitor::preModuleDestruction(), edm::service::Tracer::preModuleEndProcessBlock(), NVProfilerService::preModuleEndStream(), edm::service::Tracer::preModuleEvent(), NVProfilerService::preModuleEvent(), edm::service::Tracer::preModuleEventAcquire(), NVProfilerService::preModuleEventAcquire(), edm::service::Tracer::preModuleEventDelayedGet(), edm::service::Tracer::preModuleEventPrefetching(), NVProfilerService::preModuleEventPrefetching(), edm::service::Tracer::preModuleGlobalBeginLumi(), NVProfilerService::preModuleGlobalBeginLumi(), edm::service::Tracer::preModuleGlobalBeginRun(), NVProfilerService::preModuleGlobalBeginRun(), edm::service::Tracer::preModuleGlobalEndLumi(), NVProfilerService::preModuleGlobalEndLumi(), edm::service::Tracer::preModuleGlobalEndRun(), NVProfilerService::preModuleGlobalEndRun(), edm::service::Tracer::preModuleGlobalPrefetching(), edm::service::Tracer::preModuleStreamBeginLumi(), NVProfilerService::preModuleStreamBeginLumi(), edm::service::Tracer::preModuleStreamBeginRun(), NVProfilerService::preModuleStreamBeginRun(), edm::service::RandomNumberGeneratorService::preModuleStreamCheck(), edm::service::Tracer::preModuleStreamEndLumi(), NVProfilerService::preModuleStreamEndLumi(), edm::service::Tracer::preModuleStreamEndRun(), NVProfilerService::preModuleStreamEndRun(), edm::service::Tracer::preModuleStreamPrefetching(), edm::service::Tracer::preModuleWriteLumi(), edm::service::Tracer::preModuleWriteProcessBlock(), edm::service::Tracer::preModuleWriteRun(), ProcessCallGraph::preSourceConstruction(), edm::SystemTimeKeeper::restartModuleEvent(), edm::SystemTimeKeeper::startModuleEvent(), edm::SystemTimeKeeper::stopModuleEvent(), and edm::service::ConcurrentModuleTimer::trackModule().

{ return id_; }

invalidID()

static constexpr unsigned int edm::ModuleDescription::invalidID ( )

inlinestatic

Returns a value identifying an invalid id (the max unsigned int value)

Definition at line 66 of file ModuleDescription.h.

References SiStripPI::max.

Referenced by ModuleDescription(), ProcessCallGraph::preBeginJob(), and ProcessCallGraph::preSourceConstruction().

{ return std::numeric_limits<unsigned int>::max(); }

mainParameterSetID()

ParameterSetID const & edm::ModuleDescription::mainParameterSetID

(

)

const

Definition at line 53 of file ModuleDescription.cc.

References edm::ProcessConfiguration::parameterSetID(), and processConfiguration().

Referenced by evf::EvFOutputModule::beginRun(), edm::getProcessParameterSetContainingModule(), and evf::GlobalEvFOutputModule::globalBeginRun().

                                                                    {
    return processConfiguration().parameterSetID();
  }

moduleLabel()

std::string const& edm::ModuleDescription::moduleLabel ( ) const

inline

Definition at line 43 of file ModuleDescription.h.

References moduleLabel_.

Referenced by edm::ProductRegistryHelper::addToRegistry(), edm::ScheduleInfo::availableModuleLabels(), edm::PuttableSourceBase::beginJob(), edm::Worker::beginJob(), evf::EvFOutputModule::beginRun(), TestInterProcessRandomProd::beginStream(), TestInterProcessProd::beginStream(), evf::GlobalEvFOutputModule::beginStream(), edm::Worker::beginStream(), FastTimerService::PlotsPerJob::book(), edm::Worker::endJob(), edm::Worker::endStream(), edm::exceptionContext(), edm::TransformerBase::extendUpdateLookup(), PileupRandomNumberGenerator::findPresentModule(), edm::PrincipalGetAdapter::getBranchDescription(), edm::service::RandomNumberGeneratorService::getEngine(), evf::GlobalEvFOutputModule::globalBeginRun(), HLTFilter::moduleLabel(), HLTStreamFilter::moduleLabel(), HLTHighLevel::moduleLabel(), edm::service::RandomNumberGeneratorService::mySeed(), operator<(), edm::ScheduleInfo::parametersForModule(), TriggerResultsFilterFromDB::pathsFromSetup(), edm::service::Tracer::postEventReadFromSource(), edm::service::SimpleMemoryCheck::postModule(), edm::service::Tracer::postModuleAccessInputProcessBlock(), edm::service::SimpleMemoryCheck::postModuleBeginJob(), edm::service::Tracer::postModuleBeginProcessBlock(), ROCmMonitoringService::postModuleBeginStream(), CUDAMonitoringService::postModuleBeginStream(), edm::service::SimpleMemoryCheck::postModuleConstruction(), edm::service::Tracer::postModuleEndProcessBlock(), ROCmMonitoringService::postModuleEvent(), CUDAMonitoringService::postModuleEvent(), edm::service::IgProfService::postModuleEvent(), edm::service::JeProfService::postModuleEvent(), edm::service::Tracer::postModuleEvent(), edm::service::Tracer::postModuleEventAcquire(), 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::postModuleGlobalPrefetching(), edm::service::Tracer::postModuleStreamBeginLumi(), edm::service::Tracer::postModuleStreamBeginRun(), edm::service::RandomNumberGeneratorService::postModuleStreamCheck(), edm::service::Tracer::postModuleStreamEndLumi(), edm::service::Tracer::postModuleStreamEndRun(), edm::service::Tracer::postModuleStreamPrefetching(), edm::service::Tracer::postModuleWriteLumi(), edm::service::Tracer::postModuleWriteProcessBlock(), edm::service::Tracer::postModuleWriteRun(), edm::service::SimpleMemoryCheck::postSourceConstruction(), edm::service::Tracer::preEventReadFromSource(), edm::service::Tracer::preModuleAccessInputProcessBlock(), edm::service::Tracer::preModuleBeginProcessBlock(), NVProfilerService::preModuleBeginStream(), edm::service::StallMonitor::preModuleConstruction(), edm::service::Tracer::preModuleEndProcessBlock(), NVProfilerService::preModuleEndStream(), edm::service::IgProfService::preModuleEvent(), edm::service::JeProfService::preModuleEvent(), edm::service::Tracer::preModuleEvent(), NVProfilerService::preModuleEvent(), edm::service::Tracer::preModuleEventAcquire(), NVProfilerService::preModuleEventAcquire(), edm::service::Tracer::preModuleEventDelayedGet(), edm::service::Tracer::preModuleEventPrefetching(), NVProfilerService::preModuleEventPrefetching(), edm::service::Tracer::preModuleGlobalBeginLumi(), NVProfilerService::preModuleGlobalBeginLumi(), edm::service::Tracer::preModuleGlobalBeginRun(), NVProfilerService::preModuleGlobalBeginRun(), edm::service::Tracer::preModuleGlobalEndLumi(), NVProfilerService::preModuleGlobalEndLumi(), edm::service::Tracer::preModuleGlobalEndRun(), NVProfilerService::preModuleGlobalEndRun(), edm::service::Tracer::preModuleGlobalPrefetching(), edm::service::Tracer::preModuleStreamBeginLumi(), NVProfilerService::preModuleStreamBeginLumi(), edm::service::Tracer::preModuleStreamBeginRun(), NVProfilerService::preModuleStreamBeginRun(), edm::service::Tracer::preModuleStreamEndLumi(), NVProfilerService::preModuleStreamEndLumi(), edm::service::Tracer::preModuleStreamEndRun(), NVProfilerService::preModuleStreamEndRun(), edm::service::Tracer::preModuleStreamPrefetching(), edm::service::Tracer::preModuleWriteLumi(), edm::service::Tracer::preModuleWriteProcessBlock(), edm::service::Tracer::preModuleWriteRun(), edm::service::SimpleMemoryCheck::preSourceConstruction(), edm::Maker::throwConfigurationException(), edm::PrincipalGetAdapter::throwUnregisteredPutException(), edm::StreamSchedule::tryToPlaceConditionalModules(), and write().

{ return moduleLabel_; }

moduleName()

std::string const& edm::ModuleDescription::moduleName ( ) const

inline

Definition at line 42 of file ModuleDescription.h.

References moduleName_.

Referenced by edm::ProductRegistryHelper::addToRegistry(), edm::Worker::beginJob(), edm::Worker::beginStream(), edm::Worker::endJob(), edm::Worker::endStream(), edm::exceptionContext(), edm::StreamSchedule::fillWorkers(), HLTJetTag< T >::logTrace(), operator<(), edm::service::SimpleMemoryCheck::postModuleBeginJob(), ROCmMonitoringService::postModuleBeginStream(), CUDAMonitoringService::postModuleBeginStream(), edm::service::SimpleMemoryCheck::postModuleConstruction(), ROCmMonitoringService::postModuleEvent(), CUDAMonitoringService::postModuleEvent(), FWPathsPopup::postModuleEvent(), edm::service::IgProfService::postModuleEvent(), edm::service::JeProfService::postModuleEvent(), edm::service::RandomNumberGeneratorService::postModuleStreamCheck(), edm::service::SimpleMemoryCheck::postSourceConstruction(), FWPathsPopup::preModuleEvent(), edm::service::IgProfService::preModuleEvent(), edm::service::JeProfService::preModuleEvent(), edm::service::SimpleMemoryCheck::preSourceConstruction(), edm::Maker::throwConfigurationException(), and write().

{ return moduleName_; }

operator!=()

bool edm::ModuleDescription::operator!=

(

ModuleDescription const &

rh

)

const

Definition at line 85 of file ModuleDescription.cc.

{ return !((*this) == rh); }

operator<()

bool edm::ModuleDescription::operator<

(

ModuleDescription const &

rh

)

const

Definition at line 57 of file ModuleDescription.cc.

References moduleLabel(), moduleName(), parameterSetID(), passID(), processName(), and releaseVersion().

                                                                     {
    if (moduleLabel() < rh.moduleLabel())
      return true;
    if (rh.moduleLabel() < moduleLabel())
      return false;
    if (processName() < rh.processName())
      return true;
    if (rh.processName() < processName())
      return false;
    if (moduleName() < rh.moduleName())
      return true;
    if (rh.moduleName() < moduleName())
      return false;
    if (parameterSetID() < rh.parameterSetID())
      return true;
    if (rh.parameterSetID() < parameterSetID())
      return false;
    if (releaseVersion() < rh.releaseVersion())
      return true;
    if (rh.releaseVersion() < releaseVersion())
      return false;
    if (passID() < rh.passID())
      return true;
    return false;
  }

operator==()

bool edm::ModuleDescription::operator==

(

ModuleDescription const &

rh

)

const

Definition at line 83 of file ModuleDescription.cc.

{ return !((*this) < rh || rh < (*this)); }

parameterSetID()

ParameterSetID const& edm::ModuleDescription::parameterSetID ( ) const

inline

Definition at line 41 of file ModuleDescription.h.

References parameterSetID_.

Referenced by edm::ProductRegistryHelper::addToRegistry(), operator<(), and write().

{ return parameterSetID_; }

passID()

std::string const & edm::ModuleDescription::passID

(

)

const

Definition at line 51 of file ModuleDescription.cc.

References edm::ProcessConfiguration::passID(), and processConfiguration().

Referenced by operator<().

{ return processConfiguration().passID(); }

processConfiguration()

ProcessConfiguration const & edm::ModuleDescription::processConfiguration

(

)

const

Definition at line 45 of file ModuleDescription.cc.

References processConfigurationPtr_.

Referenced by mainParameterSetID(), passID(), edm::InputSource::processConfiguration(), processName(), and releaseVersion().

{ return *processConfigurationPtr_; }

processName()

std::string const & edm::ModuleDescription::processName

(

)

const

Definition at line 47 of file ModuleDescription.cc.

References processConfiguration(), and edm::ProcessConfiguration::processName().

Referenced by edm::ProductRegistryHelper::addToRegistry(), edmtest::ESTestAnalyzerA::analyze(), edmtest::ESTestAnalyzerB::analyze(), edmtest::ESTestAnalyzerK::analyze(), edmtest::ESTestAnalyzerAZ::analyze(), edmtest::ESTestAnalyzerJ::analyze(), edmtest::ESTestAnalyzerL::analyze(), edm::PuttableSourceBase::beginJob(), edm::TransformerBase::extendUpdateLookup(), edm::PrincipalGetAdapter::getBranchDescription(), operator<(), and edm::PrincipalGetAdapter::throwUnregisteredPutException().

{ return processConfiguration().processName(); }

releaseVersion()

std::string const & edm::ModuleDescription::releaseVersion

(

)

const

Definition at line 49 of file ModuleDescription.cc.

References processConfiguration(), and edm::ProcessConfiguration::releaseVersion().

Referenced by operator<().

{ return processConfiguration().releaseVersion(); }

write()

void edm::ModuleDescription::write

(

std::ostream &

os

)

const

Definition at line 89 of file ModuleDescription.cc.

References moduleLabel(), moduleName(), and parameterSetID().

Referenced by pkg.AbstractPkg::generate().

                                                    {
    os << "Module type=" << moduleName() << ", "
       << "Module label=" << moduleLabel() << ", "
       << "Parameter Set ID=" << parameterSetID();
    //<< "Parameter Set ID=" << parameterSetID() << ", "
    //<< "Process name=" << processName() << ", "
    //<< "Release Version=" << releaseVersion() << ", "
    //<< "Pass ID=" << passID() << ", "
    //<< "Main Parameter Set ID=" << mainParameterSetID();
  }

Member Data Documentation

id_

unsigned int edm::ModuleDescription::id_

private

Definition at line 82 of file ModuleDescription.h.

Referenced by id().

moduleLabel_

std::string edm::ModuleDescription::moduleLabel_

private

Definition at line 77 of file ModuleDescription.h.

Referenced by ExternalGeneratorFilter.ExternalGeneratorFilter::insertInto(), Modules.SwitchProducer::insertInto(), Mixins._TypedParameterizable::insertInto(), moduleLabel(), Modules.ESSource::nameInProcessDesc_(), and Modules.ESProducer::nameInProcessDesc_().

moduleName_

std::string edm::ModuleDescription::moduleName_

private

Definition at line 73 of file ModuleDescription.h.

Referenced by moduleName().

parameterSetID_

ParameterSetID edm::ModuleDescription::parameterSetID_

private

Definition at line 70 of file ModuleDescription.h.

Referenced by parameterSetID().

processConfigurationPtr_

ProcessConfiguration const* edm::ModuleDescription::processConfigurationPtr_

private

Definition at line 80 of file ModuleDescription.h.

Referenced by processConfiguration().