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 22 of file ModuleDescription.h.

Constructor & Destructor Documentation

edm::ModuleDescription::ModuleDescription

(

)

Definition at line 16 of file ModuleDescription.cc.

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

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

Definition at line 40 of file ModuleDescription.cc.

References invalidID().

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

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

Definition at line 44 of file ModuleDescription.cc.

References invalidID().

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

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

Definition at line 23 of file ModuleDescription.cc.

References invalidID(), and sysUtil::pid.

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

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

Definition at line 28 of file ModuleDescription.cc.

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

edm::ModuleDescription::~ModuleDescription

(

)

Definition at line 49 of file ModuleDescription.cc.

{}

Member Function Documentation

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 103 of file ModuleDescription.cc.

References s_id.

Referenced by edm::Maker::createModuleDescription(), edm::makeInput(), ThroughputService::preallocate(), and FastTimerService::preallocate().

                                 {
    return s_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 53 of file ModuleDescription.h.

References id_.

Referenced by DQMEDAnalyzer::beginRun(), DQMEDAnalyzer::endLuminosityBlockSummary(), DQMEDAnalyzer::endRunSummary(), edm::service::MessageLogger::establishModule(), edm::Schedule::fillModuleAndConsumesInfo(), edm::service::RandomNumberGeneratorService::getEngine(), edm::SystemTimeKeeper::pauseModuleEvent(), edm::service::SimpleMemoryCheck::postModule(), edm::service::Tracer::postModuleBeginJob(), edm::service::Tracer::postModuleBeginStream(), edm::service::Tracer::postModuleConstruction(), edm::service::Tracer::postModuleEndJob(), edm::service::Tracer::postModuleEndStream(), edm::service::Tracer::postModuleEvent(), FastTimerService::postModuleEvent(), edm::service::Tracer::postModuleEventDelayedGet(), FastTimerService::postModuleEventDelayedGet(), 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::SimpleMemoryCheck::preModule(), edm::service::Tracer::preModuleBeginJob(), FastTimerService::preModuleBeginJob(), edm::service::Tracer::preModuleBeginStream(), edm::service::RandomNumberGeneratorService::preModuleConstruction(), edm::service::Tracer::preModuleConstruction(), edm::service::Tracer::preModuleEndJob(), edm::service::Tracer::preModuleEndStream(), edm::service::Tracer::preModuleEvent(), FastTimerService::preModuleEvent(), edm::service::Tracer::preModuleEventDelayedGet(), FastTimerService::preModuleEventDelayedGet(), 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(), FastTimerService::queryModuleTime(), edm::SystemTimeKeeper::restartModuleEvent(), edm::SystemTimeKeeper::startModuleEvent(), edm::SystemTimeKeeper::stopModuleEvent(), and edm::SystemTimeKeeper::SystemTimeKeeper().

{return id_;}

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

inlinestatic

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

Definition at line 74 of file ModuleDescription.h.

References bookConverter::max.

Referenced by ModuleDescription().

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

ParameterSetID const & edm::ModuleDescription::mainParameterSetID

(

)

const

Definition at line 72 of file ModuleDescription.cc.

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

Referenced by edm::getProcessParameterSetContainingModule().

                                              {
    return processConfiguration().parameterSetID();
  }

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

inline

Definition at line 50 of file ModuleDescription.h.

References moduleLabel_.

Referenced by edm::ProductRegistryHelper::addToRegistry(), edm::UnscheduledCallProducer::addWorker(), edm::ScheduleInfo::availableModuleLabels(), edm::Worker::beginJob(), edm::Worker::beginStream(), edm::Worker::endJob(), edm::Worker::endStream(), edm::service::MessageLogger::establishModule(), edm::Path::exceptionContext(), edm::Schedule::fillModuleAndConsumesInfo(), edm::fillModuleInPathSummary(), edm::fillWorkerSummaryAux(), edm::PrincipalGetAdapter::getBranchDescription(), edm::service::RandomNumberGeneratorService::getEngine(), HLTFilter::moduleLabel(), HLTStreamFilter::moduleLabel(), HLTHighLevel::moduleLabel(), edm::service::RandomNumberGeneratorService::mySeed(), Timer::newTimingMeasurement(), operator<(), edm::ScheduleInfo::parametersForModule(), TriggerResultsFilterFromDB::pathsFromSetup(), edm::service::EnableFloatingPointExceptions::postActions(), edm::service::SimpleMemoryCheck::postModule(), edm::service::SimpleMemoryCheck::postModuleBeginJob(), edm::service::Tracer::postModuleBeginJob(), edm::service::Tracer::postModuleBeginStream(), edm::service::SimpleMemoryCheck::postModuleConstruction(), edm::service::Tracer::postModuleConstruction(), edm::service::Tracer::postModuleEndJob(), edm::service::Tracer::postModuleEndStream(), edm::service::Tracer::postModuleEvent(), FastTimerService::postModuleEvent(), edm::service::Tracer::postModuleEventDelayedGet(), FastTimerService::postModuleEventDelayedGet(), 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::SimpleMemoryCheck::postSourceConstruction(), edm::service::EnableFloatingPointExceptions::preActions(), evf::MicroStateServiceClassic::preModule(), InputTagDistributorService::preModule(), VariableHelperService::preModule(), edm::service::RandomNumberGeneratorService::preModuleBeginJob(), edm::service::Tracer::preModuleBeginJob(), FastTimerService::preModuleBeginJob(), edm::service::Tracer::preModuleBeginStream(), edm::service::RandomNumberGeneratorService::preModuleConstruction(), edm::service::Tracer::preModuleConstruction(), edm::service::RandomNumberGeneratorService::preModuleEndJob(), edm::service::Tracer::preModuleEndJob(), edm::service::Tracer::preModuleEndStream(), edm::service::Tracer::preModuleEvent(), FastTimerService::preModuleEvent(), edm::service::Tracer::preModuleEventDelayedGet(), FastTimerService::preModuleEventDelayedGet(), 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(), edm::service::Tracer::preModuleStreamEndRun(), edm::service::SimpleMemoryCheck::preSourceConstruction(), FastTimerService::queryModuleTime(), edm::StreamerOutputModuleBase::serializeRegistry(), TFileService::setDirectoryName(), evf::MicroStateServiceClassic::setMicroState(), edm::Maker::throwConfigurationException(), and write().

{return moduleLabel_;}

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

inline

Definition at line 49 of file ModuleDescription.h.

References moduleName_.

Referenced by edm::ProductRegistryHelper::addToRegistry(), edm::Worker::beginJob(), edm::Worker::beginStream(), edm::Worker::endJob(), edm::Worker::endStream(), edm::service::MessageLogger::establishModule(), edm::Path::exceptionContext(), edm::StreamSchedule::fillWorkers(), Timer::newTimingMeasurement(), operator<(), edm::service::SimpleMemoryCheck::postModuleBeginJob(), edm::service::SimpleMemoryCheck::postModuleConstruction(), FWPathsPopup::postModuleEvent(), edm::service::RandomNumberGeneratorService::postModuleStreamCheck(), edm::service::SimpleMemoryCheck::postSourceConstruction(), edm::service::Tracer::postSourceConstruction(), evf::FastMonitoringService::preModuleBeginJob(), FastTimerService::preModuleBeginJob(), FWPathsPopup::preModuleEvent(), edm::service::SimpleMemoryCheck::preSourceConstruction(), edm::service::Tracer::preSourceConstruction(), TFileService::setDirectoryName(), edm::Maker::throwConfigurationException(), and write().

{return moduleName_;}

bool edm::ModuleDescription::operator!=

(

ModuleDescription const &

rh

)

const

Definition at line 98 of file ModuleDescription.cc.

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

bool edm::ModuleDescription::operator<

(

ModuleDescription const &

rh

)

const

Definition at line 77 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;
  }

