art::Run Class Reference

#include "Run.h"

Inheritance diagram for art::Run:

Public Types
using	Base = DataViewImpl
template<typename T >
using	HandleT = Handle< T >

Public Member Functions
	Run (RunPrincipal const &rp, ModuleDescription const &md, cet::exempt_ptr< Consumer > consumer, RangeSet const &rsForPuttingProducts=RangeSet::invalid())
RunID const &	id () const
RunNumber_t	run () const
Timestamp const &	beginTime () const
Timestamp const &	endTime () const
template<typename PROD >
art::ProductID	put (std::unique_ptr< PROD > &&)
template<typename PROD >
art::ProductID	put (std::unique_ptr< PROD > &&, FullSemantic< Level::Run >)
template<typename PROD >
art::ProductID	put (std::unique_ptr< PROD > &&, FragmentSemantic< Level::Run >)
template<typename PROD >
art::ProductID	put (std::unique_ptr< PROD > &&, RangedFragmentSemantic< Level::Run >)
template<typename PROD >
art::ProductID	put (std::unique_ptr< PROD > &&, std::string const &instanceName)
template<typename PROD >
art::ProductID	put (std::unique_ptr< PROD > &&, std::string const &instanceName, FullSemantic< Level::Run >)
template<typename PROD >
art::ProductID	put (std::unique_ptr< PROD > &&, std::string const &instanceName, FragmentSemantic< Level::Run >)
template<typename PROD >
art::ProductID	put (std::unique_ptr< PROD > &&, std::string const &instanceName, RangedFragmentSemantic< Level::Run >)
bool	getProcessParameterSet (std::string const &processName, std::vector< fhicl::ParameterSet > &ps) const
EDProductGetter const *	productGetter (ProductID const pid) const
void	commit (RunPrincipal &rp, bool const checkProducts, std::set< TypeLabel > const &expectedProducts)
void	commit (RunPrincipal &)

Private Types
using	RetrievedProductIDs = std::vector< ProductID >
using	RetrievedProductSet = std::set< ProductID >
using	TypeLabelMap = std::map< TypeLabel, PMValue >
using	GroupQueryResultVec = std::vector< GroupQueryResult >

Private Member Functions
template<typename PROD >
art::ProductID	put_ (std::unique_ptr< PROD > &&product, std::string const &productInstanceName, RangeSet const &rs)
	Put a new product with a 'product instance name' and a 'range set'. More...
size_t	size () const
template<typename PROD >
bool	get (SelectorBase const &, Handle< PROD > &result) const
template<typename PROD >
bool	get (ProductID const pid, Handle< PROD > &result) const
template<typename PROD >
bool	getByLabel (std::string const &label, std::string const &productInstanceName, Handle< PROD > &result) const
template<typename PROD >
bool	getByLabel (std::string const &label, std::string const &productInstanceName, std::string const &processName, Handle< PROD > &result) const
template<typename PROD >
PROD const &	getByLabel (InputTag const &tag) const
	same as above, but using the InputTag class More...
template<typename PROD >
bool	getByLabel (InputTag const &tag, Handle< PROD > &result) const
template<typename PROD >
PROD const *	getPointerByLabel (InputTag const &tag) const
template<typename PROD >
bool	getByToken (ProductToken< PROD > const &token, Handle< PROD > &result) const
template<typename PROD >
ValidHandle< PROD >	getValidHandle (InputTag const &tag) const
template<typename PROD >
ValidHandle< PROD >	getValidHandle (ProductToken< PROD > const &token) const
template<typename PROD >
art::ValidHandle< PROD >	getValidHandle (InputTag const &tag) const
template<typename PROD >
art::ValidHandle< PROD >	getValidHandle (ProductToken< PROD > const &token) const
template<typename PROD >
void	getMany (SelectorBase const &, std::vector< Handle< PROD >> &results) const
template<typename PROD >
void	getManyByType (std::vector< Handle< PROD >> &results) const
template<typename ELEMENT >
std::size_t	getView (std::string const &moduleLabel, std::string const &productInstanceName, std::vector< ELEMENT const * > &result) const
template<typename ELEMENT >
std::size_t	getView (InputTag const &tag, std::vector< ELEMENT const * > &result) const
template<typename ELEMENT >
std::size_t	getView (ViewToken< ELEMENT > const &token, std::vector< ELEMENT const * > &result) const
template<typename ELEMENT >
bool	getView (std::string const &moduleLabel, std::string const &instanceName, View< ELEMENT > &result) const
template<typename ELEMENT >
bool	getView (InputTag const &tag, View< ELEMENT > &result) const
template<typename ELEMENT >
bool	getView (ViewToken< ELEMENT > const &tag, View< ELEMENT > &result) const
template<typename PROD >
bool	removeCachedProduct (Handle< PROD > &h) const
ProcessHistory const &	processHistory () const
void	recordAsParent (Provenance const &prov) const
TypeLabelMap &	putProducts ()
TypeLabelMap const &	putProducts () const
RetrievedProductSet const &	retrievedProducts () const
RetrievedProductIDs	retrievedProductIDs () const
void	checkPutProducts (bool checkProducts, std::set< TypeLabel > const &expectedProducts, TypeLabelMap const &putProducts)
BranchDescription const &	getProductDescription (TypeID const &type, std::string const &productInstanceName) const
template<typename ELEMENT >
art::DataViewImpl::GroupQueryResultVec	getView_ (std::string const &moduleLabel, std::string const &productInstanceName, std::string const &processName) const

Private Attributes
Principal const &	principal_
RunAuxiliary const &	aux_
RangeSet	productRangeSet_

Detailed Description

Definition at line 30 of file Run.h.

Member Typedef Documentation

using art::Run::Base = DataViewImpl

Definition at line 32 of file Run.h.

using art::DataViewImpl::GroupQueryResultVec = std::vector<GroupQueryResult>

protectedinherited

Definition at line 214 of file DataViewImpl.h.

template<typename T >

using art::Run::HandleT = Handle<T>

Definition at line 126 of file Run.h.

using art::DataViewImpl::RetrievedProductIDs = std::vector<ProductID>

inherited

Definition at line 175 of file DataViewImpl.h.

using art::DataViewImpl::RetrievedProductSet = std::set<ProductID>

