Inheritance diagram for art::FileDumperOutput:

Classes
struct	Config

Public Types
using	Parameters = fhicl::WrappedTable< Config, OutputModule::Config::KeysToIgnore >

using	ModuleType = OutputModule

using	WorkerType = OutputWorker

using	PluginCollection_t = std::vector< std::unique_ptr< FileCatalogMetadataPlugin >>

Public Member Functions
	FileDumperOutput (Parameters const &)

bool	fileIsOpen () const

OutputFileStatus	fileStatus () const

virtual std::string const &	lastClosedFileName () const

SelectionsArray const &	keptProducts () const

bool	selected (BranchDescription const &) const

std::array< bool, NumBranchTypes > const &	hasNewlyDroppedBranch () const

void	selectProducts (ProductTables const &)

void	doSelectProducts (ProductTables const &)

void	registerProducts (ProductDescriptions &)

BranchChildren const &	branchChildren () const

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)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

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

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

hep::concurrency::SerialTaskQueueChain *	serialTaskQueueChain () const

std::set< std::string > const &	sharedResources () const

void	createQueues (SharedResources const &resources)

template<BranchType , typename... T>
void	serialize (T const &...resources)

template<BranchType , typename... T>
void	serializeExternal (T const &...resources)

Protected Member Functions
virtual void	doRegisterProducts (ProductDescriptions &, ModuleDescription const &)

std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

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

template<BranchType BT = InEvent, typename... T>
void	serialize (T const &...)

template<BranchType BT = InEvent, typename... T>
void	serializeExternal (T const &...)

template<BranchType BT = InEvent>
void	async ()

Private Member Functions
void	write (EventPrincipal &e) override

void	writeRun (RunPrincipal &r) override

void	writeSubRun (SubRunPrincipal &sr) override

void	readResults (ResultsPrincipal const &resp) override

template<typename P >
void	printPrincipal (P const &p)

void	printProductInfo (std::vector< std::size_t > const &columnWidths, std::string const &processName, detail::ProductInfo const &pi) const

Private Attributes
bool const	wantProductFullClassName_

bool const	wantProductFriendlyClassName_

bool const	wantProductID_

bool const	wantResolveProducts_

bool const	wantPresentOnly_

Detailed Description

Definition at line 95 of file FileDumperOutput_module.cc.

Member Typedef Documentation

using art::OutputModule::ModuleType = OutputModule

inherited

Definition at line 53 of file OutputModule.h.

using art::FileDumperOutput::Parameters = fhicl::WrappedTable<Config, OutputModule::Config::KeysToIgnore>

Definition at line 111 of file FileDumperOutput_module.cc.

using art::OutputModule::PluginCollection_t = std::vector<std::unique_ptr<FileCatalogMetadataPlugin>>

inherited

Definition at line 57 of file OutputModule.h.

using art::OutputModule::WorkerType = OutputWorker

inherited

Definition at line 54 of file OutputModule.h.

Constructor & Destructor Documentation

art::FileDumperOutput::FileDumperOutput ( Parameters const & ps )

explicit

Definition at line 135 of file FileDumperOutput_module.cc.

References wantPresentOnly_, wantProductFriendlyClassName_, wantProductFullClassName_, wantProductID_, and wantResolveProducts_.

   : OutputModule{ps().omConfig}
   , wantProductFullClassName_{ps().wantProductFullClassName()}
   , wantProductFriendlyClassName_{ps().wantProductFriendlyClassName()}
   , wantProductID_{ps().wantProductID()}
   , wantResolveProducts_{ps().resolveProducts()}
   , wantPresentOnly_{ps().onlyIfPresent()}
 {}

Member Function Documentation

template<BranchType BT = InEvent>

void art::detail::SharedModule::async ( )

inlineprotectedinherited

Definition at line 38 of file SharedModule.h.

References art::detail::SharedModule::asyncDeclared_, art::detail::SharedModule::implicit_serialize(), art::InEvent, and art::detail::SharedModule::serialize_for().

     {
       static_assert(
         BT == InEvent,
         "async is currently supported only for the 'InEvent' level.");
       asyncDeclared_ = true;
     }

