#include <MixFilter.h>

Inheritance diagram for art::MixFilter< T, IOPolicy >:

Public Types
using	MixDetail = T

using	Parameters = typename detail::maybe_has_Parameters< T >::Parameters

Public Types inherited from art::EDFilter
using	ModuleType = EDFilter

using	WorkerType = WorkerT< EDFilter >

Public Types inherited from art::detail::Filter
template<typename UserConfig >
using	Table = Modifier::Table< UserConfig >

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
template<typename U = Parameters>
	MixFilter (std::enable_if_t< std::is_same_v< U, fhicl::ParameterSet >, fhicl::ParameterSet > const &p)

template<typename U = Parameters>
	MixFilter (std::enable_if_t<!std::is_same_v< U, fhicl::ParameterSet >, U > const &p)

Public Member Functions inherited from art::EDFilter
	EDFilter (fhicl::ParameterSet const &pset)

template<typename Config >
	EDFilter (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Filter
virtual	~Filter () noexcept

	Filter (fhicl::ParameterSet const &)

	Filter (Filter const &)=delete

	Filter (Filter &&)=delete

Filter &	operator= (Filter const &)=delete

Filter &	operator= (Filter &&)=delete

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

Public Member Functions inherited from art::Modifier
	~Modifier () noexcept

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Member Functions
void	respondToOpenInputFile (FileBlock const &fb) override

void	respondToCloseInputFile (FileBlock const &fb) override

void	respondToOpenOutputFiles (FileBlock const &fb) override

void	respondToCloseOutputFiles (FileBlock const &fb) override

bool	filter (Event &e) override

bool	beginSubRun (SubRun &sr) override

bool	endSubRun (SubRun &sr) override

bool	beginRun (Run &r) override

bool	endRun (Run &r) override

Private Attributes
MixHelper	helper_

MixDetail	detail_

Additional Inherited Members
Static Public Attributes inherited from art::detail::Filter
static constexpr bool	Pass {true}

static constexpr bool	Fail {false}

Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

template<typename T, typename IOPolicy>
class art::MixFilter< T, IOPolicy >

Definition at line 155 of file MixFilter.h.

Member Typedef Documentation

template<typename T , typename IOPolicy >

using art::MixFilter< T, IOPolicy >::MixDetail = T

Definition at line 384 of file MixFilter.h.

template<typename T , typename IOPolicy >

using art::MixFilter< T, IOPolicy >::Parameters = typename detail::maybe_has_Parameters<T>::Parameters

Definition at line 386 of file MixFilter.h.

Constructor & Destructor Documentation

template<typename T , typename IOPolicy >

template<typename U >

art::MixFilter< T, IOPolicy >::MixFilter ( std::enable_if_t< std::is_same_v< U, fhicl::ParameterSet >, fhicl::ParameterSet > const & p )

explicit

Definition at line 412 of file MixFilter.h.

   : EDFilter{p}
   , helper_{p,
             p.template get<std::string>("module_label"),
             producesCollector(),
             std::make_unique<IOPolicy>()}
   , detail_{p, helper_}
 {
   if constexpr (detail::has_eventsToSkip<T>::value) {
     helper_.setEventsToSkipFunction([this] { return detail_.eventsToSkip(); });
   }
 }

template<typename T , typename IOPolicy >

template<typename U >

art::MixFilter< T, IOPolicy >::MixFilter ( std::enable_if_t<!std::is_same_v< U, fhicl::ParameterSet >, U > const & p )

explicit

Definition at line 429 of file MixFilter.h.

   : EDFilter{p}
   , helper_{p().mixHelper(),
             p.get_PSet().template get<std::string>("module_label"),
             producesCollector(),
             std::make_unique<IOPolicy>()}
   , detail_{p().userConfig, helper_}
 {
   if constexpr (detail::has_eventsToSkip<T>::value) {
     helper_.setEventsToSkipFunction([this] { return detail_.eventsToSkip(); });
   }
 }

Member Function Documentation

template<typename T , typename IOPolicy >

bool art::MixFilter< T, IOPolicy >::beginRun ( Run & r )

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 546 of file MixFilter.h.

 {
   if constexpr (detail::has_beginRun<T>::value) {
     detail_.beginRun(r);
   }
   return true;
 }

template<typename T , typename IOPolicy >

bool art::MixFilter< T, IOPolicy >::beginSubRun ( SubRun & sr )

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 526 of file MixFilter.h.

 {
   if constexpr (detail::has_beginSubRun<T>::value) {
     detail_.beginSubRun(sr);
   }
   return true;
 }

template<typename T , typename IOPolicy >

bool art::MixFilter< T, IOPolicy >::endRun ( Run & r )

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 556 of file MixFilter.h.

 {
   if constexpr (detail::has_endRun<T>::value) {
     detail_.endRun(r);
   }
   return true;
 }

template<typename T , typename IOPolicy >

bool art::MixFilter< T, IOPolicy >::endSubRun ( SubRun & sr )

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 536 of file MixFilter.h.

 {
   if constexpr (detail::has_endSubRun<T>::value) {
     detail_.endSubRun(sr);
   }
   return true;
 }

template<typename T , typename IOPolicy >

bool art::MixFilter< T, IOPolicy >::filter ( Event & e )

overrideprivatevirtual

Implements art::EDFilter.

Definition at line 481 of file MixFilter.h.

 {
   // 1. Call detail object's startEvent() if it exists.
   if constexpr (detail::has_startEvent<T>::value) {
     detail_.startEvent(e);
   }
 
   // 2. Ask detail object how many events to read.
   size_t const nSecondaries = detail_.nSecondaries();
 
   // 3. Decide which events we're reading and prime the event tree
   //    cache.
   EntryNumberSequence enSeq;
   EventIDSequence eIDseq;
   enSeq.reserve(nSecondaries);
   eIDseq.reserve(nSecondaries);
   if (!helper_.generateEventSequence(nSecondaries, enSeq, eIDseq)) {
     throw Exception(errors::FileReadError)
       << "Insufficient secondary events available to mix.\n";
   }
 
   // 4. Give the event ID sequence to the detail object.
   if constexpr (detail::has_processEventIDs<T>::value) {
     detail_.processEventIDs(eIDseq);
   }
 
   // 5. Give the event auxiliary sequence to the detail object.
   if constexpr (detail::has_processEventAuxiliaries<T>::value) {
     auto const auxseq = helper_.generateEventAuxiliarySequence(enSeq);
     detail_.processEventAuxiliaries(auxseq);
   }
 
   // 6. Make the MixHelper read info into all the products, invoke the
   //    mix functions and put the products into the event.
   helper_.mixAndPut(enSeq, eIDseq, e);
 
   // 7. Call detail object's finalizeEvent() if it exists.
   if constexpr (detail::has_finalizeEvent<T>::value) {
     detail_.finalizeEvent(e);
   }
   return true;
 }

template<typename T , typename IOPolicy >

void art::MixFilter< T, IOPolicy >::respondToCloseInputFile ( FileBlock const & fb )

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 454 of file MixFilter.h.

 {
   if constexpr (detail::has_respondToCloseInputFile<T>::value) {
     detail_.respondToCloseInputFile(fb);
   }
 }

template<typename T , typename IOPolicy >

void art::MixFilter< T, IOPolicy >::respondToCloseOutputFiles ( FileBlock const & fb )

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 472 of file MixFilter.h.

 {
   if constexpr (detail::has_respondToCloseOutputFiles<T>::value) {
     detail_.respondToCloseOutputFiles(fb);
   }
 }

template<typename T , typename IOPolicy >

void art::MixFilter< T, IOPolicy >::respondToOpenInputFile ( FileBlock const & fb )

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 445 of file MixFilter.h.

 {
   if constexpr (detail::has_respondToOpenInputFile<T>::value) {
     detail_.respondToOpenInputFile(fb);
   }
 }

template<typename T , typename IOPolicy >

void art::MixFilter< T, IOPolicy >::respondToOpenOutputFiles ( FileBlock const & fb )

overrideprivatevirtual

Reimplemented from art::EDFilter.

Definition at line 463 of file MixFilter.h.

 {
   if constexpr (detail::has_respondToOpenOutputFiles<T>::value) {
     detail_.respondToOpenOutputFiles(fb);
   }
 }

Member Data Documentation

template<typename T , typename IOPolicy >

MixDetail art::MixFilter< T, IOPolicy >::detail_

private

Definition at line 407 of file MixFilter.h.

template<typename T , typename IOPolicy >

MixHelper art::MixFilter< T, IOPolicy >::helper_

private

Definition at line 406 of file MixFilter.h.

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

art/art/Framework/Modules/MixFilter.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename T, typename IOPolicy> class art::MixFilter< T, IOPolicy >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T, typename IOPolicy>
class art::MixFilter< T, IOPolicy >