inherited

Definition at line 176 of file DataViewImpl.h.

using art::DataViewImpl::TypeLabelMap = std::map<TypeLabel, PMValue>

inherited

Definition at line 177 of file DataViewImpl.h.

Constructor & Destructor Documentation

art::Run::Run ( RunPrincipal const &  rp, ModuleDescription const &  md, cet::exempt_ptr< Consumer >  consumer, RangeSet const &  rsForPuttingProducts = RangeSet::invalid()  )

explicit

Definition at line 11 of file Run.cc.

References aux_, art::InRun, principal_, and productRangeSet_.

  : DataViewImpl{rp, md, InRun, false, consumer}
  , principal_{rp}
  , aux_{rp.aux()}
  , productRangeSet_{rs}
{}

Member Function Documentation

Timestamp const& art::Run::beginTime ( ) const

inline

Definition at line 51 of file Run.h.

References aux_, and art::RunAuxiliary::beginTime().

Referenced by art::Tracer::preBeginRun().

  {
    return aux_.beginTime();
  }

void art::DataViewImpl::checkPutProducts ( bool  checkProducts, std::set< TypeLabel > const &  expectedProducts, TypeLabelMap const &  putProducts  )

protectedinherited

Definition at line 109 of file DataViewImpl.cc.

References art::DataViewImpl::getProductDescription(), and art::errors::LogicError.

Referenced by commit(), art::SubRun::commit(), art::Event::commit(), art::Event::put(), and art::DataViewImpl::retrievedProducts().

  {
    if (!checkProducts)
      return;

    std::vector<std::string> missing;
    for (auto const& typeLabel : expectedProducts) {
      if (putProducts.find(typeLabel) != putProducts.cend())
        continue;

      std::ostringstream desc;
      desc << getProductDescription(typeLabel.typeID(),
                                    typeLabel.productInstanceName());
      missing.emplace_back(desc.str());
    }

    if (!missing.empty()) {
      std::ostringstream errmsg;
      HorizontalRule rule{25};
      errmsg << "The following products have been declared with 'produces',\n"
             << "but they have not been placed onto the event:\n"
             << rule('=') << '\n';
      for (auto const& desc : missing) {
        errmsg << desc << rule('=') << '\n';
      }
      throw Exception{errors::LogicError, "DataViewImpl::checkPutProducts"}
        << errmsg.str();
    }
  }

void art::Run::commit	(	RunPrincipal &	rp,
		bool const	checkProducts,
		std::set< TypeLabel > const &	expectedProducts
	)

Definition at line 36 of file Run.cc.

References art::DataViewImpl::checkPutProducts(), principal_, and art::DataViewImpl::putProducts().

Referenced by endTime().

{
  // Check addresses only since type of 'rp' will hopefully change to
  // Principal&.
  assert(&rp == &principal_);
  checkPutProducts(checkProducts, expectedProducts, putProducts());
  commit(rp);
}

void art::Run::commit

(

RunPrincipal &

rp

)

Definition at line 48 of file Run.cc.

References art::productstatus::present(), art::RunPrincipal::put(), and art::DataViewImpl::putProducts().

{
  for (auto& elem : putProducts()) {
    auto const& pd = elem.second.pd;
    auto productProvenancePtr = std::make_unique<ProductProvenance const>(
      pd.productID(), productstatus::present());
    rp.put(std::move(elem.second.prod),
           pd,
           std::move(productProvenancePtr),
           std::move(elem.second.rs));
  }

  // the cleanup is all or none
  putProducts().clear();
}

Timestamp const& art::Run::endTime ( ) const

inline

Definition at line 56 of file Run.h.

References aux_, commit(), art::RunAuxiliary::endTime(), art::DataViewImpl::get(), art::DataViewImpl::getByLabel(), art::DataViewImpl::getByToken(), art::DataViewImpl::getMany(), art::DataViewImpl::getManyByType(), art::DataViewImpl::getPointerByLabel(), getProcessParameterSet(), art::DataViewImpl::getValidHandle(), art::DataViewImpl::getView(), art::DataViewImpl::processHistory(), productGetter(), put(), and art::DataViewImpl::removeCachedProduct().

  {
    return aux_.endTime();
  }

template<typename PROD >

bool art::DataViewImpl::get ( SelectorBase const &  sel, Handle< PROD > &  result  ) const

inlineinherited

Definition at line 307 of file DataViewImpl.h.

References art::Handle< T >::clear(), art::convert_handle(), art::Handle< T >::failedToGet(), art::DataViewImpl::get_(), art::Handle< T >::provenance(), art::DataViewImpl::recordAsParent(), art::DataViewImpl::recordParents_, and art::GroupQueryResult::succeeded().

Referenced by endTime(), art::SubRun::endTime(), art::detail::ProcessAndEventSelector::loadTriggerResults(), DUNE::NeutrinoTrackingEff::processEff(), DUNE::MuonTrackingEff::processEff(), and art::Event::put().

{
  result.clear(); // Is this the correct thing to do if an exception is thrown?
  // We do *not* track whether consumes was called for a SelectorBase.
  GroupQueryResult bh = get_(WrappedTypeID::make<PROD>(), sel);
  convert_handle(bh, result);
  bool const ok{bh.succeeded() && !result.failedToGet()};
  if (recordParents_ && ok) {
    recordAsParent(*result.provenance());
  }
  return ok;
}

template<typename PROD >

bool art::DataViewImpl::get ( ProductID const  pid, Handle< PROD > &  result  ) const

inherited

Definition at line 322 of file DataViewImpl.h.

References art::Handle< T >::clear(), art::convert_handle(), art::Handle< T >::failedToGet(), art::DataViewImpl::getByProductID_(), art::Handle< T >::provenance(), art::DataViewImpl::recordAsParent(), art::DataViewImpl::recordParents_, and art::GroupQueryResult::succeeded().

{
  result.clear(); // Is this the correct thing to do if an exception is thrown?
  // We do *not* track whether consumes was called for a ProductID.
  GroupQueryResult bh = getByProductID_(pid);
  convert_handle(bh, result);
  bool const ok{bh.succeeded() && !result.failedToGet()};
  if (recordParents_ && ok) {
    recordAsParent(*result.provenance());
  }
  return ok;
}

