edm::Provenance Class Reference

#include <Provenance.h>

Public Member Functions
std::set< std::string > const &	branchAliases () const
BranchDescription const &	branchDescription () const
BranchID const &	branchID () const
std::string const &	branchName () const
std::string const &	className () const
BranchDescription const &	constBranchDescription () const
boost::shared_ptr < BranchDescription const > const &	constBranchDescriptionPtr () const
Parentage const &	event () const
std::string const &	friendlyClassName () const
bool	getProcessConfiguration (ProcessConfiguration &pc) const
std::string const &	moduleLabel () const
Parentage const &	parentage () const
std::vector< BranchID > const &	parents () const
ProcessHistory const &	processHistory () const
std::string const &	processName () const
BranchDescription const &	product () const
ProductID const &	productID () const
std::string const &	productInstanceName () const
ProductProvenance *	productProvenance () const
bool	productProvenanceValid () const
	Provenance ()
	Provenance (boost::shared_ptr< BranchDescription const > const &p, ProductID const &pid)
ReleaseVersion	releaseVersion () const
void	resetProductProvenance () const
ProductProvenance *	resolve () const
void	setBranchDescription (boost::shared_ptr< BranchDescription const > const &p)
void	setProcessHistory (ProcessHistory const &ph)
void	setProductID (ProductID const &pid)
void	setProductProvenance (ProductProvenance const &prov) const
void	setStore (boost::shared_ptr< ProductProvenanceRetriever > store) const
boost::shared_ptr < ProductProvenanceRetriever > const &	store () const
void	swap (Provenance &)
void	write (std::ostream &os) const

Private Attributes
boost::shared_ptr < BranchDescription const >	branchDescription_
ProcessHistory const *	processHistory_
ProductID	productID_
boost::shared_ptr < ProductProvenance >	productProvenancePtr_
bool	productProvenanceValid_
boost::shared_ptr < ProductProvenanceRetriever >	store_

Detailed Description

Definition at line 35 of file Provenance.h.

Constructor & Destructor Documentation

edm::Provenance::Provenance

(

)

Definition at line 17 of file Provenance.cc.

                         : Provenance{boost::shared_ptr<BranchDescription const>(), ProductID()} {
  }

edm::Provenance::Provenance	(	boost::shared_ptr< BranchDescription const > const &	p,
		ProductID const &	pid
	)

Definition at line 20 of file Provenance.cc.

                                                                                                :
    branchDescription_(p),
    productID_(pid),
    processHistory_(),
    productProvenanceValid_(false),
    productProvenancePtr_(new ProductProvenance),
    store_() {
  }

Member Function Documentation

std::set<std::string> const& edm::Provenance::branchAliases ( ) const

inline

Definition at line 68 of file Provenance.h.

References edm::BranchDescription::branchAliases(), and product().

{return product().branchAliases();}

BranchDescription const& edm::Provenance::branchDescription ( ) const

inline

Definition at line 44 of file Provenance.h.

References branchDescription_.

Referenced by FWFFMetadataManager::doUpdate().

{return *branchDescription_;}

BranchID const& edm::Provenance::branchID ( ) const

inline

Definition at line 57 of file Provenance.h.

References edm::BranchDescription::branchID(), and product().

Referenced by edm::LuminosityBlock::addToGotBranchIDs(), edm::Run::addToGotBranchIDs(), and edm::Event::addToGotBranchIDs().

{return product().branchID();}

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

inline

Definition at line 58 of file Provenance.h.

References edm::BranchDescription::branchName(), and product().

Referenced by HLTJetTag< T >::hltFilter().

{return product().branchName();}

std::string const& edm::Provenance::className ( ) const

inline

Definition at line 59 of file Provenance.h.

References edm::BranchDescription::className(), and product().

{return product().className();}

BranchDescription const& edm::Provenance::constBranchDescription ( ) const

inline

Definition at line 45 of file Provenance.h.

