Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > > Class Template Reference

#include "/cvmfs/nova.opensciencegrid.org/externals/art/v2_13_00/source/art/Framework/Modules/ProvenanceDumper.h"

Inheritance diagram for art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >:
art::OutputModule art::EventObserverBase art::Consumer

Public Types

using Parameters = fhicl::WrappedTable< ProvenanceDumperConfig< DETAIL >, art::OutputModule::Config::KeysToIgnore >
 
using ModuleType = OutputModule
 
using WorkerType = OutputWorker
 

Public Member Functions

 ProvenanceDumper (Parameters const &ps)
 
int maxEvents () const
 
int remainingEvents () const
 
bool fileIsOpen () const
 
OutputFileStatus fileStatus () const
 
virtual std::string const & lastClosedFileName () const
 
bool selected (BranchDescription const &) const
 
SelectionsArray const & keptProducts () const
 
std::array< bool, NumBranchTypes > const & hasNewlyDroppedBranch () const
 
BranchChildren const & branchChildren () const
 
void selectProducts (ProductList const &)
 
void registerProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)
 
bool modifiesEvent () const
 
std::string const & processName () const
 
bool wantAllEvents () const
 
bool wantEvent (Event const &e)
 
fhicl::ParameterSetID selectorConfig () const
 
art::Handle< art::TriggerResultsgetTriggerResults (Event const &e) const
 
template<typename T , BranchType = InEvent>
ProductToken< Tconsumes (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< Tconsumes (InputTag const &it)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ViewToken< TconsumesView (InputTag const &it)
 
template<typename T , BranchType = InEvent>
ProductToken< TmayConsume (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< TmayConsume (InputTag const &it)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
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

CurrentProcessingContext const * currentContext () const
 
ModuleDescription const & description () const
 
virtual void postSelectProducts ()
 
virtual void doRegisterProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)
 
detail::CachedProductscachedProducts ()
 
void validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
 
void prepareForJob (fhicl::ParameterSet const &pset)
 
void showMissingConsumes () const
 

Private Member Functions

void beginJob () override
 
void endJob () override
 
void write (EventPrincipal &e) override
 
void writeSubRun (SubRunPrincipal &sr) override
 
void writeRun (RunPrincipal &r) override
 

Private Attributes

DETAIL detail_
 
detail::PrincipalProcessor< DETAIL > pp_
 
detail::ProvenanceDumperImpl< DETAIL > impl_
 

Detailed Description

template<typename DETAIL>
class art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >

Definition at line 205 of file ProvenanceDumper.h.

Member Typedef Documentation

Definition at line 60 of file OutputModule.h.

Definition at line 211 of file ProvenanceDumper.h.

Definition at line 61 of file OutputModule.h.

Constructor & Destructor Documentation

template<typename DETAIL >
art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >::ProvenanceDumper ( Parameters const &  ps)
inlineexplicit

Definition at line 213 of file ProvenanceDumper.h.

References fhicl::WrappedTable< T, KeysToIgnore >::get_PSet(), impl_, and nd_projection_maker::ps.

214  : OutputModule{ps().omConfig, ps.get_PSet()}
215  , detail_{ps().user}
216  , pp_{detail_,
217  ps().wantPresentOnly(),
218  ps().resolveProducts(),
219  ps().wantResolvedOnly()}
220  , impl_{detail_, pp_}
221  {}
detail::ProvenanceDumperImpl< DETAIL > impl_
detail::PrincipalProcessor< DETAIL > pp_
OutputModule(OutputModule const &)=delete

Member Function Documentation

template<typename DETAIL >
void art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >::beginJob ( )
inlineoverrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 225 of file ProvenanceDumper.h.

References impl_.

226  {
227  impl_.beginJob();
228  }
detail::ProvenanceDumperImpl< DETAIL > impl_
art::BranchChildren const & art::OutputModule::branchChildren ( ) const
inlineinherited

Definition at line 347 of file OutputModule.h.

References art::OutputModule::branchChildren_.

Referenced by art::OutputModule::fileIsOpen().

348 {
349  return branchChildren_;
350 }
BranchChildren branchChildren_
Definition: OutputModule.h:170
detail::CachedProducts& art::EventObserverBase::cachedProducts ( )
inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

80  {
81  return selectors_;
82  }
detail::CachedProducts selectors_
template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::consumes ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::consumes ( InputTag const &  it)
inherited

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 ( )
inherited

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 &  )
inherited
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::consumesView ( InputTag const &  it)
inherited

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
art::CurrentProcessingContext const * art::OutputModule::currentContext ( ) const
inlineprotectedinherited

Definition at line 303 of file OutputModule.h.

References art::OutputModule::current_context_, and cet::exempt_ptr< Element >::get().

Referenced by art::OutputModule::fileIsOpen().

304 {
305  return current_context_.get();
306 }
pointer get() const noexcept
Definition: exempt_ptr.h:146
cet::exempt_ptr< CurrentProcessingContext const > current_context_
Definition: OutputModule.h:165
art::ModuleDescription const & art::OutputModule::description ( ) const
inlineprotectedinherited
virtual void art::OutputModule::doRegisterProducts ( MasterProductRegistry ,
ProductDescriptions ,
ModuleDescription const &   
)
protectedvirtualinherited

Reimplemented in art::RootOutput.

Referenced by art::OutputModule::fileIsOpen().

template<typename DETAIL >
void art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >::endJob ( )
inlineoverrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 230 of file ProvenanceDumper.h.

References impl_.