template<typename PROD >

bool art::DataViewImpl::getByLabel ( std::string const &  label, std::string const &  productInstanceName, Handle< PROD > &  result  ) const

inlineinherited

Definition at line 344 of file DataViewImpl.h.

Referenced by lar::util::details::FindAllP< Source, Dest >::Add(), reco3d::PlotSpacePoints::analyze(), hit::MCHitAnaExample::analyze(), pid::PIDAAnalyzer::analyze(), opdet::OpFlashSimpleAna::analyze(), opdet::OpHitAna::analyze(), cheat::CheckBackTracking::analyze(), calo::PrintCalorimetry::analyze(), opdet::OpFlashMCTruthAna::analyze(), MCBTDemo::analyze(), trk::TrackContainmentAnalyzer::analyze(), opdet::FlashHypothesisAna::analyze(), cheat::RecoCheckAna::analyze(), opreco::OpticalRecoAna::analyze(), cluster::ClusterPCA::analyze(), hit::HitAnaModule::analyze(), lar_pandora::ConsolidatedPFParticleAnalysisTemplate::analyze(), vertex::AggregateVertexAna::analyze(), rwgt::ReweightAna::analyze(), caldata::CalWireAna::analyze(), shower::TCShowerTemplateMaker::analyze(), opdet::FIFOHistogramAna::analyze(), opdet::TrackTimeAssocAna::analyze(), shower::TCShowerElectronLikelihood::analyze(), shower::TCShowerAnalysis::analyze(), opdet::OpDigiAna::analyze(), opdet::OpFlashAna::analyze(), microboone::CosmicRemovalAna::analyze(), detsim::SimWireAna::analyze(), opdet::FlashPurityCheckAna::analyze(), opdet::LEDCalibrationAna::analyze(), larg::LArSimChannelAna::analyze(), pfpf::PFPAna::analyze(), trkf::SpacePointAna::analyze(), cluster::ClusterAna::analyze(), hit::MagDriftAna::analyze(), detsim::WienerFilterAna::analyze(), cluster::DBclusterAna::analyze(), hit::GausHitFinderAna::analyze(), hit::HitFinderAna::analyze(), cluster::HoughLineFinderAna::analyze(), NuShowerEff::analyze(), opdet::SimPhotonCounter::analyze(), vertex::FeatureVertexFinderAna::analyze(), ems::MultiEMShowers::analyze(), lar::example::AnalysisExample::analyze(), trkf::SeedAna::analyze(), trkf::TrackAna::analyze(), ClusteringValidation::ClusteringValidation::analyze(), trkf::TrackAna::anaStitch(), lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps(), evd::AnalysisBaseDrawer::CalorShower(), evd::HitSelector::ChangeHit(), lar_cluster3d::StandardHit3DBuilder::CollectArtHits(), lar_pandora::LArPandoraHelper::CollectClusters(), lar_pandora::LArPandoraHelper::CollectCosmicTags(), lar_pandora::LArPandoraHelper::CollectGeneratorMCParticles(), lar_pandora::LArPandoraHelper::CollectHits(), lar_pandora::LArPandoraHelper::CollectMCParticles(), lar_pandora::LArPandoraHelper::CollectPFParticleMetadata(), lar_pandora::LArPandoraExternalEventBuilding::CollectPFParticles(), lar_pandora::LArPandoraHelper::CollectPFParticles(), lar_pandora::LArPandoraHelper::CollectSeeds(), ems::EMShower3D::CollectShower2D(), lar_pandora::LArPandoraHelper::CollectShowers(), ems::MergeEMShower3D::collectshowers(), lar_pandora::LArPandoraHelper::CollectSimChannels(), lar_pandora::LArPandoraHelper::CollectSpacePoints(), lar_pandora::LArPandoraHelper::CollectT0s(), lar_pandora::LArPandoraHelper::CollectTracks(), lar_pandora::LArPandoraHelper::CollectVertices(), lar_pandora::LArPandoraHelper::CollectWires(), ems::MultiEMShowers::convCluster(), t0::IndirectHitParticleAssns::CreateHitParticleAssociations(), t0::DirectHitParticleAssns::CreateHitParticleAssociations(), evd::AnalysisBaseDrawer::DrawDeDx(), evd::AnalysisBaseDrawer::DrawKineticEnergy(), evd::RecoBaseDrawer::DrawTrackVertexAssns2D(), endTime(), art::SubRun::endTime(), filt::LArG4ParticleFilter::filter(), simfilter::FilterNoMCParticles::filter(), filt::FinalStateParticleFilter::filter(), filt::FinalStateSelectFilter::filter(), simfilter::FilterSimPhotonTime::filter(), cluster::SmallClusterFilter::filter(), filt::EmptyFilter::filter(), simfilter::FilterNoDirtNeutrinos::filter(), simfilter::FilterStoppingMuon::filter(), filter::MuonFilter::filter(), trkf::StitchAlg::FindHeadsAndTails(), anab::FVectorReader< T, N >::FVectorReader(), trkf::Track3DKalmanHit::getAllHits(), lar_pandora::LArPandoraHelper::GetAssociatedHits(), evd::RecoBaseDrawer::GetBezierTracks(), art::DataViewImpl::getByLabel(), art::DataViewImpl::getByToken(), trkf::Track3DKalmanHit::getClusteredHits(), evd::RecoBaseDrawer::GetClusters(), lar_pandora::LArPandoraEvent::GetCollection(), ShowerQuality::GetDataOrDie(), evd::RecoBaseDrawer::GetEdges(), evd::RecoBaseDrawer::GetEndPoint2D(), evd::RecoBaseDrawer::GetEvents(), lar_pandora::LArPandoraEvent::GetFilteredParticlesByCRTag(), ems::MergeEMShower3D::getGammaId(), trkf::BezierTrackerModule::GetHitsFromClusters(), trkf::SeedFinderModule::GetHitsFromEvent(), evd::RecoBaseDrawer::GetOpFlashes(), evd::RecoBaseDrawer::GetPFParticles(), trkf::Track3DKalmanHit::getPFParticleStuff(), art::DataViewImpl::getPointerByLabel(), evd::RecoBaseDrawer::GetSeeds(), shower::TCShower::getShowersWithoutSlices(), shower::TCShower::getShowersWithSlices(), sim::SimListUtils::GetSimPhotonsCollection(), evd::RecoBaseDrawer::GetSlices(), trkf::SeedFinderModule::GetSortedHitsFromClusters(), evd::RecoBaseDrawer::GetSpacePoints(), art::DataViewImpl::getValidHandle(), evd::RecoBaseDrawer::GetVertices(), evwgh::GenieWeightCalc::GetWeight(), evd::RecoBaseDrawer::GetWires(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), lar_pandora::LArPandoraEventDump::PandoraData::LoadCollection(), ems::MergeEMShower3D::mcinfo(), evgb::MCTruthAndFriendsItr::MCTruthAndFriendsItr(), mvapid::MVAAlg::PrepareEvent(), wc::CellTree::processCalib(), DUNE::NeutrinoShowerEff::processEff(), DUNE::NeutrinoTrackingEff::processEff(), DUNE::MuonTrackingEff::processEff(), wc::CellTree::processMC(), wc::CellTree::processOpFlash(), wc::CellTree::processOpHit(), wc::CellTree::processRaw(), wc::CellTree::processTrigger(), event::EventMaker::produce(), MCReco::produce(), opdet::FlashClusterMatch::produce(), hit::DisambigCheater::produce(), hit::MCHitFinder::produce(), hit::TTHitFinder::produce(), trk::TrackContainmentTagger::produce(), vertex::VertexCheater::produce(), cluster::SimpleClusterMerger::produce(), opdet::OpMCDigi::produce(), vertex::CornerFinder::produce(), hit::RFFHitFinder::produce(), event::EventCheater::produce(), shwf::ShowerCheater::produce(), apa::APAHitFinder::produce(), opdet::TrackTimeAssoc::produce(), opdet::BeamFlashCompatabilityCheck::produce(), sim::MergeSimSources::produce(), sppt::TTSpacePointFinder::produce(), trkf::SpacePointCheater::produce(), trkf::SpacePointFinder::produce(), trkf::BezierTrackerModule::produce(), spacecharge::ShiftEdepSCE::produce(), noisefilteralg::WireCellNoiseFilter::produce(), trkf::TrackCheater::produce(), opdet::OpticalRawDigitReformatter::produce(), pid::Chi2ParticleID::produce(), cluster::ClusterCheater::produce(), calo::BezierCalorimetry::produce(), hit::FFTHitFinder::produce(), evwgh::EventWeight::produce(), calo::TrackCalorimetry::produce(), cosmic::BeamFlashTrackMatchTagger::produce(), caldata::CalWire::produce(), trkf::FeatureTracker::produce(), opdet::OpFlashFinder::produce(), vertex::AggregateVertex::produce(), CRHitRemoval::produce(), cluster::TrajCluster::produce(), cluster::DBcluster::produce(), cosmic::TrackPFParticleMatch::produce(), cluster::FuzzyClusterMerger::produce(), ShowerReco3D::produce(), caldata::CalWireT962::produce(), cluster::BlurredClustering::produce(), cluster::LineMerger::produce(), cluster::fuzzyCluster::produce(), trkf::SpacePts::produce(), cosmic::CosmicPFParticleTagger::produce(), shower::EMShower::produce(), event::AggregateEvent::produce(), shower::TCShower::produce(), cosmic::CosmicTrackTagger::produce(), trkf::Track3Dreco::produce(), vertex::VertexMatch::produce(), trkf::TrackKalmanCheater::produce(), shwf::ShowerFinder::produce(), cosmic::CosmicPCAxisTagger::produce(), cosmic::CosmicClusterTagger::produce(), t0::MCParticleTrackMatching::produce(), t0::MCParticleShowerMatching::produce(), hit::RawHitFinder::produce(), opdet::OpHitFinder::produce(), reco3d::SpacePointSolver::produce(), trkf::CCTrackMaker::produce(), trkf::MCSFitProducer::produce(), vertex::PrimaryVertexFinder::produce(), cluster::SmallClusterFinder::produce(), vertex::HarrisVertexFinder::produce(), cluster::EndPointModule::produce(), hit::GausHitFinder::produce(), trkf::TrackStitcher::produce(), ems::EMShower3D::produce(), CRHitRemovalByPCA::produce(), cluster::HoughLineFinder::produce(), calo::Calorimetry::produce(), hit::DPRawHitFinder::produce(), vertex::VertexFinder2D::produce(), shwf::ShowerReco::produce(), trkf::Track3DKalman::produce(), lbne::PhotonCounterT0Matching::produce(), trkf::PMAlgTrajFitter::produce(), trkf::Track3DKalmanSPS::produce(), detsim::SimDriftElectrons::produce(), t0::MCTruthT0Matching::produce(), vertex::FeatureVertexFinder::produce(), trkf::KalmanFilterTrajectoryFitter::produce(), trkf::CosmicTracker::produce(), larg4::LArG4::produce(), ems::MergeEMShower3D::produce(), art::Event::put(), evd::details::RawDigitCacheDataClass::ReadProduct(), evd::InfoTransfer::Rebuild(), cheat::PhotonBackTracker::Rebuild(), evd::HitSelector::SaveHits(), evd::HitSelector::SaveSeedLines(), cluster::ClusterMergeHelper::SetClusters(), nnet::TrainingDataAlg::setDataEventData(), tss::TrackShowerHits::sortHits(), and evd::details::RawDigitCacheDataClass::Update().

{
  return getByLabel<PROD>(label, productInstanceName, {}, result);
}

template<typename PROD >

bool art::DataViewImpl::getByLabel ( std::string const &  label, std::string const &  productInstanceName, std::string const &  processName, Handle< PROD > &  result  ) const

inlineinherited

Definition at line 353 of file DataViewImpl.h.

References art::DataViewImpl::branchType_, art::Handle< T >::clear(), art::DataViewImpl::consumer_, art::convert_handle(), art::Handle< T >::failedToGet(), art::DataViewImpl::getByLabel_(), art::ProductInfo::Product, art::Handle< T >::provenance(), art::DataViewImpl::recordAsParent(), art::DataViewImpl::recordParents_, and art::GroupQueryResult::succeeded().

{
  result.clear(); // Is this the correct thing to do if an exception is thrown?
  auto const wrapped = WrappedTypeID::make<PROD>();
  ProductInfo const pinfo{ProductInfo::ConsumableType::Product,
                          wrapped.product_type,
                          label,
                          productInstanceName,
                          processName};
  consumer_->validateConsumedProduct(branchType_, pinfo);
  GroupQueryResult bh =
    getByLabel_(wrapped, label, productInstanceName, processName);
  convert_handle(bh, result);
  bool const ok{bh.succeeded() && !result.failedToGet()};
  if (recordParents_ && ok) {
    recordAsParent(*result.provenance());
  }
  return ok;
}

template<typename PROD >

PROD const & art::DataViewImpl::getByLabel ( InputTag const &  tag ) const

inlineinherited

same as above, but using the InputTag class

Definition at line 378 of file DataViewImpl.h.

References art::DataViewImpl::getByLabel().

{
  Handle<PROD> h;
  getByLabel(tag, h);
  return *h;
}

template<typename PROD >

bool art::DataViewImpl::getByLabel ( InputTag const &  tag, Handle< PROD > &  result  ) const

inlineinherited

Definition at line 337 of file DataViewImpl.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  return getByLabel<PROD>(tag.label(), tag.instance(), tag.process(), result);
}

template<typename PROD >

bool art::DataViewImpl::getByToken ( ProductToken< PROD > const &  token, Handle< PROD > &  result  ) const

inlineinherited

Definition at line 387 of file DataViewImpl.h.

References art::DataViewImpl::getByLabel(), and art::ProductToken< T >::inputTag_.

Referenced by endTime(), art::SubRun::endTime(), and art::Event::put().

{
  auto const& tag = token.inputTag_;
  return getByLabel(tag.label(), tag.instance(), tag.process(), result);
}

template<typename PROD >

void art::DataViewImpl::getMany ( SelectorBase const &  sel, std::vector< Handle< PROD >> &  results  ) const

inlineinherited

Definition at line 421 of file DataViewImpl.h.

References art::DataViewImpl::branchType_, art::DataViewImpl::consumer_, art::convert_handle(), art::DataViewImpl::getMany_(), art::ProductInfo::Many, art::DataViewImpl::recordAsParent(), and art::DataViewImpl::recordParents_.

Referenced by endTime(), art::SubRun::endTime(), art::DataViewImpl::getManyByType(), and art::Event::put().

{
  auto const wrapped = WrappedTypeID::make<PROD>();
  consumer_->validateConsumedProduct(
    branchType_,
    ProductInfo{ProductInfo::ConsumableType::Many, wrapped.product_type});

  std::vector<Handle<PROD>> products;
  for (auto const& qr : getMany_(wrapped, sel)) {
    Handle<PROD> result;
    convert_handle(qr, result);
    products.push_back(result);
  }
  results.swap(products);

  if (!recordParents_)
    return;

  for (auto const& h : results)
    recordAsParent(*h.provenance());
}

template<typename PROD >

void art::DataViewImpl::getManyByType ( std::vector< Handle< PROD >> &  results ) const

inlineinherited

Definition at line 446 of file DataViewImpl.h.

References art::DataViewImpl::getMany().

Referenced by evd::RecoBaseDrawer::DrawShower3D(), evd::RecoBaseDrawer::DrawShowerOrtho(), evd::RecoBaseDrawer::DrawTrack3D(), evd::RecoBaseDrawer::DrawTrackOrtho(), endTime(), art::SubRun::endTime(), simfilter::FilterCryostatNus::filter(), simfilter::FilterGenInTime::filter(), evd::SimulationDrawer::GetMCTruth(), evgb::MCTruthAndFriendsItr::MCTruthAndFriendsItr(), geo::AuxDetGeometry::preBeginRun(), geo::Geometry::preBeginRun(), larg4::LArG4::produce(), art::Event::put(), and evdb::ScanFrame::Record().

{
  getMany(MatchAllSelector{}, results);
}

template<typename PROD >

PROD const * art::DataViewImpl::getPointerByLabel ( InputTag const &  tag ) const

inlineinherited

Definition at line 396 of file DataViewImpl.h.

References art::DataViewImpl::getByLabel().

Referenced by endTime(), art::SubRun::endTime(), and art::Event::put().

{
  Handle<PROD> h;
  getByLabel(tag, h);
  return &(*h);
}

bool art::Run::getProcessParameterSet	(	std::string const &	processName,
		std::vector< fhicl::ParameterSet > &	ps
	)		const

Definition at line 28 of file Run.cc.

Referenced by endTime().

{
  // Unimplemented
  return false;
}

BranchDescription const & art::DataViewImpl::getProductDescription ( TypeID const &  type, std::string const &  productInstanceName  ) const

protectedinherited

Definition at line 142 of file DataViewImpl.cc.

References art::DataViewImpl::branchType_, art::get_ProductDescription(), art::ProductMetaData::instance(), art::DataViewImpl::md_, art::ModuleDescription::moduleLabel(), art::ModuleDescription::processName(), and art::ProductMetaData::productList().

Referenced by art::DataViewImpl::checkPutProducts(), art::Results::put(), art::Event::put(), put_(), art::SubRun::put_(), and art::DataViewImpl::retrievedProducts().

  {
    return get_ProductDescription(type,
                                  md_.processName(),
                                  ProductMetaData::instance().productList(),
                                  branchType_,
                                  md_.moduleLabel(),
                                  productInstanceName);
  }

template<typename PROD >

ValidHandle<PROD> art::DataViewImpl::getValidHandle ( InputTag const &  tag ) const

inherited

