Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
art::Consumer Class Reference

#include "/cvmfs/nova.opensciencegrid.org/externals/art/v2_13_00/source/art/Framework/Principal/Consumer.h"

Inheritance diagram for art::Consumer:
art::EDAnalyzer art::EDFilter art::EDProducer art::OutputModule art::ResultsProducer air::AirKalmanAna air::AirShower air::AirTree air::CosmicTrackRate align::AlignInspect align::Alignment align::SplitTracks BeamlineAna beamlinereco::BeamlineRecoDump beamlinereco::EventWaveformDump beamlinereco::ToFAnalysisMini beamlinereco::ToFPositionRecoAnalysis beamlinereco::ToFRecoAnalysis beamlinereco::ToFSingleCounterAnalysis beamlinerecoana::WCTrackRecoAnalysis beamlinesim::CombinedBeamlineDetectorAna bpf::BPFCVNAna bpfit::BPFdEdxHistoMaker bpfit::BPFEnergyAna bpfit::BPFTmvaTrainer bpfit::BreakPointAna bpfit::BreakPointProtonAna calhit::CalHitAna calib::AbsCalib calib::ADCShapeFitAna calib::AssessCalib calib::AttenFit calib::BetheBlochFit calib::CalibAna calib::CosmicTrends calib::EnergyStandardCandles calib::HitEfficiency calib::ParticleCorrections calib::PEResponse calib::StopperThreshold calib::SystematicUncertaintyScaleAna calib::TestParticleCorrections calib::ThresholdAna CerenkovResponse chaninfo::BadChanValidate chaninfo::CosmicEff chaninfo::PedestalThresholdValidation cheat::CheckBackTracking cheat::RecoCheckAna cheat::TestTrackIds cmf::CAFToEventList cmf::CMFSpectraMaker comi::ChanOcc comi::CosmicMetrics comi::DataCheck comi::FEBFlash comi::Leana comi::NearlineAna comi::NumiFilteringAna cvn::CVNCosmicEventDump cvn::CVNEventDump cvn::CVNEventProngDump ddt::DataSliceEva ddt::DDTEva ddt::SlicerEva ddt::SMMADC ddt::SMMEff ddt::SuperDDTEva dprf::ChannelPlots dprf::TrackPlots dq::DAQHeaderSummaryAna earms::ElasticArmsValidate evd::EVD evtsum::EventSummary febstat::EventFEBStatus febstat::FEBShutoff fnex::AnalyzeWeighters fnex::CAFContourMaker fnex::CAFToEventList fnex::CalibSystHistMaker fnex::CompareFNEXCAFEventListFiles fnex::EventListMaker fnex::ReadCAFMakeEventList fnex::SortEventLists fnex::SpectrumTest fnex::SystematicsWeightTest fuzz::FuzzyKValidate G4MismatchAna geo::CoordinateTransformationTest geo::GeometryTest hdf5::HDF5Maker highe::HighEnergyAna hough::HoughValidate htk::HoughTrack jmshower::RecoJMShowerAna LightLevels mcchk::CloseInTime mcchk::CosmicAna mcchk::DetAna mcchk::DetAna mcchk::DetSimAna mcchk::LeptonAna mcchk::MonopoleAna mcchk::NeutrinoAna mcchk::NullAna mcchk::POTAna mcchk::RockAna mcchk::ShowerAnaCheck mcdatadaq::MockDataDAQAna meta::Metadata mmc::Validation mono::DataCheckMonopole Mono::Mono mono::Monopole mono::SlowMonopoleAna moonshadowana::MoonShadowAna moonshadowana::MoonShadowAnaHough murem::MRCCAna murem::MuonRemoveAna ncid::NCNNKerasVal ncpi0::TwoProngBDTAna ncs::GenieTruth ncs::NCAna ncs::ROCKMRE ncs::Xbeam ncs::Xeff nnbar::RecoAnalysis nnbar::ShowerMuonCoincidence nnbar::SigVsBkgSimCompare novaddt::Calibration novaddt::ChannelMapMaker novaddt::ClusterAna novaddt::DAQHeaderAna novaddt::DDTEvd novaddt::Evaluation novaddt::EvTimeAna novaddt::GHLTest novaddt::HitsAna novaddt::HitsAna novaddt::HorizontalMuonAna novaddt::HorizontalMuonAna novaddt::HotMapMaker novaddt::MilliBlockChecking novaddt::NoiseMapAna novaddt::NovaDDTTrigger novaddt::RateMonitor novaddt::SendTriggerSignal novaddt::SingletonRejectionAna novaddt::SNAna novaddt::TriCellTriggerAna novaddt::UpMuAna novatb::BeamTuning novatb::TOFTimingResolution novatb::TOFTriggerAna novatb::TriggerRateAna numue::NumuEAna om::OnMonProd om::TestTMapFile pa::ClusterEva pa::HitEva qeef::QeFinderVal red::EWCosmics remid::ReMIdDedx remid::ReMIdDedxFD remid::ReMIdDedxRock remid::ReMIdDedxStudies remid::ReMIdTrain remid::ReMIdValidate rockmuon::NDRockMuon rsim::MakeNoiseSpectrumFile rsim::RecordNoiseSpectrumFile rwgt::RwgtTest showere::ShowerEnergyAna skim::CosmicBeamComparison skim::SkimmerAna slicer::IdenticalSlicerAna slicer::S4DParamCalc slicer::SlicerAna slid::LIDTraining sn::SNMichelAnalyzer sn::SNSlicerAna sn::SupernovaAna spilltime supernova::SimAna supernova::sliceAna supernova::SnovaAna tbana::BeamlineTriggerAna tbana::BeamStructureAna tbana::DetectorRateShutOff tbana::DSToFAna tbana::RawFileDumper tbem::TBRecoAna Test testbeam::BeamlineEventDisplay testbeam::BeamlineRecoValidation testbeam::TestBeamCommissioning trigmon::LongReadoutAnalyzer trk::CosmicTrackAna trk::KalmanTrackAna tut::reco2016::RecoObjectsTutorial tut::RecoValidationTutorial tut::TutAnalyzer tut::yn2017::AnalysisModule tut::yn2017::DebugThis upmuana::UpMuAnalysis upmuana::UpMuRecoAna validation::NoiseClusterAnalysis validation::ValidateChannelInfo validation::ValidateDAQ2RawDigit ve::VertexEva vf::TrackEva zcl::FastMMStudy zcl::FmmTrackerAna zcl::FmmTrackerValidation zcl::FmmTriggerAna zcl::MMCheater zcl::SMMTriggerAna air::AirFilter art::BlockingPrescaler art::EventIDFilter art::MixFilter< T > art::Prescaler beamlinereco::DigitizerSaturationFilter beamlinereco::GoodBeamlineEventFilter beamlinereco::ToFFilter bsf::BremShowerFilter calhit::HasCellHits calib::CosmicCalib calib::DCMTimingOffset calib::DetRespDrift calib::FindOutliers calib::MuondEdx calib::MuondEdxAna calib::MuonTrackHits calib::RockMuonStopperSelection calib::StopperFilter calib::StopperSelection calib::SumRunsCalib calib::SumSubrunsCalib calib::ThroughgoingSelection calib::TimingCalFilter chaninfo::FindSwappedChannels comi::CanaFilter comi::NumiFiltering DataCheck::HardwareStatusCheck EliminateBeamSpills EventFilter evgen::CRVFilter evgen::GENIEFilter evgen::OccupiedSpillFilter EvTimeFilter filter::Filter filter::FLSFilter filter::SkipNEvents filter::TruthContain highe::HighEnergyFilt jmshower::RecoJMShowerFilter lem::ApplyFilter lem::BackgroundEnricher mono::EventSelector mono::HighEnergySliceRemoval mono::MonopoleCluster mono::MonopoleTrack mono::SlowMonopoleFilt novaddt::ActiveDCMFilter novaddt::ActivityTrigger novaddt::ActivityTriggerAna novaddt::ClusterConvert novaddt::Clusterer novaddt::ContainedSlice novaddt::DBSlicer novaddt::DCMSlice novaddt::DDTDemo novaddt::DDTStreamer novaddt::DDTTrackMerge novaddt::DropoutDCMFilter novaddt::EventPrescale novaddt::FastMMTrigger novaddt::FEBFlashFilter novaddt::FEBOverflowTrigger novaddt::HighADCFilter novaddt::HighETrigger novaddt::HighSortByTDC novaddt::HorizontalMuonTrigger novaddt::HoughTracker novaddt::Merge2DTracks novaddt::MichelETrigger novaddt::MoonShadow novaddt::Multiplet novaddt::NNFastMMTrigger novaddt::NuESelect novaddt::NuMuTrigger novaddt::RemoveNoise novaddt::RemoveOneDSlices novaddt::RemoveSpatialNoise novaddt::RestrictHitsByPlane novaddt::SingletonRejection novaddt::SlicePrescale novaddt::Slicer3D novaddt::SlowMMTrigger novaddt::SlowMonopoleTrigger novaddt::SortByDCM novaddt::SortByPlane novaddt::SortByTDC novaddt::SpaceSlice novaddt::SupernovaTrigger novaddt::TDSlice novaddt::TimeDCMSlice novaddt::TimeSlice novaddt::TriCellTrigger novaddt::UpMuTestTrigger novaddt::UpMuTrigger runh::BadDataFilter showere::ShowerEnergyFilterMC skim::CellHitSkimmer skim::RandomEventFilter snutil::DDSNEWSfilter supernova::HighEFinder tut::TutFilter util::CopyCellHits util::EventFilterNoSlice util::HasStandardRecord util::MergeSubruns util::NonEmptyCluster util::RemoveBeamSpills util::RemoveBeamSpillsPrecise util::RemoveTBSpills util::RunEventFilter util::TimeFilter airshower::AirSlicer art::RandomNumberSaver art::TriggerResultInserter beamlinereco::CFDHitReco beamlinereco::CkovCounterReco beamlinereco::LEHitReco beamlinereco::TimeOfFlightReco beamlinereco::ToFCalibration beamlinereco::WCTrackReco beamlinesim::BeamlineSimInput bpfit::BPFEnergyEstimator bpfit::BPFEnergyEstimatorOnly bpfit::BPFPIdMaker bpfit::BreakPoint bpfit::DimuonFitter caf::CAFMaker calhit::CalHit calhit::RemoveBadChannels calib::DriftCorrection calib::DriftResponseCalc calib::FiberCalibration calib::PCHitAggregator calib::PCHitsList calib::PCHitTransposer calib::ResizeDetector calib::TimingCalibration cheat::ClusterCheater cheat::MCCheater cheat::ProngCheater cheat::ShowerCheater cheat::TrackCheater cheat::TrueEnergy comi::Cana cosmic::CosmicExposureInfo cosrej::CosRej cosrej::MakeNueCosRej crvtx::CosmicRayVertex cvn::CVNAddTrainingData cvn::CVNCosmicMapper cvn::CVNMapper cvn::RegCVNMapper cvneventtf::CVNEventTF cvnneutronprongtf::CVNNeutronProngTF cvnprongtf::CVNProngTF cvntf::CVNCosmicTF cvntf::CVNCosmicTFFilt cvntf::CVNProngEvaluatorTF cvntf::CVNTF daq2raw::DAQHit2Raw demo::DemoModule dif::DiFShowerFinder dq::DAQHeaderSummary dqsf::DQSpillFlags dt::DiscreteTracker dt::ViewMerger earms::ElasticArmsHS evgen::CORSIKAGen evgen::CosmicPionGen evgen::CosmicsGen evgen::GENIEGen evgen::GENIENeutronOscGen evgen::GENIERockGen evgen::IsoGen evgen::SingleGen evgen::SupernovaGen evgen::TextFileGen filter::TruthFilter flat::FlatMaker fuzz::FuzzyKVertex fxwgt::FluxWeightCalculator g4n::G4Gen g4n::TruthSlim gibuu::GiBUURegen hough::HoughT hough::MultiHoughT hv::HoughVertex ifdb::IFDBSpillInfo ifdb::MIN ifdb::TBSpillInfo jmshower::JMClusterMerge jmshower::JMTrackMerge jmshower::NueSel jmshower::NueSelLID jmshower::RecoJMShower lem::AlignLibToVtx lem::FindLEMMatches lem::FindMatchesTranspose lem::LEM lem::LEMAssociator lem::LEMClient lem::LEMSummarizer lem::LEMWorker lem::LEMWorkerOutput lem::MakeLibrary lem::MakeMatches lem::MakePID lem::MergeMatches lem::Preselection lem::UnTranspose LSTME::FillLSTME me::MEFinder MergeCalCollections::MergeCalCollections MergeCollections::MergeCollections MergeDaqCollections::MergeDaqCollections MergeG4Collections::MergeG4Collections MergeGenCollections::MergeGenCollections MergeTBDaqCollections::MergeTBDaqCollections muonid::MuonIDProd murem::FindMREParent murem::FindParent murem::MergeDigits murem::MergeTruth murem::MRE murem::MuonRemove NAMESPACE::MODULENAME ncid::MakeNCCosRej ncid::NCNNKeras ncpi0::MakeNCPi0BkgRej ndreco::NDReco nerd::NERDProng nnbar::ShowerProducer noe::noe novaddt::HitSubtract novaddt::MichelEfinder novaddt::NoiseHitFinder novaddt::SortByView novaddt::TrackFit NovaDDTHitProducer nuesand::FillNueSandbox numue::NumuEnergy numue::TrackOverlapECalc numusand::FillSandbox nuonecvntf::NuonECVNTF nussand::FillNusSandbox photrans::ImprovedTransport photrans::PhotonSystRewriter photrans::PhotonTransport presel::CosmicCVNVeto presel::CosmicVeto presel::LEMPresel presel::NuePresel presel::RockPresel qeef::QeFinder raw2daq::RawDigit2DAQHit recodemo::RecoDemo regcvntf::RegCVNTF remid::RecoMuon rsim::ReadoutSim rvp::RecVarPID rwgt::MakeGENIEReweightTable skim::DataProductSkimmer skim::NueSkim skim::NumuCCpiSkim skim::NumuSkim SliceLID::FillSliceLID slicemergeviews::SliceMergeViews slicer::MMSlicer slicer::Slicer slicer::Slicer4D slicer::TruthSlicer slid::LIDBuilder slid::Recluster slid::SliceLIDBuilder slid::SPIDBuilder sn::SNBackgroundRejection sn::SNSlicer sn::SupernovaMCCluster supernova::SnovaGen tdslicer::TDSlicer tf::TimingFit trackinfo::TrackInfo trk::CosmicTrack trk::KalmanTrack trk::KalmanTrackMerge trk::TrkAssn tut::TutProducer tut::yn2020::FancyScience upmuana::UpMuProb util::FakeSpillData util::RewriteSpillData util::StoreGDML util::TruthExpand util::WriteHornCurrentCosmic vdt::VertexDT vf::VertexFinder wcvtx::WCVertex wsnumu::WSNumu xnue::XnuePID xsrec::MakeXSecCCPi0Inc zcl::FMMTracker zcl::FmmTriggerEvd zcl::SMMCluster zcl::SPCluster art::FileDumperOutput art::ProvenanceCheckerOutput art::ProvenanceDumper< DETAIL, Enable > art::ProvenanceDumper< DETAIL,                                                                                                                                                                                   cet::enable_if_type_exists_t< typename DETAIL::Config > > art::RootOutput calib::AttenuationFit calib::MakeAttenuationProfiles calib::SumAttenuationProfiles cmf::CMFDecorrelator cmf::CombineResults cmf::ContourFromLibrary cmf::CovarianceMatrixFitter cmf::CovarianceMatrixMaker cmf::FitFeldmanCousinsPoint cmf::PredictionLibraryMaker cmf::RandomUniverses fnex::ContourMaker fnex::CovarianceMatrixFitter fnex::CovarianceMatrixMaker fnex::FakePointResultMaker fnex::FitPoint fnex::PlotPoint fnex::ReadFitResults fnex::SensitivityPointsMaker fnex::StarPlot skim::POTSummary

