art::Provenance Class Reference

#include "Provenance.h"

Public Member Functions
	Provenance ()
	Provenance (cet::exempt_ptr< Group const > g) noexcept
BranchDescription const &	productDescription () const noexcept
std::string const &	branchName () const noexcept
std::string const &	producedClassName () const noexcept
std::string const &	friendlyClassName () const noexcept
std::string const &	moduleLabel () const noexcept
std::string const &	productInstanceName () const noexcept
std::string const &	processName () const noexcept
InputTag	inputTag () const
RangeSet const &	rangeOfValidity () const
Parentage const &	parentage () const
std::vector< ProductID > const &	parents () const
fhicl::ParameterSet const &	parameterSet () const
std::set< fhicl::ParameterSetID > const &	psetIDs () const noexcept
ProductID	productID () const noexcept
bool	isValid () const noexcept
bool	isPresent () const
bool	produced () const noexcept
ProductStatus	productStatus () const
bool	equals (Provenance const &) const noexcept
std::ostream &	write (std::ostream &) const

Private Member Functions
ProductProvenance const &	productProvenance () const

Private Attributes
cet::exempt_ptr< Group const >	group_ {nullptr}

Detailed Description

Definition at line 35 of file Provenance.h.

Constructor & Destructor Documentation

art::Provenance::Provenance ( )

explicitdefault

art::Provenance::Provenance ( cet::exempt_ptr< Group const >  g )

explicitnoexcept

Definition at line 15 of file Provenance.cc.

: group_{g} {}

Member Function Documentation

string const & art::Provenance::branchName ( ) const

noexcept

Definition at line 42 of file Provenance.cc.

  {
    return productDescription().branchName();
  }

bool art::Provenance::equals ( Provenance const &  other ) const

noexcept

Definition at line 127 of file Provenance.cc.

References fhicl::other.

  {
    return group_ == other.group_;
  }

string const & art::Provenance::friendlyClassName ( ) const

noexcept

Definition at line 48 of file Provenance.cc.

Referenced by write_product_node().

  {
    return productDescription().friendlyClassName();
  }

InputTag art::Provenance::inputTag

(

)

const

Definition at line 91 of file Provenance.cc.

  {
    return productDescription().inputTag();
  }

bool art::Provenance::isPresent

(

)

const

Definition at line 115 of file Provenance.cc.

References art::productstatus::present().

Referenced by art::detail::PrincipalProcessor< DETAIL >::operator()().

  {
    return productstatus::present(productProvenance().productStatus());
  }

bool art::Provenance::isValid ( ) const

noexcept

Definition at line 18 of file Provenance.cc.

Referenced by art::Handle< T >::id(), and art::Handle< T >::isValid().

  {
    return static_cast<bool>(group_);
  }

string const & art::Provenance::moduleLabel ( ) const

noexcept

Definition at line 54 of file Provenance.cc.

Referenced by artg4tk::dataFromRunOrService(), recob::DumpPFParticles::DotFileName(), and write_module_id().

  {
    return productDescription().moduleLabel();
  }

fhicl::ParameterSet const & art::Provenance::parameterSet

(

)

const

Definition at line 84 of file Provenance.cc.

References util::begin(), and fhicl::ParameterSetRegistry::get().

  {
    return fhicl::ParameterSetRegistry::get(
      *productDescription().psetIDs().begin());
  }

Parentage const & art::Provenance::parentage

(

)

const

Definition at line 103 of file Provenance.cc.

  {
    return productProvenance().parentage();
  }

vector< ProductID > const & art::Provenance::parents

(

)

const

Definition at line 109 of file Provenance.cc.

References art::Parentage::parents().

Referenced by art::DataFlow::processEventProvenance().

  {
    return productProvenance().parentage().parents();
  }

string const & art::Provenance::processName ( ) const

noexcept

Definition at line 66 of file Provenance.cc.

Referenced by recob::DumpPFParticles::DotFileName(), write_module_id(), and write_module_node().

  {
    return productDescription().processName();
  }

bool art::Provenance::produced ( ) const

noexcept

Definition at line 30 of file Provenance.cc.

References art::BranchDescription::produced().

Referenced by art::Handle< T >::removeProduct().

  {
    return productDescription().produced();
  }

string const & art::Provenance::producedClassName ( ) const

noexcept

Definition at line 36 of file Provenance.cc.

  {
    return productDescription().producedClassName();
  }

BranchDescription const & art::Provenance::productDescription ( ) const

noexcept

Definition at line 24 of file Provenance.cc.

Referenced by art::Handle< T >::Handle().

  {
    return group_->productDescription();
  }

ProductID art::Provenance::productID ( ) const

noexcept

Definition at line 72 of file Provenance.cc.

Referenced by art::Handle< T >::id(), art::ValidHandle< T >::id(), and write_id().

  {
    return productDescription().productID();
  }

string const & art::Provenance::productInstanceName ( ) const

noexcept

Definition at line 60 of file Provenance.cc.

Referenced by artg4tk::dataFromRunOrService(), recob::DumpPFParticles::DotFileName(), and write_product_node().

  {
    return productDescription().productInstanceName();
  }

ProductProvenance const & art::Provenance::productProvenance ( ) const

private

Definition at line 133 of file Provenance.cc.

  {
    auto prov = group_->productProvenance();
    assert(prov != nullptr);
    return *prov;
  }

ProductStatus art::Provenance::productStatus

(

)

const

Definition at line 97 of file Provenance.cc.

  {
    return productProvenance().productStatus();
  }

set< fhicl::ParameterSetID > const & art::Provenance::psetIDs ( ) const

noexcept

Definition at line 78 of file Provenance.cc.

  {
    return productDescription().psetIDs();
  }

RangeSet const & art::Provenance::rangeOfValidity

(

)

const

Definition at line 121 of file Provenance.cc.

  {
    return group_->rangeOfValidity();
  }

ostream & art::Provenance::write

(

std::ostream &

os

)

const

Definition at line 147 of file Provenance.cc.

Referenced by art::operator<<().

  {
    // This is grossly inadequate, but it is not critical for the
    // first pass.
    productDescription().write(os);
    productProvenance().write(os);
    return os;
  }

Member Data Documentation

cet::exempt_ptr<Group const> art::Provenance::group_ {nullptr}

private

Definition at line 77 of file Provenance.h.

---

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

• art/Framework/Principal/Provenance.h
• art/Framework/Principal/Provenance.cc