Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
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
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_().

102  {
103  return id_;
104  } // Unique only within a process.
ModuleDescriptionID id_
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_().

110  {
112  }
T max(sqlite3 *const db, std::string const &table_name, std::string const &column_name)
Definition: statistics.h:68
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.

92  {
94  }
ProcessConfiguration const & processConfiguration() const
fhicl::ParameterSetID const & parameterSetID() const
std::string const& art::ModuleDescription::moduleLabel ( ) const
inline
std::string const& art::ModuleDescription::moduleName ( ) const
inline
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_.

42  {
43  return parameterSetID_;
44  }
fhicl::ParameterSetID parameterSetID_
bool art::ModuleDescription::parentageEnabled ( ) const
inline
ProcessConfiguration const& art::ModuleDescription::processConfiguration ( ) const
inline
ProcessConfigurationID const art::ModuleDescription::processConfigurationID ( ) const
inline

Definition at line 61 of file ModuleDescription.h.

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

62  {
63  return processConfiguration().id();
64  }
ProcessConfigurationID id() const
ProcessConfiguration const & processConfiguration() const
std::string const& art::ModuleDescription::processName ( ) const
inline

Definition at line 81 of file ModuleDescription.h.

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

82  {
84  }
std::string const & processName() const
ProcessConfiguration const & processConfiguration() const
bool art::ModuleDescription::rangesEnabled ( ) const
inline
std::string const& art::ModuleDescription::releaseVersion ( ) const
inline

Definition at line 86 of file ModuleDescription.h.

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

87  {
89  }
ReleaseVersion const & releaseVersion() const
ProcessConfiguration const & processConfiguration() const
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: