art::ModuleDescription Class Reference

#include "ModuleDescription.h"

Public Member Functions
	ModuleDescription ()=default
	ModuleDescription (fhicl::ParameterSetID parameterSetID, std::string const &modName, std::string const &modLabel, ProcessConfiguration pc, ModuleDescriptionID id=getUniqueID())
void	write (std::ostream &os) const
fhicl::ParameterSetID const &	parameterSetID () const
std::string const &	moduleName () const
std::string const &	moduleLabel () const
ProcessConfiguration const &	processConfiguration () const
ProcessConfigurationID const	processConfigurationID () const
std::string const &	processName () const
std::string const &	releaseVersion () const
fhicl::ParameterSetID const &	mainParameterSetID () const
bool	operator< (ModuleDescription const &rh) const
bool	operator== (ModuleDescription const &rh) const
bool	operator!= (ModuleDescription const &rh) const
ModuleDescriptionID	id () const

Static Public Member Functions
static ModuleDescriptionID	getUniqueID ()
static constexpr ModuleDescriptionID	invalidID ()

Private Attributes
fhicl::ParameterSetID	parameterSetID_ {}
std::string	moduleName_ {}
std::string	moduleLabel_ {}
ProcessConfiguration	processConfiguration_ {}
ModuleDescriptionID	id_ {invalidID()}

Detailed Description

Definition at line 24 of file ModuleDescription.h.

Constructor & Destructor Documentation

art::ModuleDescription::ModuleDescription ( )

explicitdefault

art::ModuleDescription::ModuleDescription ( fhicl::ParameterSetID  parameterSetID, std::string const &  modName, std::string const &  modLabel, ProcessConfiguration  pc, ModuleDescriptionID  id = getUniqueID()  )

explicit

Definition at line 7 of file ModuleDescription.cc.

References id_, moduleLabel_, moduleName_, and processConfiguration_.

  : parameterSetID_{parameterSetID}
  , moduleName_{modName}
  , moduleLabel_{modLabel}
  , processConfiguration_{std::move(pc)}
  , id_{id}
{}

Member Function Documentation

art::ModuleDescriptionID art::ModuleDescription::getUniqueID ( )

static

Definition at line 70 of file ModuleDescription.cc.

References s_id.

Referenced by id().

{
  return ++s_id;
}

ModuleDescriptionID art::ModuleDescription::id ( ) const

inline

Definition at line 83 of file ModuleDescription.h.

References getUniqueID(), and id_.

Referenced by art::Source< T >::finishProductRegistration_(), art::PathsInfo::makeWorker_(), and art::ServicesManager::registerProducts().

    {
      return id_;
    } // Unique only within a process.

static constexpr ModuleDescriptionID art::ModuleDescription::invalidID ( )

inlinestatic

Definition at line 91 of file ModuleDescription.h.

References max.

Referenced by art::RootOutput::doRegisterProducts(), and art::Source< T >::finishProductRegistration_().

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

fhicl::ParameterSetID const& art::ModuleDescription::mainParameterSetID ( ) const

inline

Definition at line 73 of file ModuleDescription.h.

References operator!=(), operator<(), operator==(), art::ProcessConfiguration::parameterSetID(), and processConfiguration().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), art::EDAnalyzer::doBeginJob(), and write().

    {
      return processConfiguration().parameterSetID();
    }

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

inline

Definition at line 48 of file ModuleDescription.h.

References moduleLabel_.

Referenced by art::RootOutput::doRegisterProducts(), art::OutputModule::doWriteEvent(), art::detail::exceptionContext(), art::DataViewImpl::getProductDescription(), art::ProducerBase::getProductID(), art::CurrentModule::label(), art::Worker::label(), art::OutputModule::makePlugins_(), art::CurrentProcessingContext::moduleLabel(), rndm::NuRandomServiceHelper::ArtState::moduleLabel(), operator<(), art::Tracer::postModuleBeginJob(), art::Tracer::postModuleBeginRun(), art::Tracer::postModuleBeginSubRun(), art::Tracer::postModuleConstruction(), art::Tracer::postModuleEndJob(), art::Tracer::postModuleEndRun(), art::Tracer::postModuleEndSubRun(), art::Tracer::postModuleEvent(), rndm::NuRandomService::preModule(), art::Tracer::preModuleBeginJob(), art::Tracer::preModuleBeginRun(), art::Tracer::preModuleBeginSubRun(), art::Tracer::preModuleConstruction(), art::Tracer::preModuleEndJob(), art::Tracer::preModuleEndRun(), art::Tracer::preModuleEndSubRun(), art::Tracer::preModuleEvent(), art::MemoryTracker::recordModuleData(), art::MemoryTracker::recordOtherData(), art::TimeTracker::recordTime(), art::TFileService::setDirectoryName_(), and write().

    {
      return moduleLabel_;
    }

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