References branchDescription_.

Referenced by HLTJetTag< T >::hltFilter().

{return *branchDescription_;}

boost::shared_ptr<BranchDescription const> const& edm::Provenance::constBranchDescriptionPtr ( ) const

inline

Definition at line 46 of file Provenance.h.

References branchDescription_.

Referenced by edm::ProductData::branchDescription().

{return branchDescription_;}

Parentage const& edm::Provenance::event ( ) const

inline

Definition at line 41 of file Provenance.h.

References parentage().

Referenced by Types.EventID::cppID().

{return parentage();}

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

inline

Definition at line 63 of file Provenance.h.

References edm::BranchDescription::friendlyClassName(), and product().

{return product().friendlyClassName();}

bool edm::Provenance::getProcessConfiguration

(

ProcessConfiguration &

pc

)

const

Definition at line 45 of file Provenance.cc.

References edm::ProcessHistory::getConfigurationForProcess(), processHistory_, and processName().

Referenced by edm::parameterSet(), and releaseVersion().

                                                                    {
    return processHistory_->getConfigurationForProcess(processName(), pc);
  }

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

inline

Definition at line 60 of file Provenance.h.

References edm::BranchDescription::moduleLabel(), and product().

Referenced by TriggerSummaryProducerAOD::fillFilterObjectMembers(), TriggerSummaryProducerAOD::fillTriggerObjectCollections(), HLTDoubletDZ< T1, T2 >::hltFilter(), HLTDoublet< T1, T2 >::hltFilter(), EcalDeadCellTriggerPrimitiveFilter::loadEventInfoForFilter(), PFCandidateMixer::mix(), edm::moduleName(), edm::parameterSet(), L3TkMuonProducer::produce(), cms::TrackListMerger::produce(), cms::SimpleTrackListMerger::produce(), and reco::modules::DuplicateListMerger::produce().

{return product().moduleLabel();}

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

inline

Definition at line 56 of file Provenance.h.

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

Referenced by event(), and parents().

{return productProvenance()->parentage();}

std::vector<BranchID> const& edm::Provenance::parents ( ) const

inline

Definition at line 70 of file Provenance.h.

References parentage(), and edm::Parentage::parents().

{return parentage().parents();}

ProcessHistory const& edm::Provenance::processHistory ( ) const

inline

Definition at line 65 of file Provenance.h.

References processHistory_.

Referenced by edm::SubProcess::propagateProducts().

{return *processHistory_;}

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

inline

Definition at line 61 of file Provenance.h.

References edm::BranchDescription::processName(), and product().

Referenced by TriggerSummaryProducerAOD::fillFilterObjectMembers(), TriggerSummaryProducerAOD::fillTriggerObjectCollections(), getProcessConfiguration(), HLTDoubletDZ< T1, T2 >::hltFilter(), HLTDoublet< T1, T2 >::hltFilter(), PFCandidateMixer::mix(), L3TkMuonProducer::produce(), cms::SimpleTrackListMerger::produce(), cms::TrackListMerger::produce(), and reco::modules::DuplicateListMerger::produce().

{return product().processName();}

BranchDescription const& edm::Provenance::product ( ) const

inline

Definition at line 42 of file Provenance.h.

References branchDescription_.

Referenced by branchAliases(), branchID(), branchName(), className(), GlobalHitsAnalyzer::fillG4MC(), GlobalHitsProdHist::fillG4MC(), GlobalHitsProducer::fillG4MC(), friendlyClassName(), edm::ProductData::getInterface(), moduleLabel(), edm::operator==(), processName(), productInstanceName(), and write().

{return *branchDescription_;}

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

inline

Definition at line 78 of file Provenance.h.

References productID_.

Referenced by edm::HandleBase::id(), edm::Handle< GenericObject >::id(), edm::BasicHandle::id(), edm::Handle< FWGenericObject >::id(), edm::ProductHolderBase::productID(), and edm::SubProcess::propagateProducts().

