art::ModuleBase Class Reference

#include <ModuleBase.h>

Inheritance diagram for art::ModuleBase:

Public Member Functions
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Private Attributes
std::optional< ModuleDescription >	md_ {std::nullopt}
ConsumesCollector	collector_

Detailed Description

Definition at line 17 of file ModuleBase.h.

Constructor & Destructor Documentation

art::ModuleBase::~ModuleBase ( )

virtualdefaultnoexcept

art::ModuleBase::ModuleBase ( )

default

Member Function Documentation

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const &  tag )

protected

Definition at line 54 of file ModuleBase.h.

  {
    return collector_.consumes<T, BT>(tag);
  }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protected

Definition at line 53 of file ModuleBase.cc.

  {
    return collector_;
  }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protected

Definition at line 68 of file ModuleBase.h.

  {
    collector_.consumesMany<T, BT>();
  }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const &  )

protected

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView

(

InputTag const &

tag

)

Definition at line 61 of file ModuleBase.h.

  {
    return collector_.consumesView<T, BT>(tag);
  }

array< vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables

(

)

const

Definition at line 39 of file ModuleBase.cc.

  {
    return collector_.getConsumables();
  }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const &  tag )

protected

Definition at line 75 of file ModuleBase.h.

  {
    return collector_.mayConsume<T, BT>(tag);
  }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protected

Definition at line 89 of file ModuleBase.h.

  {
    collector_.mayConsumeMany<T, BT>();
  }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const &  )

protected

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView

(

InputTag const &

tag

)

Definition at line 82 of file ModuleBase.h.

  {
    return collector_.mayConsumeView<T, BT>(tag);
  }

ModuleDescription const & art::ModuleBase::moduleDescription

(

)

const

Definition at line 15 of file ModuleBase.cc.

  {
    if (md_.has_value()) {
      return *md_;
    }

    throw Exception{errors::LogicError,
                    "There was an error while calling moduleDescription().\n"}
      << "The moduleDescription() base-class member function cannot be called\n"
         "during module construction.  To determine which module is "
         "responsible\n"
         "for calling it, find the '<module type>:<module "
         "label>@Construction'\n"
         "tag in the message prefix above.  Please contact artists@fnal.gov\n"
         "for guidance.\n";
  }

void art::ModuleBase::setModuleDescription

(

ModuleDescription const &

md

)

Definition at line 33 of file ModuleBase.cc.

  {
    md_ = md;
  }

void art::ModuleBase::sortConsumables

(

std::string const &

current_process_name

)

Definition at line 45 of file ModuleBase.cc.

  {
    // Now that we know we have seen all the consumes declarations,
    // sort the results for fast lookup later.
    collector_.sortConsumables(current_process_name);
  }

Member Data Documentation

ConsumesCollector art::ModuleBase::collector_

private

Definition at line 49 of file ModuleBase.h.

std::optional<ModuleDescription> art::ModuleBase::md_ {std::nullopt}

private

Definition at line 48 of file ModuleBase.h.

---

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

• art/art/Framework/Core/ModuleBase.h
• art/art/Framework/Core/ModuleBase.cc