BranchChildren const & art::OutputModule::branchChildren ( ) const

inherited

Definition at line 660 of file OutputModule.cc.

References art::OutputModule::branchChildren_.

   {
     return branchChildren_;
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::SharedModule::createQueues ( SharedResources const & resources )

inherited

Definition at line 34 of file SharedModule.cc.

References art::detail::SharedModule::asyncDeclared_, util::cbegin(), util::cend(), art::detail::SharedModule::chain_, art::detail::SharedResources::createQueues(), e, util::empty(), art::errors::LogicError, and art::detail::SharedModule::resourceNames_.

Referenced by art::OutputModule::doBeginJob(), art::SharedFilter::setupQueues(), art::SharedProducer::setupQueues(), art::EDFilter::setupQueues(), art::SharedAnalyzer::setupQueues(), art::EDProducer::setupQueues(), and art::EDAnalyzer::setupQueues().

   {
     Exception e{errors::LogicError,
                 "An error occurred while processing scheduling options for a "
                 "module.\n"};
     if (asyncDeclared_) {
       if (empty(resourceNames_)) {
         return;
       }
       throw e
         << "async<art::InEvent>() cannot be called in combination with any "
            "serialize<art::InEvent>(...) calls.\n";
     }
 
     if (empty(resourceNames_)) {
       throw e << "Either 'async<art::InEvent>()' or "
                  "'serialize<art::InEvent>(...)'\n"
                  "must be called in a shared module's constructor.\n";
     }
     std::vector<std::string> const names(cbegin(resourceNames_),
                                          cend(resourceNames_));
     auto queues = resources.createQueues(names);
     chain_ = std::make_unique<SerialTaskQueueChain>(queues);
   }

void art::OutputModule::doRegisterProducts	(	ProductDescriptions &	,
		ModuleDescription const &
	)

protectedvirtualinherited

Definition at line 179 of file OutputModule.cc.

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

181 {}

void art::OutputModule::doSelectProducts ( ProductTables const & tables )

inherited

Definition at line 123 of file OutputModule.cc.

References art::combinable(), art::ProductTables::descriptions(), util::end(), art::for_each_branch_type(), art::OutputModule::groupSelector_, art::OutputModule::groupSelectorRules_, art::OutputModule::hasNewlyDroppedBranch_, art::OutputModule::keptProducts(), art::OutputModule::keptProducts_, art::OutputModule::selected(), and util::values().

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

   {
     // Note: The keptProducts_ data member records all of the
     // BranchDescription objects that may be persisted to disk.  Since
     // we do not reset it, the list never shrinks.  This behavior should
     // be reconsidered for future use cases of art.
     auto selectProductForBranchType = [this, &tables](BranchType const bt) {
       auto const& productList = tables.descriptions(bt);
       groupSelector_[bt] =
         std::make_unique<GroupSelector const>(groupSelectorRules_, productList);
       // TODO: See if we can collapse keptProducts_ and groupSelector into
       // a single object. See the notes in the header for GroupSelector
       // for more information.
       for (auto const& pd : productList | ::ranges::views::values) {
         if (pd.transient() || pd.dropped()) {
           continue;
         }
         if (selected(pd)) {
           // Here, we take care to merge the BranchDescription objects
           // if one was already present in the keptProducts list.
           auto& keptProducts = keptProducts_[bt];
           if (auto it = keptProducts.find(pd.productID());
               it != end(keptProducts)) {
             auto& found_pd = it->second;
             assert(combinable(found_pd, pd));
             found_pd.merge(pd);
           } else {
             // New product
             keptProducts.emplace(pd.productID(), pd);
           }
           continue;
         }
         hasNewlyDroppedBranch_[bt] = true;
       }
     };
     for_each_branch_type(selectProductForBranchType);
   }

bool art::OutputModule::fileIsOpen ( ) const

inherited

Definition at line 95 of file OutputModule.cc.

References art::OutputModule::isFileOpen().

   {
     return isFileOpen();
   }

OutputFileStatus art::OutputModule::fileStatus ( ) const

inherited

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

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const & e ) const

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

