art::ModuleDescription Class Reference

#include "/cvmfs/nova.opensciencegrid.org/externals/canvas/v3_06_01/source/canvas/Persistency/Provenance/ModuleDescription.h"

Public Member Functions
	ModuleDescription ()=default
	ModuleDescription (fhicl::ParameterSetID parameterSetID, std::string const &modName, std::string const &modLabel, ProcessConfiguration pc, bool const parentageEnabled=true, bool const rangesEnabled=true, bool const dbEnabled=true, 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
bool	parentageEnabled () const
bool	rangesEnabled () const
bool	dbEnabled () 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_ {}
bool	parentageEnabled_ {true}
bool	rangesEnabled_ {true}
bool	dbEnabled_ {true}
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, bool const  parentageEnabled = true, bool const  rangesEnabled = true, bool const  dbEnabled = true, ModuleDescriptionID  id = getUniqueID()  )

explicit

Member Function Documentation

bool art::ModuleDescription::dbEnabled ( ) const

inline

Definition at line 76 of file ModuleDescription.h.

References dbEnabled_, and string.

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

    {
      return dbEnabled_;
    }

static ModuleDescriptionID art::ModuleDescription::getUniqueID ( )

static

Referenced by id().

ModuleDescriptionID art::ModuleDescription::id ( ) const

inline

Definition at line 101 of file ModuleDescription.h.

References getUniqueID(), and id_.

Referenced by art::Source< T >::finishProductRegistration_().

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

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

inlinestatic

Definition at line 109 of file ModuleDescription.h.

References cet::sqlite::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 91 of file ModuleDescription.h.

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

    {
      return processConfiguration().parameterSetID();
    }

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

inline

Definition at line 51 of file ModuleDescription.h.

References moduleLabel_.

Referenced by art::RootOutput::doRegisterProducts(), art::detail::exceptionContext(), art::ProducerBase::getProductID(), art::CurrentModule::label(), art::Worker::label(), art::Tracer::postModuleBeginJob(), art::Tracer::postModuleBeginRun(), art::Tracer::postModuleBeginSubRun(), art::Tracer::postModuleConstruction(), art::Tracer::postModuleEndJob(), art::Tracer::postModuleEndRun(), art::Tracer::postModuleEndSubRun(), art::Tracer::postModuleEvent(), 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(), and art::TFileService::setDirectoryName_().

    {
      return moduleLabel_;
    }

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

inline

Definition at line 46 of file ModuleDescription.h.

References moduleName_, and string.

Referenced by art::detail::exceptionContext(), art::TimeTracker::postSourceConstruction(), art::MemoryTracker::recordModuleData(), art::MemoryTracker::recordOtherData(), art::TimeTracker::recordTime(), and art::TFileService::setDirectoryName_().

    {
      return moduleName_;
    }

bool art::ModuleDescription::operator!=

(

ModuleDescription const &

rh

)

const

Referenced by mainParameterSetID().

bool art::ModuleDescription::operator<

(

ModuleDescription const &

rh

)

const

Referenced by mainParameterSetID().

bool art::ModuleDescription::operator==

(

ModuleDescription const &

rh

)

const

Referenced by mainParameterSetID().

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

inline

Definition at line 41 of file ModuleDescription.h.

References parameterSetID_, and string.

    {
      return parameterSetID_;
    }

bool art::ModuleDescription::parentageEnabled ( ) const

inline

Definition at line 66 of file ModuleDescription.h.

References parentageEnabled_.

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

    {
      return parentageEnabled_;
    }

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

inline

Definition at line 56 of file ModuleDescription.h.

References processConfiguration_.

Referenced by art::RootOutput::doRegisterProducts(), art::Source< T >::finishProductRegistration_(), mainParameterSetID(), processConfigurationID(), processName(), releaseVersion(), art::SamplingInput::SamplingInput(), and art::RootOutput::startEndFile().

    {
      return processConfiguration_;
    }

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

inline

Definition at line 61 of file ModuleDescription.h.

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

    {
      return processConfiguration().id();
    }

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

inline

Definition at line 81 of file ModuleDescription.h.

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

    {
      return processConfiguration().processName();
    }

bool art::ModuleDescription::rangesEnabled ( ) const

inline

Definition at line 71 of file ModuleDescription.h.

References rangesEnabled_.

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

    {
      return rangesEnabled_;
    }

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

inline

Definition at line 86 of file ModuleDescription.h.

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

    {
      return processConfiguration().releaseVersion();
    }

void art::ModuleDescription::write

(

std::ostream &

os

)

const

Referenced by art::operator<<().

Member Data Documentation

bool art::ModuleDescription::dbEnabled_ {true}

private

Definition at line 132 of file ModuleDescription.h.

Referenced by dbEnabled().

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

private

Definition at line 135 of file ModuleDescription.h.

Referenced by id().

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

private

Definition at line 123 of file ModuleDescription.h.

Referenced by moduleLabel().

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

private

Definition at line 119 of file ModuleDescription.h.

Referenced by moduleName().

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

private

Definition at line 116 of file ModuleDescription.h.

Referenced by parameterSetID().

bool art::ModuleDescription::parentageEnabled_ {true}

private

Definition at line 128 of file ModuleDescription.h.

Referenced by parentageEnabled().

ProcessConfiguration art::ModuleDescription::processConfiguration_ {}

private

Definition at line 126 of file ModuleDescription.h.

Referenced by processConfiguration().

bool art::ModuleDescription::rangesEnabled_ {true}

private

Definition at line 130 of file ModuleDescription.h.

Referenced by rangesEnabled().

---

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

• canvas/Persistency/Provenance/ModuleDescription.h