art::ModuleDescription Class Reference

#include <ModuleDescription.h>

Public Member Functions
	~ModuleDescription ()
	ModuleDescription ()
	ModuleDescription (fhicl::ParameterSetID parameterSetID, std::string const &modName, std::string const &modLabel, ModuleThreadingType moduleThreadingType, ProcessConfiguration pc, bool isEmulated=false)
void	write (std::ostream &os) const
fhicl::ParameterSetID const &	parameterSetID () const
std::string const &	moduleName () const
std::string const &	moduleLabel () const
bool	isEmulatedModule () const
ModuleThreadingType	moduleThreadingType () 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

Private Attributes
fhicl::ParameterSetID	parameterSetID_ {}
std::string	moduleName_ {}
std::string	moduleLabel_ {}
ModuleThreadingType	moduleThreadingType_ {}
bool	isEmulated_ {false}
ProcessConfiguration	processConfiguration_

Detailed Description

Definition at line 14 of file ModuleDescription.h.

Constructor & Destructor Documentation

art::ModuleDescription::~ModuleDescription ( )

default

art::ModuleDescription::ModuleDescription ( )

explicitdefault

art::ModuleDescription::ModuleDescription ( fhicl::ParameterSetID  parameterSetID, std::string const &  modName, std::string const &  modLabel, ModuleThreadingType  moduleThreadingType, ProcessConfiguration  pc, bool  isEmulated = false  )

explicit

Definition at line 16 of file ModuleDescription.cc.

    : parameterSetID_{parameterSetID}
    , moduleName_{modName}
    , moduleLabel_{modLabel}
    , moduleThreadingType_{moduleThreadingType}
    , isEmulated_{isEmulated}
    , processConfiguration_{move(pc)}
  {}

Member Function Documentation

bool art::ModuleDescription::isEmulatedModule

(

)

const

Definition at line 50 of file ModuleDescription.cc.

  {
    return isEmulated_;
  }

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

(

)

const

Definition at line 86 of file ModuleDescription.cc.

  {
    return processConfiguration().parameterSetID();
  }

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

(

)

const

Definition at line 44 of file ModuleDescription.cc.

  {
    return moduleLabel_;
  }

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

(

)

const

Definition at line 38 of file ModuleDescription.cc.

  {
    return moduleName_;
  }

ModuleThreadingType art::ModuleDescription::moduleThreadingType

(

)

const

Definition at line 56 of file ModuleDescription.cc.

  {
    return moduleThreadingType_;
  }

bool art::ModuleDescription::operator!=

(

ModuleDescription const &

rh

)

const

Definition at line 131 of file ModuleDescription.cc.

  {
    return !operator==(rh);
  }

bool art::ModuleDescription::operator<

(

ModuleDescription const &

rh

)

const

Definition at line 92 of file ModuleDescription.cc.

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

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

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

(

)

const

Definition at line 32 of file ModuleDescription.cc.

  {
    return parameterSetID_;
  }

ProcessConfiguration const & art::ModuleDescription::processConfiguration

(

)

const

Definition at line 62 of file ModuleDescription.cc.

  {
    return processConfiguration_;
  }

ProcessConfigurationID const art::ModuleDescription::processConfigurationID

(

)

const

Definition at line 68 of file ModuleDescription.cc.

  {
    return processConfiguration().id();
  }

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

(

)

const

Definition at line 74 of file ModuleDescription.cc.

  {
    return processConfiguration().processName();
  }

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

(

)

const

Definition at line 80 of file ModuleDescription.cc.

  {
    return processConfiguration().releaseVersion();
  }

void art::ModuleDescription::write

(

std::ostream &

os

)

const

Definition at line 137 of file ModuleDescription.cc.

  {
    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

bool art::ModuleDescription::isEmulated_ {false}

private

Definition at line 50 of file ModuleDescription.h.

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

private

Definition at line 48 of file ModuleDescription.h.

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

private

Definition at line 47 of file ModuleDescription.h.

ModuleThreadingType art::ModuleDescription::moduleThreadingType_ {}

private

Definition at line 49 of file ModuleDescription.h.

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

private

Definition at line 46 of file ModuleDescription.h.

ProcessConfiguration art::ModuleDescription::processConfiguration_

private

Initial value:

{"invalid_process",
                                               fhicl::ParameterSetID{},
                                               ReleaseVersion{}}

Definition at line 53 of file ModuleDescription.h.

---

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

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