Classes

struct  InvalidTag
 

Public Member Functions

 Consumer ()=default
 
template<typename T , BranchType = InEvent>
ProductToken< Tconsumes (InputTag const &)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , BranchType = InEvent>
ProductToken< TmayConsume (InputTag const &)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< Tconsumes (InputTag const &it)
 
template<typename T , art::BranchType BT>
art::ViewToken< TconsumesView (InputTag const &it)
 
template<typename T , art::BranchType BT>
art::ProductToken< TmayConsume (InputTag const &it)
 
template<typename T , art::BranchType BT>
art::ViewToken< TmayConsumeView (InputTag const &it)
 

Static Public Member Functions

static cet::exempt_ptr< Consumernon_module_context ()
 

Protected Member Functions

void validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
 
void setModuleDescription (ModuleDescription const &md)
 
void prepareForJob (fhicl::ParameterSet const &pset)
 
void showMissingConsumes () const
 

Private Types

using ConsumableType = ProductInfo::ConsumableType
 

Private Member Functions

 Consumer (InvalidTag)
 

Private Attributes

bool moduleContext_ {true}
 
bool requireConsumes_ {false}
 
ConsumableProducts consumables_ {}
 
ConsumableProductSets missingConsumes_ {}
 
cet::exempt_ptr< ModuleDescription const > moduleDescription_ {nullptr}
 