{return productID_;}

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

inline

Definition at line 62 of file Provenance.h.

References product(), and edm::BranchDescription::productInstanceName().

Referenced by TriggerSummaryProducerAOD::fillFilterObjectMembers(), TriggerSummaryProducerAOD::fillTriggerObjectCollections(), HLTDoubletDZ< T1, T2 >::hltFilter(), HLTDoublet< T1, T2 >::hltFilter(), PFCandidateMixer::mix(), L3TkMuonProducer::produce(), cms::TrackListMerger::produce(), cms::SimpleTrackListMerger::produce(), and reco::modules::DuplicateListMerger::produce().

{return product().productInstanceName();}

ProductProvenance* edm::Provenance::productProvenance ( ) const

inline

Definition at line 49 of file Provenance.h.

References productProvenancePtr_, productProvenanceValid_, and resolve().

Referenced by parentage(), edm::InputProductHolder::productProvenancePtr_(), edm::ProducedProductHolder::productProvenancePtr_(), edm::AliasProductHolder::productProvenancePtr_(), edm::SubProcess::propagateProducts(), and write().

                                                 {
      if (productProvenanceValid_) return productProvenancePtr_.get();
      return resolve();
    }

bool edm::Provenance::productProvenanceValid ( ) const

inline

Definition at line 53 of file Provenance.h.

References productProvenanceValid_.

Referenced by edm::SubProcess::propagateProducts().

                                        {
      return productProvenanceValid_;
    }

ReleaseVersion edm::Provenance::releaseVersion

(

)

const

Definition at line 50 of file Provenance.cc.

References getProcessConfiguration(), and edm::ProcessConfiguration::releaseVersion().

                                   {
    ProcessConfiguration pc;
    assert(getProcessConfiguration(pc));
    return pc.releaseVersion();
  }

void edm::Provenance::resetProductProvenance

(

)

const

Definition at line 72 of file Provenance.cc.

References productProvenancePtr_, and productProvenanceValid_.

Referenced by edm::SubProcess::propagateProducts(), and edm::ProductData::resetProductData().

                                           {
    *productProvenancePtr_ = ProductProvenance();
    productProvenanceValid_ = false;
  }

ProductProvenance * edm::Provenance::resolve

(

)

const

Definition at line 30 of file Provenance.cc.

References branchDescription_, productProvenancePtr_, productProvenanceValid_, and store_.

Referenced by SequenceTypes._ModuleSequenceType::insertInto(), and productProvenance().

                            {
    if(!store_) {
      return nullptr;
    }
    if (!productProvenanceValid_) {
      ProductProvenance const* prov  = store_->branchIDToProvenance(branchDescription_->branchID());
      if (prov) {
        *productProvenancePtr_ = *prov;
        productProvenanceValid_ = true;
      }
    }
    return productProvenancePtr_.get();
  }

void edm::Provenance::setBranchDescription ( boost::shared_ptr< BranchDescription const > const &  p )

inline

Definition at line 86 of file Provenance.h.

References branchDescription_, and AlCaHLTBitMon_ParallelJobs::p.

Referenced by edm::ProductData::resetBranchDescription().

                                                                                 {
      branchDescription_ = p;
    }

void edm::Provenance::setProcessHistory ( ProcessHistory const &  ph )

inline

Definition at line 76 of file Provenance.h.

References processHistory_.

Referenced by edm::SubProcess::propagateProducts(), edm::InputProductHolder::setProcessHistory_(), edm::ProducedProductHolder::setProcessHistory_(), edm::AliasProductHolder::setProcessHistory_(), edm::InputProductHolder::setProvenance_(), edm::ProducedProductHolder::setProvenance_(), and edm::AliasProductHolder::setProvenance_().

{processHistory_ = &ph;}

void edm::Provenance::setProductID ( ProductID const &  pid )

inline

Definition at line 82 of file Provenance.h.

