art::DataViewImpl Class Reference

#include "DataViewImpl.h"

Inheritance diagram for art::DataViewImpl:

Classes
struct	PMValue

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

Public Member Functions
	DataViewImpl (DataViewImpl const &)=delete
DataViewImpl &	operator= (DataViewImpl const &)=delete
	DataViewImpl (Principal const &p, ModuleDescription const &md, BranchType bt, bool recordParents, cet::exempt_ptr< Consumer > consumer)
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 >
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
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 ELEMENT >
art::DataViewImpl::GroupQueryResultVec	getView_ (std::string const &moduleLabel, std::string const &productInstanceName, std::string const &processName) const

Protected Types
using	GroupQueryResultVec = std::vector< GroupQueryResult >

Protected Member Functions
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

Private Member Functions
void	removeNonViewableMatches_ (TypeID const &requestedElementType, GroupQueryResultVec &results) const
void	ensureUniqueProduct_ (std::size_t nFound, TypeID const &typeID, std::string const &moduleLabel, std::string const &productInstanceName, std::string const &processName) const
GroupQueryResult	get_ (WrappedTypeID const &wrapped, SelectorBase const &) const
GroupQueryResult	getByProductID_ (ProductID const pid) const
GroupQueryResult	getByLabel_ (WrappedTypeID const &wrapped, std::string const &label, std::string const &productInstanceName, std::string const &processName) const
GroupQueryResultVec	getMany_ (WrappedTypeID const &wrapped, SelectorBase const &sel) const
GroupQueryResultVec	getMatchingSequenceByLabel_ (std::string const &label, std::string const &productInstanceName, std::string const &processName) const
template<typename ELEMENT >
GroupQueryResultVec	getView_ (std::string const &moduleLabel, std::string const &productInstanceName, std::string const &processName) const
template<typename ELEMENT >
void	fillView_ (GroupQueryResult &bh, std::vector< ELEMENT const * > &result) const
void	removeCachedProduct_ (ProductID const pid) const

Private Attributes
TypeLabelMap	putProducts_ {}
RetrievedProductSet	retrievedProducts_ {}
Principal const &	principal_
ModuleDescription const &	md_
BranchType const	branchType_
bool const	recordParents_
cet::exempt_ptr< Consumer >	consumer_

Detailed Description

Definition at line 76 of file DataViewImpl.h.

Member Typedef Documentation

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

protected

Definition at line 214 of file DataViewImpl.h.

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

Definition at line 175 of file DataViewImpl.h.

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

Definition at line 176 of file DataViewImpl.h.

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

Definition at line 177 of file DataViewImpl.h.

Constructor & Destructor Documentation

art::DataViewImpl::DataViewImpl ( DataViewImpl const &  )

delete

art::DataViewImpl::DataViewImpl ( Principal const &  p, ModuleDescription const &  md, BranchType  bt, bool  recordParents, cet::exempt_ptr< Consumer >  consumer  )

explicit

Definition at line 21 of file DataViewImpl.cc.

References branchType_, consumer_, md_, and recordParents_.

    : principal_{pcpl}
    , md_{md}
    , branchType_{branchType}
    , recordParents_{recordParents}
    , consumer_{consumer}
  {}

Member Function Documentation

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

protected

Definition at line 109 of file DataViewImpl.cc.

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

Referenced by art::Run::commit(), art::SubRun::commit(), art::Event::commit(), art::Event::put(), and 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::DataViewImpl::ensureUniqueProduct_ ( std::size_t  nFound, TypeID const &  typeID, std::string const &  moduleLabel, std::string const &  productInstanceName, std::string const &  processName  ) const

private

Definition at line 174 of file DataViewImpl.cc.

References e, and art::errors::ProductNotFound.