Friends

class DataViewImpl
 

Detailed Description

Definition at line 87 of file Consumer.h.

Member Typedef Documentation

Definition at line 132 of file Consumer.h.

Constructor & Destructor Documentation

art::Consumer::Consumer ( )
explicitdefault
art::Consumer::Consumer ( InvalidTag  )
inlineexplicitprivate

Definition at line 133 of file Consumer.h.

133 : moduleContext_{false} {}
bool moduleContext_
Definition: Consumer.h:135

Member Function Documentation

template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::consumes ( InputTag const &  )
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::consumes ( InputTag const &  it)

Definition at line 146 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

147 {
148  if (!moduleContext_)
149  return ProductToken<T>::invalid();
150 
151  consumables_[BT].emplace_back(ConsumableType::Product,
152  TypeID{typeid(T)},
153  it.label(),
154  it.instance(),
155  it.process());
156  return ProductToken<T>{it};
157 }
set< int >::iterator it
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename T , art::BranchType BT>
void art::Consumer::consumesMany ( )

Definition at line 161 of file Consumer.h.

References T.

162 {
163  if (!moduleContext_)
164  return;
165 
166  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
167 }
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::Consumer::consumesView ( InputTag const &  )
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::consumesView ( InputTag const &  it)

Definition at line 171 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