References sysUtil::pid, and productID_.

Referenced by edm::SubProcess::propagateProducts(), edm::InputProductHolder::setProvenance_(), edm::ProducedProductHolder::setProvenance_(), and edm::AliasProductHolder::setProvenance_().

                                            {
      productID_ = pid;
    }

void edm::Provenance::setProductProvenance

(

ProductProvenance const &

prov

)

const

Definition at line 78 of file Provenance.cc.

References productProvenancePtr_, and productProvenanceValid_.

Referenced by edm::SubProcess::propagateProducts(), and edm::ProductHolderBase::setProductProvenance().

                                                                      {
    *productProvenancePtr_ = prov;
    productProvenanceValid_ = true;
  }

void edm::Provenance::setStore ( boost::shared_ptr< ProductProvenanceRetriever >  store ) const

inline

Definition at line 74 of file Provenance.h.

References store(), and store_.

Referenced by edm::SubProcess::propagateProducts(), edm::InputProductHolder::setProvenance_(), edm::ProducedProductHolder::setProvenance_(), and edm::AliasProductHolder::setProvenance_().

{store_ = store;}

boost::shared_ptr<ProductProvenanceRetriever> const& edm::Provenance::store ( ) const

inline

Definition at line 64 of file Provenance.h.

References store_.

Referenced by edm::SubProcess::propagateProducts(), and setStore().

{return store_;}

void edm::Provenance::swap

(

Provenance &

iOther

)

Definition at line 84 of file Provenance.cc.

References branchDescription_, processHistory_, productID_, productProvenancePtr_, productProvenanceValid_, store_, edm::ProductID::swap(), and std::swap().

Referenced by edm::ProductData::swap().

                                     {
    branchDescription_.swap(iOther.branchDescription_);
    productID_.swap(iOther.productID_);
    std::swap(processHistory_, iOther.processHistory_);
    std::swap(productProvenanceValid_, iOther.productProvenanceValid_);
    productProvenancePtr_.swap(iOther.productProvenancePtr_);
    store_.swap(iOther.store_);
 }

void edm::Provenance::write

(

std::ostream &

os

)

const

Definition at line 57 of file Provenance.cc.

References createTree::pp, product(), productProvenance(), edm::ProductProvenance::write(), and edm::BranchDescription::write().

Referenced by pkg.AbstractPkg::generate(), and edm::operator<<().

                                        {
    // This is grossly inadequate, but it is not critical for the
    // first pass.
    product().write(os);
    ProductProvenance* pp = productProvenance();
    if (pp != nullptr) {
      pp->write(os);
    }
  }

Member Data Documentation

boost::shared_ptr<BranchDescription const> edm::Provenance::branchDescription_

private

Definition at line 95 of file Provenance.h.

Referenced by branchDescription(), constBranchDescription(), constBranchDescriptionPtr(), product(), resolve(), setBranchDescription(), and swap().

ProcessHistory const* edm::Provenance::processHistory_

private

Definition at line 97 of file Provenance.h.

Referenced by getProcessConfiguration(), processHistory(), setProcessHistory(), and swap().

ProductID edm::Provenance::productID_

private

Definition at line 96 of file Provenance.h.

Referenced by productID(), setProductID(), and swap().

boost::shared_ptr<ProductProvenance> edm::Provenance::productProvenancePtr_

mutableprivate

Definition at line 99 of file Provenance.h.

Referenced by productProvenance(), resetProductProvenance(), resolve(), setProductProvenance(), and swap().

bool edm::Provenance::productProvenanceValid_

mutableprivate

Definition at line 98 of file Provenance.h.

Referenced by productProvenance(), productProvenanceValid(), resetProductProvenance(), resolve(), setProductProvenance(), and swap().

boost::shared_ptr<ProductProvenanceRetriever> edm::Provenance::store_

mutableprivate

Definition at line 100 of file Provenance.h.

Referenced by resolve(), setStore(), store(), and swap().