Referenced by getView_().

  {
    if (nFound == 1)
      return;

    Exception e{errors::ProductNotFound};
    e << "getView: Found "
      << (nFound == 0 ? "no products" : "more than one product")
      << " matching all criteria\n"
      << "Looking for sequence of type: " << typeID << "\n"
      << "Looking for module label: " << moduleLabel << "\n"
      << "Looking for productInstanceName: " << productInstanceName << "\n";
    if (!processName.empty())
      e << "Looking for processName: " << processName << "\n";
    throw e;
  }

template<typename ELEMENT >

void art::DataViewImpl::fillView_ ( GroupQueryResult &  bh, std::vector< ELEMENT const * > &  result  ) const

private

Definition at line 531 of file DataViewImpl.h.

References recordAsParent(), and art::GroupQueryResult::result().

Referenced by getView().

{
  std::vector<void const*> erased_ptrs;
  auto product = bh.result()->uniqueProduct();

  // The lookups and the checking done in getView_ ensure that the
  // retrieved product supports the requested view.
  product->fillView(erased_ptrs);
  recordAsParent(Provenance{bh.result()});

  std::vector<ELEMENT const*> vals;
  cet::transform_all(erased_ptrs, std::back_inserter(vals), [](auto p) {
    return static_cast<ELEMENT const*>(p);
  });
  result.swap(vals);
}

template<typename PROD >

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

inline

Definition at line 307 of file DataViewImpl.h.

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

Referenced by art::Run::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

Definition at line 322 of file DataViewImpl.h.

References art::Handle< T >::clear(), art::convert_handle(), art::Handle< T >::failedToGet(), getByProductID_(), art::Handle< T >::provenance(), recordAsParent(), 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;
}

GroupQueryResult art::DataViewImpl::get_ ( WrappedTypeID const &  wrapped, SelectorBase const &  sel  ) const

private

Definition at line 40 of file DataViewImpl.cc.

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

Referenced by get().

  {
    return principal_.getBySelector(wrapped, sel);
  }

template<typename PROD >

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

inline

Definition at line 344 of file DataViewImpl.h.

References label.

Referenced by lar::util::details::FindAllP< Source, Dest >::Add(), reco3d::PlotSpacePoints::analyze(), hit::MCHitAnaExample::analyze(), pid::PIDAAnalyzer::analyze(), opdet::OpFlashSimpleAna::analyze(), lar_pandora::LArPandoraEventDump::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(), opdet::FIFOHistogramAna::analyze(), opdet::TrackTimeAssocAna::analyze(), opdet::OpDigiAna::analyze(), opdet::OpFlashAna::analyze(), microboone::CosmicRemovalAna::analyze(), detsim::SimWireAna::analyze(), opdet::FlashPurityCheckAna::analyze(), opdet::LEDCalibrationAna::analyze(), larg::LArSimChannelAna::analyze(), trkf::SpacePointAna::analyze(), pfpf::PFPAna::analyze(), cluster::ClusterAna::analyze(), hit::MagDriftAna::analyze(), detsim::WienerFilterAna::analyze(), cluster::DBclusterAna::analyze(), hit::GausHitFinderAna::analyze(), hit::HitFinderAna::analyze(), cluster::HoughLineFinderAna::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::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(), art::Run::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(), getByLabel(), 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(), getPointerByLabel(), evd::RecoBaseDrawer::GetSeeds(), sim::SimListUtils::GetSimPhotonsCollection(), trkf::SeedFinderModule::GetSortedHitsFromClusters(), evd::RecoBaseDrawer::GetSpacePoints(), getValidHandle(), evd::RecoBaseDrawer::GetVertices(), evwgh::GenieWeightCalc::GetWeight(), evd::RecoBaseDrawer::GetWires(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), 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::processSpacePoint(), 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(), shwf::ShowerCheater::produce(), event::EventCheater::produce(), apa::APAHitFinder::produce(), opdet::TrackTimeAssoc::produce(), opdet::BeamFlashCompatabilityCheck::produce(), sppt::TTSpacePointFinder::produce(), trkf::SpacePointCheater::produce(), sim::MergeSimSources::produce(), trkf::SpacePointFinder::produce(), trkf::BezierTrackerModule::produce(), spacecharge::ShiftEdepSCE::produce(), noisefilteralg::WireCellNoiseFilter::produce(), trkf::TrackCheater::produce(), opdet::OpticalRawDigitReformatter::produce(), cluster::ClusterCheater::produce(), pid::Chi2ParticleID::produce(), calo::BezierCalorimetry::produce(), hit::FFTHitFinder::produce(), calo::TrackCalorimetry::produce(), evwgh::EventWeight::produce(), cosmic::BeamFlashTrackMatchTagger::produce(), opdet::OpFlashFinder::produce(), caldata::CalWire::produce(), trkf::FeatureTracker::produce(), calo::GeneralCalorimetry::produce(), vertex::AggregateVertex::produce(), CRHitRemoval::produce(), caldata::CalWireT962::produce(), cluster::FuzzyClusterMerger::produce(), ShowerReco3D::produce(), cluster::DBcluster::produce(), cosmic::TrackPFParticleMatch::produce(), cluster::LineMerger::produce(), cluster::BlurredClustering::produce(), cluster::fuzzyCluster::produce(), trkf::SpacePts::produce(), cosmic::CosmicPFParticleTagger::produce(), shower::EMShower::produce(), event::AggregateEvent::produce(), opdet::OpHitFinder::produce(), vertex::VertexMatch::produce(), trkf::Track3Dreco::produce(), cosmic::CosmicTrackTagger::produce(), trkf::TrackKalmanCheater::produce(), shwf::ShowerFinder::produce(), cosmic::CosmicPCAxisTagger::produce(), cosmic::CosmicClusterTagger::produce(), t0::MCParticleShowerMatching::produce(), t0::MCParticleTrackMatching::produce(), reco3d::SpacePointSolver::produce(), hit::RawHitFinder::produce(), trkf::CCTrackMaker::produce(), vertex::PrimaryVertexFinder::produce(), trkf::MCSFitProducer::produce(), vertex::HarrisVertexFinder::produce(), cluster::SmallClusterFinder::produce(), cluster::EndPointModule::produce(), hit::GausHitFinder::produce(), trkf::TrackStitcher::produce(), ems::EMShower3D::produce(), CRHitRemovalByPCA::produce(), cluster::HoughLineFinder::produce(), hit::DPRawHitFinder::produce(), calo::Calorimetry::produce(), vertex::VertexFinder2D::produce(), shwf::ShowerReco::produce(), trkf::Track3DKalman::produce(), lbne::PhotonCounterT0Matching::produce(), trkf::PMAlgTrajFitter::produce(), detsim::SimDriftElectrons::produce(), trkf::Track3DKalmanSPS::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

inline

Definition at line 353 of file DataViewImpl.h.

References branchType_, art::Handle< T >::clear(), consumer_, art::convert_handle(), art::Handle< T >::failedToGet(), getByLabel_(), label, art::ProductInfo::Product, art::Handle< T >::provenance(), recordAsParent(), 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

inline

same as above, but using the InputTag class

Definition at line 378 of file DataViewImpl.h.

References getByLabel().

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

template<typename PROD >

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

inline

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);
}

GroupQueryResult art::DataViewImpl::getByLabel_ ( WrappedTypeID const &  wrapped, std::string const &  label, std::string const &  productInstanceName, std::string const &  processName  ) const

private

Definition at line 60 of file DataViewImpl.cc.

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

Referenced by getByLabel().

  {
    return principal_.getByLabel(
      wrapped, label, productInstanceName, processName);
  }

GroupQueryResult art::DataViewImpl::getByProductID_ ( ProductID const  pid ) const

private

Definition at line 47 of file DataViewImpl.cc.

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

Referenced by get().

  {
    return principal_.getByProductID(pid);
  }

template<typename PROD >

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

inline

Definition at line 387 of file DataViewImpl.h.

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

Referenced by art::Run::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

inline

Definition at line 421 of file DataViewImpl.h.

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

Referenced by art::Run::endTime(), art::SubRun::endTime(), 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());
}