172 {
173  if (!moduleContext_)
174  return ViewToken<T>::invalid();
175 
176  consumables_[BT].emplace_back(ConsumableType::ViewElement,
177  TypeID{typeid(T)},
178  it.label(),
179  it.instance(),
180  it.process());
181  return ViewToken<T>{it};
182 }
set< int >::iterator it
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::mayConsume ( InputTag const &  )
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::mayConsume ( InputTag const &  it)

Definition at line 189 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

190 {
191  if (!moduleContext_)
192  return ProductToken<T>::invalid();
193 
194  consumables_[BT].emplace_back(ConsumableType::Product,
195  TypeID{typeid(T)},
196  it.label(),
197  it.instance(),
198  it.process());
199  return ProductToken<T>{it};
200 }
set< int >::iterator it
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename T , art::BranchType BT>
void art::Consumer::mayConsumeMany ( )

Definition at line 204 of file Consumer.h.

References T.

205 {
206  if (!moduleContext_)
207  return;
208 
209  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
210 }
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const &  )
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const &  it)

Definition at line 214 of file Consumer.h.

References art::InputTag::instance(), PandAna.reco_validation.prod5_pid_validation::invalid, art::InputTag::label(), art::InputTag::process(), and T.

215 {
216  if (!moduleContext_)
217  return ViewToken<T>::invalid();
218 
219  consumables_[BT].emplace_back(ConsumableType::ViewElement,
220  TypeID{typeid(T)},
221  it.label(),
222  it.instance(),
223  it.process());
224  return ViewToken<T>{it};
225 }
set< int >::iterator it
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:137
double T
Definition: Xdiff_gwt.C:5
bool moduleContext_
Definition: Consumer.h:135
static cet::exempt_ptr<Consumer> art::Consumer::non_module_context ( )
static
void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset)
protected
void art::Consumer::setModuleDescription ( ModuleDescription const &  md)
protected
void art::Consumer::showMissingConsumes ( ) const
protected

Referenced by art::RootOutput::endJob().

void art::Consumer::validateConsumedProduct ( BranchType const  bt,
ProductInfo const &  pi 
)
protected

Friends And Related Function Documentation

friend class DataViewImpl
friend

Definition at line 117 of file Consumer.h.

Member Data Documentation

ConsumableProducts art::Consumer::consumables_ {}
private

Definition at line 137 of file Consumer.h.

ConsumableProductSets art::Consumer::missingConsumes_ {}
private

Definition at line 138 of file Consumer.h.

bool art::Consumer::moduleContext_ {true}
private

Definition at line 135 of file Consumer.h.

cet::exempt_ptr<ModuleDescription const> art::Consumer::moduleDescription_ {nullptr}
private

Definition at line 139 of file Consumer.h.

bool art::Consumer::requireConsumes_ {false}
private

Definition at line 136 of file Consumer.h.


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