inline

Definition at line 43 of file ModuleDescription.h.

References moduleName_.

Referenced by art::detail::exceptionContext(), rndm::NuRandomServiceHelper::ArtState::getEventSeedInputData(), operator<(), art::TimeTracker::postSourceConstruction(), art::MemoryTracker::recordModuleData(), art::MemoryTracker::recordOtherData(), art::TimeTracker::recordTime(), art::TFileService::setDirectoryName_(), and write().

    {
      return moduleName_;
    }

bool art::ModuleDescription::operator!=

(

ModuleDescription const &

rh

)

const

Definition at line 51 of file ModuleDescription.cc.

References operator==().

Referenced by mainParameterSetID().

{
  return !operator==(rh);
}

bool art::ModuleDescription::operator<

(

ModuleDescription const &

rh

)

const

Definition at line 21 of file ModuleDescription.cc.

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

Referenced by mainParameterSetID().

{
  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;
  return false;
}

bool art::ModuleDescription::operator==

(

ModuleDescription const &

rh

)

const

Definition at line 45 of file ModuleDescription.cc.

Referenced by mainParameterSetID(), and operator!=().

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

fhicl::ParameterSetID const& art::ModuleDescription::parameterSetID ( ) const

inline

Definition at line 38 of file ModuleDescription.h.

References parameterSetID_.

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), operator<(), and write().

    {
      return parameterSetID_;
    }

ProcessConfiguration const& art::ModuleDescription::processConfiguration ( ) const

inline

Definition at line 53 of file ModuleDescription.h.

References processConfiguration_.

Referenced by art::RootOutput::doRegisterProducts(), art::OutputModule::doRespondToOpenInputFile(), art::Source< T >::finishProductRegistration_(), mainParameterSetID(), art::SourceHelper::makeEventPrincipal(), art::SourceHelper::makeRunPrincipal(), art::SourceHelper::makeSubRunPrincipal(), processConfigurationID(), processName(), releaseVersion(), and art::RootOutput::startEndFile().

    {
      return processConfiguration_;
    }

ProcessConfigurationID const art::ModuleDescription::processConfigurationID ( ) const

inline

Definition at line 58 of file ModuleDescription.h.

References art::ProcessConfiguration::id(), and processConfiguration().

    {
      return processConfiguration().id();
    }

std::string const& art::ModuleDescription::processName ( ) const

inline

Definition at line 63 of file ModuleDescription.h.

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

Referenced by art::DataViewImpl::getProductDescription(), operator<(), rndm::NuRandomServiceHelper::ArtState::set_process_name(), and write().

    {
      return processConfiguration().processName();
    }

std::string const& art::ModuleDescription::releaseVersion ( ) const

inline

Definition at line 68 of file ModuleDescription.h.

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

Referenced by operator<(), and write().

    {
      return processConfiguration().releaseVersion();
    }

void art::ModuleDescription::write

(

std::ostream &

os

)

const

Definition at line 57 of file ModuleDescription.cc.

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

Referenced by art::operator<<().

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

Member Data Documentation

ModuleDescriptionID art::ModuleDescription::id_ {invalidID()}

private

Definition at line 111 of file ModuleDescription.h.

Referenced by id(), and ModuleDescription().

std::string art::ModuleDescription::moduleLabel_ {}

private

Definition at line 105 of file ModuleDescription.h.

Referenced by ModuleDescription(), and moduleLabel().

std::string art::ModuleDescription::moduleName_ {}

private

Definition at line 101 of file ModuleDescription.h.

Referenced by ModuleDescription(), and moduleName().

fhicl::ParameterSetID art::ModuleDescription::parameterSetID_ {}

private

Definition at line 98 of file ModuleDescription.h.

Referenced by parameterSetID().

ProcessConfiguration art::ModuleDescription::processConfiguration_ {}

private

Definition at line 108 of file ModuleDescription.h.

Referenced by ModuleDescription(), and processConfiguration().

---

The documentation for this class was generated from the following files:

• canvas/Persistency/Provenance/ModuleDescription.h
• canvas/Persistency/Provenance/ModuleDescription.cc