DataViewImpl::GroupQueryResultVec art::DataViewImpl::getMany_ ( WrappedTypeID const &  wrapped, SelectorBase const &  sel  ) const

private

Definition at line 53 of file DataViewImpl.cc.

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

Referenced by getMany().

  {
    return principal_.getMany(wrapped, sel);
  }

template<typename PROD >

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

inline

Definition at line 446 of file DataViewImpl.h.

References getMany().

Referenced by evd::RecoBaseDrawer::DrawShower3D(), evd::RecoBaseDrawer::DrawShowerOrtho(), evd::RecoBaseDrawer::DrawTrack3D(), evd::RecoBaseDrawer::DrawTrackOrtho(), art::Run::endTime(), art::SubRun::endTime(), simfilter::FilterCryostatNus::filter(), simfilter::FilterGenInTime::filter(), tca::TrajClusterAlg::GetHitCollection(), 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);
}

DataViewImpl::GroupQueryResultVec art::DataViewImpl::getMatchingSequenceByLabel_ ( std::string const &  label, std::string const &  productInstanceName, std::string const &  processName  ) const

private

Definition at line 70 of file DataViewImpl.cc.

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

Referenced by getView_().

  {
    Selector const sel{ModuleLabelSelector{label} &&
                       ProductInstanceNameSelector{productInstanceName} &&
                       ProcessNameSelector{processName}};
    return principal_.getMatchingSequence(sel);
  }

template<typename PROD >

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

inline

Definition at line 396 of file DataViewImpl.h.

References getByLabel().

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

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

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

protected

Definition at line 142 of file DataViewImpl.cc.

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

Referenced by checkPutProducts(), art::Results::put(), art::Event::put(), art::Run::put_(), art::SubRun::put_(), and 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

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(), art::Run::endTime(), art::SubRun::endTime(), anab::FVectorReader< T, N >::FVectorReader(), tca::TrajClusterAlg::GetHitCollection(), trkmkr::KalmanFilterFitTrackMaker::initEvent(), hit::HitFinder::produce(), trkf::TCTrack::produce(), cluster::LineCluster::produce(), hit::HitCheater::produce(), TrackProducerFromTrack::produce(), TrackProducerFromTrackTrajectory::produce(), phot::PhotonLibraryPropagation::produce(), cluster::ClusterCrawler::produce(), trkf::VertexFitter::produce(), t0::MCTruthT0Matching::produce(), trkf::KalmanFilterTrajectoryFitter::produce(), trkf::PMAlgTrackMaker::produce(), trkf::KalmanFilterFinalTrackFitter::produce(), and art::Event::put().

template<typename PROD >

ValidHandle<PROD> art::DataViewImpl::getValidHandle

(

ProductToken< PROD > const &

token

)

const

template<typename PROD >

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

inline

Definition at line 405 of file DataViewImpl.h.

References 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

inline

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

Definition at line 474 of file DataViewImpl.h.

References fillView_().

Referenced by larg4::LArG4Ana::analyze(), pmtana::PMTAna::analyze(), opdet::SimPhotonCounter::analyze(), evd::RecoBaseDrawer::CountHits(), art::Run::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(), getView(), event::EventCheater::produce(), hit::HitCheater::produce(), opdet::OpticalRawDigitReformatter::produce(), opdet::OpHitFinder::produce(), detsim::SimWire::produce(), detsim::SimWireT962::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

Definition at line 486 of file DataViewImpl.h.

References 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

template<typename ELEMENT >

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

Definition at line 497 of file DataViewImpl.h.

References 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

Definition at line 510 of file DataViewImpl.h.

References 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

Definition at line 521 of file DataViewImpl.h.

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

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

template<typename ELEMENT >

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

private

template<typename ELEMENT >

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

Definition at line 453 of file DataViewImpl.h.

References branchType_, consumer_, ensureUniqueProduct_(), getMatchingSequenceByLabel_(), 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_<>()

DataViewImpl& art::DataViewImpl::operator= ( DataViewImpl const &  )

delete

ProcessHistory const & art::DataViewImpl::processHistory

(

)

const

Definition at line 81 of file DataViewImpl.cc.

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

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

  {
    return principal_.processHistory();
  }

TypeLabelMap& art::DataViewImpl::putProducts ( )

inlineprotected

Definition at line 183 of file DataViewImpl.h.

References putProducts_.

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

  {
    return putProducts_;
  }

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

inlineprotected

Definition at line 188 of file DataViewImpl.h.

References putProducts_.

  {
    return putProducts_;
  }

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

protected

Definition at line 87 of file DataViewImpl.cc.

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

Referenced by fillView_(), get(), getByLabel(), and 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

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 removeCachedProduct_().

Referenced by art::Run::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;
}

void art::DataViewImpl::removeCachedProduct_ ( ProductID const  pid ) const

private

Definition at line 196 of file DataViewImpl.cc.

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

Referenced by removeCachedProduct().

  {
    principal_.removeCachedProduct(pid);
  }

void art::DataViewImpl::removeNonViewableMatches_ ( TypeID const &  requestedElementType, GroupQueryResultVec &  results  ) const

private

Definition at line 154 of file DataViewImpl.cc.

References evd::details::begin(), evd::details::end(), art::TypeID::typeInfo(), and art::detail::upcastAllowed().

Referenced by getView_().

  {
    // To determine if the requested view is allowed, the matched
    // 'results' (products) must be read.
    auto not_convertible = [&requestedElementType](auto const& query_result) {
      // Assns collections do not support views; we therefore do not
      // need to worry about an exception throw when calling
      // uniqueProduct.
      auto group = query_result.result();
      assert(group->productDescription().supportsView());
      auto p = group->uniqueProduct();
      return !detail::upcastAllowed(*p->typeInfo(),
                                    requestedElementType.typeInfo());
    };
    results.erase(std::remove_if(begin(results), end(results), not_convertible),
                  end(results));
  }

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

protected

Definition at line 100 of file DataViewImpl.cc.

References retrievedProducts_.

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

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

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

inlineprotected

Definition at line 197 of file DataViewImpl.h.

References checkPutProducts(), getProductDescription(), putProducts(), retrievedProductIDs(), and retrievedProducts_.

  {
    return retrievedProducts_;
  }

size_t art::DataViewImpl::size

(

void

)

const

Definition at line 34 of file DataViewImpl.cc.

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

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

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

Member Data Documentation

BranchType const art::DataViewImpl::branchType_

private

Definition at line 283 of file DataViewImpl.h.

Referenced by DataViewImpl(), getByLabel(), getMany(), getProductDescription(), and getView_().

cet::exempt_ptr<Consumer> art::DataViewImpl::consumer_

private

Definition at line 291 of file DataViewImpl.h.

Referenced by DataViewImpl(), getByLabel(), getMany(), and getView_().

ModuleDescription const& art::DataViewImpl::md_

private

Definition at line 280 of file DataViewImpl.h.

Referenced by DataViewImpl(), and getProductDescription().

Principal const& art::DataViewImpl::principal_

private

Definition at line 276 of file DataViewImpl.h.

Referenced by get_(), getByLabel_(), getByProductID_(), getMany_(), getMatchingSequenceByLabel_(), processHistory(), removeCachedProduct_(), and size().

TypeLabelMap art::DataViewImpl::putProducts_ {}

private

Definition at line 266 of file DataViewImpl.h.

Referenced by putProducts(), and size().

bool const art::DataViewImpl::recordParents_

private

Definition at line 286 of file DataViewImpl.h.

Referenced by DataViewImpl(), get(), getByLabel(), and getMany().

RetrievedProductSet art::DataViewImpl::retrievedProducts_ {}

mutableprivate

Definition at line 272 of file DataViewImpl.h.

Referenced by recordAsParent(), retrievedProductIDs(), and retrievedProducts().

---

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

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