bool edm::ModuleDescription::operator==

(

ModuleDescription const &

rh

)

const

Definition at line 93 of file ModuleDescription.cc.

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

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

inline

Definition at line 48 of file ModuleDescription.h.

References parameterSetID_.

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

{return parameterSetID_;}

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

(

)

const

Definition at line 67 of file ModuleDescription.cc.

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

Referenced by operator<().

                                  {
    return processConfiguration().passID();
  }

ProcessConfiguration const & edm::ModuleDescription::processConfiguration

(

)

const

Definition at line 52 of file ModuleDescription.cc.

References processConfigurationPtr_.

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

                                                {
    return *processConfigurationPtr_;
  }

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

(

)

const

Definition at line 57 of file ModuleDescription.cc.

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

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

                                       {
    return processConfiguration().processName();
  }

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

(

)

const

Definition at line 62 of file ModuleDescription.cc.

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

Referenced by operator<().

                                          {
    return processConfiguration().releaseVersion();
  }

void edm::ModuleDescription::write

(

std::ostream &

os

)

const

Definition at line 108 of file ModuleDescription.cc.

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

Referenced by pkg.AbstractPkg::generate(), and edm::operator<<().

                                               {
    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

unsigned int edm::ModuleDescription::id_

private

Definition at line 96 of file ModuleDescription.h.

Referenced by id().

std::string edm::ModuleDescription::moduleLabel_

private

Definition at line 91 of file ModuleDescription.h.

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

std::string edm::ModuleDescription::moduleName_

private

Definition at line 87 of file ModuleDescription.h.

Referenced by moduleName().

ParameterSetID edm::ModuleDescription::parameterSetID_

private

Definition at line 84 of file ModuleDescription.h.

Referenced by parameterSetID().

ProcessConfiguration const* edm::ModuleDescription::processConfigurationPtr_

private

Definition at line 94 of file ModuleDescription.h.

Referenced by processConfiguration().