231  {
232  impl_.endJob();
233  }
detail::ProvenanceDumperImpl< DETAIL > impl_
bool art::OutputModule::fileIsOpen ( ) const
inlineinherited
OutputFileStatus art::OutputModule::fileStatus ( ) const
inherited
art::Handle<art::TriggerResults> art::EventObserverBase::getTriggerResults ( Event const &  e) const
inlineinherited

Definition at line 61 of file EventObserverBase.h.

References art::detail::CachedProducts::getOneTriggerResults(), and art::EventObserverBase::selectors_.

62  {
64  }
detail::CachedProducts selectors_
art::Handle< art::TriggerResults > getOneTriggerResults(Event const &) const
Float_t e
Definition: plot.C:35
auto art::OutputModule::hasNewlyDroppedBranch ( ) const
inlineinherited
auto art::OutputModule::keptProducts ( ) const
inlineinherited

Definition at line 334 of file OutputModule.h.

References art::OutputModule::keptProducts_.

Referenced by art::OutputModule::fileIsOpen().

335 {
336  return keptProducts_;
337 }
SelectionsArray keptProducts_
Definition: OutputModule.h:156
virtual std::string const& art::OutputModule::lastClosedFileName ( ) const
virtualinherited

Reimplemented in art::RootOutput.

Referenced by art::OutputModule::fileIsOpen().

int art::OutputModule::maxEvents ( ) const
inlineinherited

Definition at line 315 of file OutputModule.h.

References art::OutputModule::maxEvents_.

316 {
317  return maxEvents_;
318 }
template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::mayConsume ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::mayConsume ( InputTag const &  it)
inherited

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 ( )
inherited

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 &  )
inherited
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const &  it)
inherited

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
bool art::EventObserverBase::modifiesEvent ( ) const
inlineinherited

Definition at line 25 of file EventObserverBase.h.

26  {
27  return false;
28  }
static cet::exempt_ptr<Consumer> art::Consumer::non_module_context ( )
staticinherited
virtual void art::OutputModule::postSelectProducts ( )
protectedvirtualinherited

Reimplemented in art::RootOutput.

Referenced by art::OutputModule::fileIsOpen().

void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset)
protectedinherited
std::string const& art::EventObserverBase::processName ( ) const
inlineinherited
void art::OutputModule::registerProducts ( MasterProductRegistry ,
ProductDescriptions ,
ModuleDescription const &   
)
inherited
int art::OutputModule::remainingEvents ( ) const
inlineinherited

Definition at line 321 of file OutputModule.h.

References art::OutputModule::remainingEvents_.

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

322 {
323  return remainingEvents_;
324 }
bool art::OutputModule::selected ( BranchDescription const &  pd) const
inlineinherited

Definition at line 327 of file OutputModule.h.

References ana::assert(), and art::OutputModule::groupSelector_.

Referenced by art::OutputModule::fileIsOpen().

328 {
330  return groupSelector_->selected(pd);
331 }
std::unique_ptr< GroupSelector const > groupSelector_
Definition: OutputModule.h:160
assert(nhit_max >=nhit_nbins)
fhicl::ParameterSetID art::EventObserverBase::selectorConfig ( ) const
inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

57  {
58  return selector_config_id_;
59  }
fhicl::ParameterSetID selector_config_id_
void art::OutputModule::selectProducts ( ProductList const &  )
inherited
void art::Consumer::showMissingConsumes ( ) const
protectedinherited

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

void art::Consumer::validateConsumedProduct ( BranchType const  bt,
ProductInfo const &  pi 
)
protectedinherited
bool art::EventObserverBase::wantAllEvents ( ) const
inlineinherited

Definition at line 46 of file EventObserverBase.h.

References art::EventObserverBase::wantAllEvents_.

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

47  {
48  return wantAllEvents_;
49  }
bool art::EventObserverBase::wantEvent ( Event const &  e)
inlineinherited

Definition at line 51 of file EventObserverBase.h.

References art::EventObserverBase::selectors_, and art::detail::CachedProducts::wantEvent().

52  {
53  return selectors_.wantEvent(e);
54  }
detail::CachedProducts selectors_
Float_t e
Definition: plot.C:35
bool wantEvent(Event const &)
template<typename DETAIL >
void art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >::write ( EventPrincipal e)
inlineoverrideprivatevirtual

Implements art::OutputModule.

Definition at line 236 of file ProvenanceDumper.h.

References impl_.

237  {
238  impl_.write(e);
239  }
detail::ProvenanceDumperImpl< DETAIL > impl_
Float_t e
Definition: plot.C:35
template<typename DETAIL >
void art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >::writeRun ( RunPrincipal r)
inlineoverrideprivatevirtual

Implements art::OutputModule.

Definition at line 246 of file ProvenanceDumper.h.

References impl_.

247  {
248  impl_.writeRun(r);
249  }
detail::ProvenanceDumperImpl< DETAIL > impl_
TRandom3 r(0)
template<typename DETAIL >
void art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >::writeSubRun ( SubRunPrincipal sr)
inlineoverrideprivatevirtual

Implements art::OutputModule.

Definition at line 241 of file ProvenanceDumper.h.

References impl_.

242  {
243  impl_.writeSubRun(sr);
244  }
detail::ProvenanceDumperImpl< DETAIL > impl_
caf::StandardRecord * sr

Member Data Documentation

template<typename DETAIL >
DETAIL art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >::detail_
private

Definition at line 251 of file ProvenanceDumper.h.

template<typename DETAIL >
detail::ProvenanceDumperImpl<DETAIL> art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >::impl_
private

Definition at line 253 of file ProvenanceDumper.h.

template<typename DETAIL >
detail::PrincipalProcessor<DETAIL> art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >::pp_
private

Definition at line 252 of file ProvenanceDumper.h.


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