std::array< bool, NumBranchTypes > const & art::OutputModule::hasNewlyDroppedBranch ( ) const

inherited

Definition at line 654 of file OutputModule.cc.

References art::OutputModule::hasNewlyDroppedBranch_.

   {
     return hasNewlyDroppedBranch_;
   }

SelectionsArray const & art::OutputModule::keptProducts ( ) const

inherited

Definition at line 640 of file OutputModule.cc.

References art::OutputModule::keptProducts_.

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

   {
     return keptProducts_;
   }

string const & art::OutputModule::lastClosedFileName ( ) const

virtualinherited

Definition at line 117 of file OutputModule.cc.

References art::OutputModule::configuredFileName_.

   {
     return configuredFileName_;
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

template<typename P >

void art::FileDumperOutput::printPrincipal ( P const & p )

private

Definition at line 170 of file FileDumperOutput_module.cc.

References art::BranchTypeToString(), art::detail::columnWidth(), art::detail::ProductInfo::friendly_type, art::detail::ProductInfo::instance_name, art::EDProduct::isPresent(), art::detail::ProductInfo::module_label, util::pi(), art::productstatus::present(), printProductInfo(), art::Observer::processName(), art::detail::ProductInfo::product_id, art::detail::ProductInfo::product_type, art::detail::ProductInfo::str_size, util::to_string(), util::values(), wantPresentOnly_, and wantResolveProducts_.

Referenced by readResults(), write(), writeRun(), and writeSubRun().

 {
   if (!p.size())
     return;
 
   size_t present{0};
   size_t not_present{0};
   std::map<std::string, std::vector<detail::ProductInfo>> products;
 
   auto const& dinfo = dummyInfo();
 
   products[dummyProcess()].emplace_back(dinfo);
 
   for (auto const& g : p | views::values | views::indirect) {
     auto const& pd = g.productDescription();
     auto const& oh = p.getForOutput(pd.productID(), wantResolveProducts_);
 
     EDProduct const* product = oh.isValid() ? oh.wrapper() : nullptr;
     bool const productPresent = product != nullptr && product->isPresent();
 
     if (productPresent) {
       ++present;
     } else {
       ++not_present;
     }
 
     if (!wantPresentOnly_ || productPresent) {
       auto pi = detail::ProductInfo{pd.moduleLabel(),
                                     pd.productInstanceName(),
                                     pd.producedClassName(),
                                     pd.friendlyClassName(),
                                     std::to_string(pd.productID().value()),
                                     product_size(product, productPresent)};
       products[pd.processName()].emplace_back(std::move(pi));
     }
   }
 
   std::cout << "PRINCIPAL TYPE: " << BranchTypeToString(p.branchType())
             << std::endl;
 
   std::vector<std::size_t> const widths{
     columnWidthFirst(products, dummyProcess()),
     columnWidth(
       products, &detail::ProductInfo::module_label, dinfo.module_label),
     columnWidth(
       products, &detail::ProductInfo::instance_name, dinfo.instance_name),
     columnWidth(
       products, &detail::ProductInfo::product_type, dinfo.product_type),
     columnWidth(
       products, &detail::ProductInfo::friendly_type, dinfo.friendly_type),
     columnWidth(products, &detail::ProductInfo::product_id, dinfo.product_id),
     columnWidth(products, &detail::ProductInfo::str_size, dinfo.str_size)};
 
   // Print banner
   printProductInfo(widths, dummyProcess(), dummyInfo());
   for (auto const& processConfig : p.processHistory()) {
     auto const& processName = processConfig.processName();
     for (auto const& pi : products[processName]) {
       printProductInfo(widths, processName, pi);
     }
   }
 
   std::cout << "\nTotal products (present, not present): "
             << present + not_present << " (" << present << ", " << not_present
             << ").\n\n";
 }

void art::FileDumperOutput::printProductInfo	(	std::vector< std::size_t > const &	columnWidths,
		std::string const &	processName,
		detail::ProductInfo const &	pi
	)		const

private

Definition at line 238 of file FileDumperOutput_module.cc.

References DEFINE_ART_MODULE, art::detail::ProductInfo::friendly_type, art::detail::ProductInfo::instance_name, art::detail::ProductInfo::module_label, art::detail::ProductInfo::product_id, art::detail::ProductInfo::product_type, art::detail::ProductInfo::str_size, wantProductFriendlyClassName_, wantProductFullClassName_, and wantProductID_.

Referenced by printPrincipal().

 {
   std::ostringstream oss;
   oss << cet::rpad(processName, widths[0], '.') << " | "
       << cet::rpad(pi.module_label, widths[1], '.') << " | "
       << cet::rpad(pi.instance_name, widths[2], '.') << " | ";
   if (wantProductFullClassName_) {
     oss << cet::rpad(pi.product_type, widths[3], '.') << " | ";
   }
   if (wantProductFriendlyClassName_) {
     oss << cet::rpad(pi.friendly_type, widths[4], '.') << " | ";
   }
   if (wantProductID_) {
     oss << cet::rpad(pi.product_id, widths[5], '.') << " | ";
   }
   oss << cet::lpad(pi.str_size, widths[6], '.');
   std::cout << oss.str() << '\n';
 }

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by printPrincipal().

   {
     return process_name_;
   }

void art::FileDumperOutput::readResults ( ResultsPrincipal const & resp )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 163 of file FileDumperOutput_module.cc.

References printPrincipal().

 {
   printPrincipal(resp);
 }

void art::OutputModule::registerProducts ( ProductDescriptions & producedProducts )

inherited

Definition at line 173 of file OutputModule.cc.

References art::OutputModule::doRegisterProducts(), and art::ModuleBase::moduleDescription().

   {
     doRegisterProducts(producedProducts, moduleDescription());
   }

bool art::OutputModule::selected ( BranchDescription const & pd ) const

inherited

Definition at line 646 of file OutputModule.cc.

References art::BranchDescription::branchType(), and art::OutputModule::groupSelector_.

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

   {
     auto const bt = pd.branchType();
     assert(groupSelector_[bt]);
     return groupSelector_[bt]->selected(pd);
   }

void art::OutputModule::selectProducts ( ProductTables const & tables )

inherited

Definition at line 162 of file OutputModule.cc.

References art::OutputModule::doSelectProducts(), and art::OutputModule::postSelectProducts().

   {
     doSelectProducts(tables);
     postSelectProducts();
   }

template<BranchType BT = InEvent, typename... T>

void art::detail::SharedModule::serialize ( T const & ... )

protectedinherited

Referenced by simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime(), simfilter::FilterSimPhotonTime::FilterSimPhotonTime(), art::detail::LegacyModule::LegacyModule(), and art::OutputModule::OutputModule().

template<BranchType , typename... T>

void art::detail::SharedModule::serialize ( T const &... resources )

inherited

Definition at line 83 of file SharedModule.h.

References art::detail::SharedModule::serialize_for_resource().

   {
     serialize_for_resource(resources...);
   }

template<BranchType BT = InEvent, typename... T>

void art::detail::SharedModule::serializeExternal ( T const & ... )

protectedinherited

Referenced by wcls::WireCellToolkit::WireCellToolkit().

template<BranchType , typename... T>

void art::detail::SharedModule::serializeExternal ( T const &... resources )

inherited

Definition at line 90 of file SharedModule.h.

References art::detail::SharedModule::serialize_for_external_resource().

   {
     serialize_for_external_resource(resources...);
   }

SerialTaskQueueChain * art::detail::SharedModule::serialTaskQueueChain ( ) const

inherited

Definition at line 22 of file SharedModule.cc.

References art::detail::SharedModule::chain_.

   {
     return chain_.get();
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

std::set< std::string > const & art::detail::SharedModule::sharedResources ( ) const

inherited

Definition at line 28 of file SharedModule.cc.

References art::detail::SharedModule::resourceNames_.

   {
     return resourceNames_;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }