art::Provenance Class Reference

#include "Provenance.h"

Public Member Functions
constexpr	Provenance ()=default
	Provenance (cet::exempt_ptr< Group const > g)
BranchDescription const &	productDescription () const
std::string const &	branchName () const
std::string const &	producedClassName () const
std::string const &	friendlyClassName () const
std::string const &	moduleLabel () const
std::string const &	productInstanceName () const
std::string const &	processName () const
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
ProductID const &	productID () const
bool	isValid () const
bool	isPresent () const
bool	produced () const
ProductStatus const &	productStatus () const
std::ostream &	write (std::ostream &os) const
bool	equals (Provenance const &other) const

Private Member Functions
ProductProvenance const &	productProvenance () const

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

Detailed Description

Definition at line 39 of file Provenance.h.

Constructor & Destructor Documentation

constexpr art::Provenance::Provenance ( )

explicitdefault

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

inlineexplicit

Definition at line 42 of file Provenance.h.

: group_{g} {}

Member Function Documentation

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

inline

Definition at line 53 of file Provenance.h.

References art::BranchDescription::branchName(), and productDescription().

  {
    return productDescription().branchName();
  }

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

inline

Definition at line 143 of file Provenance.h.

References group_.

Referenced by art::operator==().

  {
    return group_ == other.group_;
  }

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

inline

Definition at line 63 of file Provenance.h.

References art::BranchDescription::friendlyClassName(), and productDescription().

Referenced by write_product_node().

  {
    return productDescription().friendlyClassName();
  }

InputTag art::Provenance::inputTag ( ) const

inline

Definition at line 83 of file Provenance.h.

References art::BranchDescription::inputTag(), and productDescription().

  {
    return productDescription().inputTag();
  }

bool art::Provenance::isPresent ( ) const

inline

Definition at line 125 of file Provenance.h.

References art::productstatus::present(), and productStatus().

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

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

bool art::Provenance::isValid ( ) const

inline

Definition at line 120 of file Provenance.h.

References group_.

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

  {
    return static_cast<bool>(group_);
  }

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

inline

Definition at line 68 of file Provenance.h.

References art::BranchDescription::moduleLabel(), and productDescription().

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

  {
    return productDescription().moduleLabel();
  }

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

(

)

const

Definition at line 18 of file Provenance.cc.

References evd::details::begin(), fhicl::ParameterSetRegistry::get(), and psetIDs().

Referenced by parents().

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

Parentage const& art::Provenance::parentage ( ) const

inline

Definition at line 95 of file Provenance.h.

References art::ProductProvenance::parentage(), and productProvenance().

Referenced by parents().

  {
    return productProvenance().parentage();
  }

std::vector<ProductID> const& art::Provenance::parents ( void  ) const

inline

Definition at line 100 of file Provenance.h.

References parameterSet(), parentage(), and art::Parentage::parents().

Referenced by art::DataFlow::processEventProvenance(), and art::DataViewImpl::recordAsParent().

  {
    return parentage().parents();
  }

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

inline

Definition at line 78 of file Provenance.h.

References art::BranchDescription::processName(), and productDescription().

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

  {
    return productDescription().processName();
  }

bool art::Provenance::produced ( ) const

inline

Definition at line 130 of file Provenance.h.

References art::BranchDescription::produced(), and productDescription().

  {
    return productDescription().produced();
  }

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

inline

Definition at line 58 of file Provenance.h.

References art::BranchDescription::producedClassName(), and productDescription().

  {
    return productDescription().producedClassName();
  }

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

inline

Definition at line 46 of file Provenance.h.

References group_.

Referenced by branchName(), friendlyClassName(), art::Handle< T >::Handle(), inputTag(), moduleLabel(), processName(), produced(), producedClassName(), productInstanceName(), psetIDs(), art::DataViewImpl::recordAsParent(), and write().

  {
    return group_->productDescription();
  }

ProductID const& art::Provenance::productID ( ) const

inline

Definition at line 113 of file Provenance.h.

References group_.

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

  {
    return group_->productID();
  }

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

inline

Definition at line 73 of file Provenance.h.

References productDescription(), and art::BranchDescription::productInstanceName().

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

  {
    return productDescription().productInstanceName();
  }

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

inlineprivate

Definition at line 152 of file Provenance.h.

References group_.

Referenced by parentage(), productStatus(), and write().

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

ProductStatus const& art::Provenance::productStatus ( ) const

inline

Definition at line 135 of file Provenance.h.

References productProvenance(), art::ProductProvenance::productStatus(), and write().

Referenced by isPresent().

  {
    return productProvenance().productStatus();
  }

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

inline

Definition at line 106 of file Provenance.h.

References productDescription(), and art::BranchDescription::psetIDs().

Referenced by parameterSet().

  {
    return productDescription().psetIDs();
  }

RangeSet const& art::Provenance::rangeOfValidity ( ) const

inline

Definition at line 90 of file Provenance.h.

References group_.

  {
    return group_->rangeOfValidity();
  }

std::ostream & art::Provenance::write

(

std::ostream &

os

)

const

Definition at line 24 of file Provenance.cc.

References productDescription(), productProvenance(), art::ProductProvenance::write(), and art::BranchDescription::write().

Referenced by art::operator<<(), and productStatus().

{
  // 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 149 of file Provenance.h.

Referenced by equals(), isValid(), productDescription(), productID(), productProvenance(), and rangeOfValidity().

---

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

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