Referenced by larg4::ISCalculationAna::analyze(), recob::DumpVertices::analyze(), recob::DumpPCAxes::analyze(), sim::DumpMCTruth::analyze(), recob::DumpSpacePoints::analyze(), recob::DumpSeeds::analyze(), sim::DumpGTruth::analyze(), recob::DumpClusters::analyze(), hit::DumpHits::analyze(), detsim::DumpRawDigits::analyze(), caldata::DumpWires::analyze(), recob::DumpPFParticles::analyze(), recob::DumpTracks::analyze(), t0::IndirectHitParticleAssns::CreateHitParticleAssociations(), t0::DirectHitParticleAssns::CreateHitParticleAssociations(), endTime(), art::SubRun::endTime(), anab::FVectorReader< T, N >::FVectorReader(), trkmkr::KalmanFilterFitTrackMaker::initEvent(), hit::HitFinder::produce(), trkf::TCTrack::produce(), cluster::LineCluster::produce(), cluster::SimpleLineCluster::produce(), hit::HitCheater::produce(), TrackProducerFromTrack::produce(), cluster::DBCluster3D::produce(), TrackProducerFromTrackTrajectory::produce(), cluster::TrajCluster::produce(), cluster::ClusterCrawler::produce(), trkf::VertexFitter::produce(), t0::MCTruthT0Matching::produce(), trkf::KalmanFilterTrajectoryFitter::produce(), trkf::PMAlgTrackMaker::produce(), phot::PhotonLibraryPropagation::produce(), trkf::KalmanFilterFinalTrackFitter::produce(), and art::Event::put().

template<typename PROD >

ValidHandle<PROD> art::DataViewImpl::getValidHandle ( ProductToken< PROD > const &  token ) const

inherited

template<typename PROD >

art::ValidHandle<PROD> art::DataViewImpl::getValidHandle ( InputTag const &  tag ) const

inlineinherited

Definition at line 405 of file DataViewImpl.h.

References art::DataViewImpl::getByLabel(), and art::ValidHandle< T >::provenance().

{
  Handle<PROD> h;
  getByLabel(tag, h);
  return ValidHandle<PROD>(&(*h), *h.provenance());
}

template<typename PROD >

art::ValidHandle<PROD> art::DataViewImpl::getValidHandle ( ProductToken< PROD > const &  token ) const

inlineinherited

Definition at line 414 of file DataViewImpl.h.

References art::ProductToken< T >::inputTag_.

{
  return getValidHandle<PROD>(token.inputTag_);
}

template<typename ELEMENT >

std::size_t art::DataViewImpl::getView ( std::string const &  moduleLabel, std::string const &  productInstanceName, std::vector< ELEMENT const * > &  result  ) const

inherited

Definition at line 474 of file DataViewImpl.h.

References art::DataViewImpl::fillView_().

Referenced by larg4::LArG4Ana::analyze(), pmtana::PMTAna::analyze(), opdet::SimPhotonCounter::analyze(), evd::RecoBaseDrawer::CountHits(), endTime(), art::SubRun::endTime(), cluster::ClusterMatchAlg::FillMCInfo(), filter::ADCFilter::filter(), evd::RecoBaseDrawer::GetHits(), sim::SimListUtils::GetLArVoxelList(), evd::SimulationDrawer::GetParticle(), evd::RecoBaseDrawer::GetShowers(), evd::RecoBaseDrawer::GetTracks(), art::DataViewImpl::getView(), event::EventCheater::produce(), hit::HitCheater::produce(), opdet::OpticalRawDigitReformatter::produce(), opdet::OpHitFinder::produce(), detsim::SimWire::produce(), and art::Event::put().

{
  auto bhv = getView_<ELEMENT>(moduleLabel, productInstanceName, {});
  std::size_t const orig_size = result.size();
  fillView_(bhv[0], result);
  return result.size() - orig_size;
} // getView<>()

template<typename ELEMENT >

std::size_t art::DataViewImpl::getView ( InputTag const &  tag, std::vector< ELEMENT const * > &  result  ) const

inherited

Definition at line 486 of file DataViewImpl.h.

References art::DataViewImpl::fillView_(), art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  auto bhv = getView_<ELEMENT>(tag.label(), tag.instance(), tag.process());
  std::size_t const orig_size = result.size();
  fillView_(bhv[0], result);
  return result.size() - orig_size;
} // getView<>()

template<typename ELEMENT >

std::size_t art::DataViewImpl::getView ( ViewToken< ELEMENT > const &  token, std::vector< ELEMENT const * > &  result  ) const

inherited

template<typename ELEMENT >

bool art::DataViewImpl::getView ( std::string const &  moduleLabel, std::string const &  instanceName, View< ELEMENT > &  result  ) const

inherited

Definition at line 497 of file DataViewImpl.h.

References art::DataViewImpl::fillView_(), art::View< T >::set_innards(), and art::View< T >::vals().

{
  auto bhv = getView_<ELEMENT>(moduleLabel, productInstanceName, {});
  fillView_(bhv[0], result.vals());
  result.set_innards(bhv[0].result()->productID(),
                     bhv[0].result()->uniqueProduct());
  return true;
}

template<typename ELEMENT >

bool art::DataViewImpl::getView ( InputTag const &  tag, View< ELEMENT > &  result  ) const

inherited

Definition at line 510 of file DataViewImpl.h.

References art::DataViewImpl::fillView_(), art::InputTag::instance(), art::InputTag::label(), art::InputTag::process(), art::View< T >::set_innards(), and art::View< T >::vals().

{
  auto bhv = getView_<ELEMENT>(tag.label(), tag.instance(), tag.process());
  fillView_(bhv[0], result.vals());
  result.set_innards(bhv[0].result()->productID(),
                     bhv[0].result()->uniqueProduct());
  return true;
}

template<typename ELEMENT >

bool art::DataViewImpl::getView ( ViewToken< ELEMENT > const &  tag, View< ELEMENT > &  result  ) const

inherited

Definition at line 521 of file DataViewImpl.h.

References art::DataViewImpl::getView(), and art::ViewToken< Element >::inputTag_.

{
  return getView(token.inputTag_, result);
}

template<typename ELEMENT >

art::DataViewImpl::GroupQueryResultVec art::DataViewImpl::getView_ ( std::string const &  moduleLabel, std::string const &  productInstanceName, std::string const &  processName  ) const

inherited

Definition at line 453 of file DataViewImpl.h.

References art::DataViewImpl::branchType_, art::DataViewImpl::consumer_, art::DataViewImpl::ensureUniqueProduct_(), art::DataViewImpl::getMatchingSequenceByLabel_(), art::DataViewImpl::removeNonViewableMatches_(), and art::ProductInfo::ViewElement.

{
  TypeID const typeID{typeid(ELEMENT)};
  ProductInfo const pinfo{ProductInfo::ConsumableType::ViewElement,
                          typeID,
                          moduleLabel,
                          productInstanceName,
                          processName};
  consumer_->validateConsumedProduct(branchType_, pinfo);
  auto bhv =
    getMatchingSequenceByLabel_(moduleLabel, productInstanceName, processName);
  removeNonViewableMatches_(typeID, bhv);
  ensureUniqueProduct_(
    bhv.size(), typeID, moduleLabel, productInstanceName, processName);
  return bhv;
} // getView_<>()

RunID const& art::Run::id ( ) const

inline

Definition at line 41 of file Run.h.

References aux_, and art::RunAuxiliary::id().

Referenced by geo::DumpGeometry::beginRun(), detinfo::LArPropertiesServiceStandard::preBeginRun(), spacecharge::SpaceChargeServiceStandard::preBeginRun(), art::Tracer::preBeginRun(), util::LArPropertiesServiceArgoNeuT::preBeginRun(), and art::TFileService::TFileService().

  {
    return aux_.id();
  }

ProcessHistory const & art::DataViewImpl::processHistory ( ) const

inherited

Definition at line 81 of file DataViewImpl.cc.

References art::DataViewImpl::principal_, and art::Principal::processHistory().

Referenced by endTime(), art::SubRun::endTime(), and art::Event::put().

  {
    return principal_.processHistory();
  }

art::EDProductGetter const * art::Run::productGetter

(

ProductID const

pid

)

const

Definition at line 22 of file Run.cc.

References principal_, and art::Principal::productGetter().

Referenced by endTime().

{
  return principal_.productGetter(pid);
}

template<typename PROD >

art::ProductID art::Run::put

(

std::unique_ptr< PROD > &&

product

)

Definition at line 148 of file Run.h.

Referenced by ToyOneShowerGen::beginRun(), evgen::SNNueAr40CCGen::beginRun(), evgen::CosmicsGen::beginRun(), evgen::CORSIKAGen::beginRun(), evgen::FileMuons::beginRun(), evgen::NUANCEGen::beginRun(), evgen::NucleonDecay::beginRun(), evgen::NDKGen::beginRun(), evgen::MarleyGen::beginRun(), evgen::GaisserParam::beginRun(), evgen::TextFileGen::beginRun(), evgen::NeutronOsc::beginRun(), evgen::GENIEGen::beginRun(), evgen::RadioGen::beginRun(), evgen::LightSource::beginRun(), evgen::MUSUN::beginRun(), evgen::MarleyTimeGen::beginRun(), and endTime().

{
  return put<PROD>(std::move(product), std::string{});
}

template<typename PROD >

art::ProductID art::Run::put	(	std::unique_ptr< PROD > &&	product,
		FullSemantic< Level::Run >	semantic
	)

Definition at line 155 of file Run.h.

{
  return put<PROD>(std::move(product), std::string{}, semantic);
}

template<typename PROD >

art::ProductID art::Run::put	(	std::unique_ptr< PROD > &&	product,
		FragmentSemantic< Level::Run >	semantic
	)

Definition at line 163 of file Run.h.

{
  return put<PROD>(std::move(product), std::string{}, semantic);
}

template<typename PROD >

art::ProductID art::Run::put	(	std::unique_ptr< PROD > &&	product,
		RangedFragmentSemantic< Level::Run >	semantic
	)

Definition at line 171 of file Run.h.

{
  return put<PROD>(std::move(product), std::string{}, std::move(semantic));
}

template<typename PROD >

art::ProductID art::Run::put	(	std::unique_ptr< PROD > &&	product,
		std::string const &	instanceName
	)

Definition at line 182 of file Run.h.

References art::RangeSet::collapse(), and productRangeSet_.

{
  productRangeSet_.collapse();
  return put_<PROD>(std::move(product), productInstanceName, productRangeSet_);
}

template<typename PROD >

art::ProductID art::Run::put	(	std::unique_ptr< PROD > &&	product,
		std::string const &	instanceName,
		FullSemantic< Level::Run >
	)

Definition at line 191 of file Run.h.

References art::RangeSet::forRun().

{
  return put_<PROD>(
    std::move(product), productInstanceName, RangeSet::forRun(id()));
}

template<typename PROD >

art::ProductID art::Run::put	(	std::unique_ptr< PROD > &&	product,
		std::string const &	instanceName,
		FragmentSemantic< Level::Run >
	)

Definition at line 201 of file Run.h.

References art::RangeSet::collapse(), art::RangeSet::is_full_run(), art::errors::ProductPutFailure, and productRangeSet_.

{
  static_assert(
    detail::CanBeAggregated<PROD>::value,
    "\n\n"
    "art error: A Run product put with the semantic 'RunFragment'\n"
    "           must be able to be aggregated. Please add the appropriate\n"
    "              void aggregate(T const&)\n"
    "           function to your class, or contact artists@fnal.gov.\n");

  if (productRangeSet_.collapse().is_full_run()) {
    throw Exception{errors::ProductPutFailure, "Run::put"}
      << "\nCannot put a product corresponding to a full Run using\n"
      << "art::runFragment().  This can happen if you attempted to\n"
      << "put a product at beginRun using art::runFragment().\n"
      << "Please use either:\n"
      << "   art::fullRun(), or\n"
      << "   art::runFragment(art::RangeSet const&)\n"
      << "or contact artists@fnal.gov for assistance.\n";
  }
  return put_<PROD>(std::move(product), productInstanceName, productRangeSet_);
}

template<typename PROD >

art::ProductID art::Run::put	(	std::unique_ptr< PROD > &&	product,
		std::string const &	instanceName,
		RangedFragmentSemantic< Level::Run >	semantic
	)

Definition at line 228 of file Run.h.

References art::errors::ProductPutFailure, and art::RangedFragmentSemantic< Level >::rs.

{
  static_assert(
    detail::CanBeAggregated<PROD>::value,
    "\n\n"
    "art error: A Run product put with the semantic 'RunFragment'\n"
    "           must be able to be aggregated. Please add the appropriate\n"
    "              void aggregate(T const&)\n"
    "           function to your class, or contact artists@fnal.gov.\n");
  if (semantic.rs.collapse().is_full_run()) {
    throw Exception{errors::ProductPutFailure, "Run::put"}
      << "\nCannot put a product corresponding to a full Run using\n"
      << "art::runFragment(art::RangeSet&).  Please use:\n"
      << "   art::fullRun()\n"
      << "or contact artists@fnal.gov for assistance.\n";
  }
  return put_<PROD>(std::move(product), productInstanceName, semantic.rs);
}

template<typename PROD >

art::ProductID art::Run::put_ ( std::unique_ptr< PROD > &&  product, std::string const &  productInstanceName, RangeSet const &  rs  )

private

Put a new product with a 'product instance name' and a 'range set'.

Definition at line 251 of file Run.h.

References art::DataViewImpl::getProductDescription(), art::RangeSet::is_valid(), art::errors::NullPointerError, art::errors::ProductPutFailure, and art::DataViewImpl::putProducts().

{
  TypeID const tid{typeid(PROD)};
  if (product.get() == nullptr) {
    throw Exception{errors::NullPointerError, "Run::put"}
      << "\nA null unique_ptr was passed to 'put'.\n"
      << "The pointer is of type " << tid << ".\n"
      << "The specified productInstanceName was '" << productInstanceName
      << "'.\n";
  }

  if (!rs.is_valid()) {
    throw Exception{errors::ProductPutFailure, "Run::put"}
      << "\nCannot put a product with an invalid RangeSet.\n"
      << "Please contact artists@fnal.gov.\n";
  }

  auto const& pd = getProductDescription(tid, productInstanceName);
  auto wp = std::make_unique<Wrapper<PROD>>(std::move(product));

  auto result = putProducts().emplace(
    TypeLabel{
      tid, productInstanceName, SupportsView<PROD>::value, false /*not used*/},
    PMValue{std::move(wp), pd, rs});
  if (!result.second) {
    throw Exception{errors::ProductPutFailure, "Run::put"}
      << "\nAttempt to put multiple products with the\n"
      << "following description onto the Run.\n"
      << "Products must be unique per Run.\n"
      << "=================================\n"
      << pd << "=================================\n";
  }

  return pd.productID();
}

TypeLabelMap& art::DataViewImpl::putProducts ( )

inlineprotectedinherited

Definition at line 183 of file DataViewImpl.h.

References art::DataViewImpl::putProducts_.

Referenced by art::Results::commit(), commit(), art::SubRun::commit(), art::Event::commit(), art::Results::put(), art::Event::put(), put_(), art::SubRun::put_(), and art::DataViewImpl::retrievedProducts().

  {
    return putProducts_;
  }

TypeLabelMap const& art::DataViewImpl::putProducts ( ) const

inlineprotectedinherited

Definition at line 188 of file DataViewImpl.h.

References art::DataViewImpl::putProducts_.

  {
    return putProducts_;
  }

void art::DataViewImpl::recordAsParent ( Provenance const &  prov ) const

protectedinherited

Definition at line 87 of file DataViewImpl.cc.

References art::Provenance::parents(), art::Provenance::productDescription(), art::Provenance::productID(), art::DataViewImpl::retrievedProducts_, and art::BranchDescription::transient().

Referenced by art::DataViewImpl::fillView_(), art::DataViewImpl::get(), art::DataViewImpl::getByLabel(), and art::DataViewImpl::getMany().

  {
    if (prov.productDescription().transient()) {
      // If the product retrieved is transient, don't use its
      // ProductID; use the ProductID's of its parents.
      auto const& parents = prov.parents();
      retrievedProducts_.insert(cbegin(parents), cend(parents));
    } else {
      retrievedProducts_.insert(prov.productID());
    }
  }

template<typename PROD >

bool art::DataViewImpl::removeCachedProduct ( Handle< PROD > &  h ) const

inherited

Definition at line 551 of file DataViewImpl.h.

References art::Handle< T >::clear(), art::Handle< T >::id(), art::Handle< T >::isValid(), art::Handle< T >::provenance(), and art::DataViewImpl::removeCachedProduct_().

Referenced by endTime(), art::SubRun::endTime(), hit::MCHitFinder::produce(), and art::Event::put().

{
  bool result{false};
  if (h.isValid() && !h.provenance()->produced()) {
    removeCachedProduct_(h.id());
    h.clear();
    result = true;
  }
  return result;
}

DataViewImpl::RetrievedProductIDs art::DataViewImpl::retrievedProductIDs ( ) const

protectedinherited

Definition at line 100 of file DataViewImpl.cc.

References art::DataViewImpl::retrievedProducts_.

Referenced by art::Event::commit(), and art::DataViewImpl::retrievedProducts().

  {
    std::vector<ProductID> result;
    result.reserve(retrievedProducts_.size());
    result.assign(cbegin(retrievedProducts_), cend(retrievedProducts_));
    return result;
  }

RetrievedProductSet const& art::DataViewImpl::retrievedProducts ( ) const

inlineprotectedinherited

Definition at line 197 of file DataViewImpl.h.

References art::DataViewImpl::checkPutProducts(), art::DataViewImpl::getProductDescription(), art::DataViewImpl::putProducts(), art::DataViewImpl::retrievedProductIDs(), and art::DataViewImpl::retrievedProducts_.

  {
    return retrievedProducts_;
  }

RunNumber_t art::Run::run ( ) const

inline

Definition at line 46 of file Run.h.

References aux_, and art::RunAuxiliary::run().

  {
    return aux_.run();
  }

size_t art::DataViewImpl::size ( void  ) const

inherited

Definition at line 34 of file DataViewImpl.cc.

References art::DataViewImpl::principal_, art::DataViewImpl::putProducts_, and art::Principal::size().

Referenced by art::Event::put().

  {
    return putProducts_.size() + principal_.size();
  }

Member Data Documentation

RunAuxiliary const& art::Run::aux_

private

Definition at line 136 of file Run.h.

Referenced by beginTime(), endTime(), id(), Run(), and run().

Principal const& art::Run::principal_

private

Definition at line 135 of file Run.h.

Referenced by commit(), productGetter(), and Run().

RangeSet art::Run::productRangeSet_

private

Definition at line 137 of file Run.h.

Referenced by put(), and Run().

---

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

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