#include "EventPrincipal.h"

Inheritance diagram for art::EventPrincipal:

Public Types
using	Auxiliary = EventAuxiliary

using	GroupCollection = std::map< ProductID, std::unique_ptr< Group >>

using	const_iterator = GroupCollection::const_iterator

using	ProcessNameConstIterator = ProcessHistory::const_iterator

using	GroupQueryResultVec = std::vector< GroupQueryResult >

using	size_type = GroupCollection::size_type

using	ProcessName = std::string

Public Member Functions
	EventPrincipal (EventAuxiliary const &aux, ProcessConfiguration const &pc, cet::exempt_ptr< ProductTable const > presentProducts, std::shared_ptr< History > history=std::make_shared< History >(), std::unique_ptr< BranchMapper > &&mapper=std::make_unique< BranchMapper >(), std::unique_ptr< DelayedReader > &&rtrv=std::make_unique< NoDelayedReader >(), bool lastInSubRun=false)

SubRunPrincipal const &	subRunPrincipal () const

cet::exempt_ptr< SubRunPrincipal const >	subRunPrincipalExemptPtr () const

void	setSubRunPrincipal (cet::exempt_ptr< SubRunPrincipal const > srp)

EventID const &	id () const

Timestamp const &	time () const

bool	isReal () const

EventAuxiliary::ExperimentType	ExperimentType () const

EventAuxiliary const &	aux () const

SubRunNumber_t	subRun () const

RunNumber_t	run () const

EventNumber_t	event () const

EventSelectionIDVector const &	eventSelectionIDs () const

History const &	history () const

void	put (std::unique_ptr< EDProduct > &&edp, BranchDescription const &pd, std::unique_ptr< ProductProvenance const > &&productProvenance)

void	fillGroup (BranchDescription const &) override

BranchType	branchType () const override

bool	isLastInSubRun () const

RangeSet	seenRanges () const override

EDProductGetter const *	productGetter (ProductID const pid) const

OutputHandle	getForOutput (ProductID const, bool resolveProd) const

GroupQueryResult	getBySelector (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 &) const

GroupQueryResultVec	getMatchingSequence (SelectorBase const &) const

void	removeCachedProduct (ProductID const pid) const

void	addSecondaryPrincipal (std::unique_ptr< Principal > &&val)

void	setProducedProducts (ProductTable const &producedProducts)

void	readImmediate () const

void	readProvenanceImmediate () const

ProcessHistory const &	processHistory () const

ProcessConfiguration const &	processConfiguration () const

BranchMapper const &	branchMapper () const

size_t	size () const

const_iterator	begin () const

const_iterator	cbegin () const

const_iterator	end () const

const_iterator	cend () const

void	addToProcessHistory ()

EDProductGetter const *	getEDProductGetter (ProductID const pid) const

Static Public Attributes
static constexpr BranchType	branch_type = Auxiliary::branch_type

Protected Member Functions
BranchMapper &	branchMapper ()

void	fillGroup (std::unique_ptr< Group > &&group)

DelayedReader &	productReader ()

int	tryNextSecondaryFile () const

cet::exempt_ptr< Group const >	getGroupForPtr (ProductID const pid) const

cet::exempt_ptr< Group const >	getGroup (ProductID const pid) const

cet::exempt_ptr< Group const >	getResolvedGroup (ProductID const pid, bool resolveProd) const

Private Member Functions
void	throwIfExistingGroup (BranchDescription const &pd) const

ProcessHistoryID const &	processHistoryID () const override

void	setProcessHistoryID (ProcessHistoryID const &phid) override

Private Attributes
EventAuxiliary	aux_

cet::exempt_ptr< SubRunPrincipal const >	subRunPrincipal_ {nullptr}

std::shared_ptr< History >	history_

bool	lastInSubRun_ {false}

Detailed Description

Definition at line 30 of file EventPrincipal.h.

Member Typedef Documentation

using art::EventPrincipal::Auxiliary = EventAuxiliary

Definition at line 32 of file EventPrincipal.h.

using art::Principal::const_iterator = GroupCollection::const_iterator

inherited

Definition at line 52 of file Principal.h.

using art::Principal::GroupCollection = std::map<ProductID, std::unique_ptr<Group>>

inherited

Definition at line 51 of file Principal.h.

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

inherited

Definition at line 54 of file Principal.h.

using art::Principal::ProcessName = std::string

inherited

Definition at line 56 of file Principal.h.

using art::Principal::ProcessNameConstIterator = ProcessHistory::const_iterator

inherited

Definition at line 53 of file Principal.h.

using art::Principal::size_type = GroupCollection::size_type

inherited

Definition at line 55 of file Principal.h.

Constructor & Destructor Documentation

art::EventPrincipal::EventPrincipal	(	EventAuxiliary const &	aux,
		ProcessConfiguration const &	pc,
		cet::exempt_ptr< ProductTable const >	presentProducts,
		std::shared_ptr< History >	history = `std::make_shared<History>()`,
		std::unique_ptr< BranchMapper > &&	mapper = `std::make_unique<BranchMapper>()`,
		std::unique_ptr< DelayedReader > &&	rtrv = `std::make_unique<NoDelayedReader>()`,
		bool	lastInSubRun = `false`
	)

Definition at line 20 of file EventPrincipal.cc.

References art::Principal::addToProcessHistory(), aux(), aux_, history(), history_, art::InEvent, art::ProductMetaData::instance(), lastInSubRun_, art::Principal::productReader(), and art::DelayedReader::setGroupFinder().

     : Principal{pc,
                 history->processHistoryID(),
                 presentProducts,
                 std::move(mapper),
                 std::move(rtrv)}
     , aux_{aux}
     , history_{history}
     , lastInSubRun_{lastInSubRun}
   {
     productReader().setGroupFinder(
       cet::exempt_ptr<EDProductGetterFinder const>{this});
     if (ProductMetaData::instance().productProduced(InEvent)) {
       addToProcessHistory();
     }
   }

Member Function Documentation

void art::Principal::addSecondaryPrincipal ( std::unique_ptr< Principal > && val )

inlineinherited

Definition at line 100 of file Principal.h.

References art::Principal::secondaryPrincipals_.

     {
       secondaryPrincipals_.emplace_back(std::move(val));
     }

void Principal::addToProcessHistory ( )

inherited

Definition at line 80 of file Principal.cc.

References art::errors::Configuration, art::thread_safe_registry_via_id< K, M >::emplace(), art::Principal::processConfiguration_, art::Principal::processHistory_, art::Principal::processHistoryModified_, art::ProcessConfiguration::processName(), and art::Principal::setProcessHistoryID().

Referenced by art::Principal::cend(), EventPrincipal(), art::RunPrincipal::RunPrincipal(), art::SubRunPrincipal::SubRunPrincipal(), art::RootOutput::write(), art::RootOutput::writeRun(), and art::RootOutput::writeSubRun().

 {
   if (processHistoryModified_) {
     return;
   }
   string const& processName = processConfiguration_.processName();
   for (auto const& val : processHistory_) {
     if (processName == val.processName()) {
       throw art::Exception(errors::Configuration)
         << "The process name " << processName
         << " was previously used on these products.\n"
         << "Please modify the configuration file to use a "
         << "distinct process name.\n";
     }
   }
   processHistory_.push_back(processConfiguration_);
   // OPTIMIZATION NOTE: As of 0_9_0_pre3 For very simple Sources
   // (e.g. EmptyEvent) this routine takes up nearly 50% of the time
   // per event, and 96% of the time for this routine is spent in
   // computing the ProcessHistory id which happens because we are
   // reconstructing the ProcessHistory for each event.  It would
   // probably be better to move the ProcessHistory construction out to
   // somewhere which persists for longer than one Event.
   auto const phid = processHistory_.id();
   ProcessHistoryRegistry::emplace(phid, processHistory_);
   setProcessHistoryID(phid);
   processHistoryModified_ = true;
 }

EventAuxiliary const& art::EventPrincipal::aux ( ) const

inline

Definition at line 81 of file EventPrincipal.h.

References aux_.

Referenced by EventPrincipal(), ExperimentType(), id(), isReal(), time(), and art::RootOutputFile::writeOne().

     {
       return aux_;
     }

const_iterator art::Principal::begin ( ) const

inlineinherited

Definition at line 156 of file Principal.h.

References art::Principal::groups_.

     {
       return groups_.begin();
     }

BranchMapper const& art::Principal::branchMapper ( ) const

inlineinherited

Definition at line 144 of file Principal.h.

References art::Principal::branchMapperPtr_.

Referenced by art::Principal::fillGroup(), art::detail::KeptProvenance::insertAncestors(), art::ResultsPrincipal::put(), art::RunPrincipal::put(), art::SubRunPrincipal::put(), and put().

     {
       return *branchMapperPtr_;
     }

BranchMapper& art::Principal::branchMapper ( )

inlineprotectedinherited

Definition at line 192 of file Principal.h.

References art::Principal::branchMapperPtr_.

     {
       return *branchMapperPtr_;
     }

BranchType art::EventPrincipal::branchType ( ) const

inlineoverridevirtual

Implements art::Principal.

Definition at line 118 of file EventPrincipal.h.

References branch_type.

     {
       return branch_type;
     }

const_iterator art::Principal::cbegin ( ) const

inlineinherited

Definition at line 162 of file Principal.h.

References art::Principal::groups_.

     {
       return groups_.cbegin();
     }

const_iterator art::Principal::cend ( ) const

inlineinherited

Definition at line 174 of file Principal.h.

References art::Principal::addToProcessHistory(), art::Principal::branchType(), art::Principal::fillGroup(), art::Principal::groups_, and art::Principal::seenRanges().

     {
       return groups_.cend();
     }

const_iterator art::Principal::end ( void ) const

inlineinherited

Definition at line 168 of file Principal.h.

References art::Principal::groups_.

     {
       return groups_.end();
     }

EventNumber_t art::EventPrincipal::event ( ) const

inline

Definition at line 96 of file EventPrincipal.h.

References art::EventID::event(), eventSelectionIDs(), and id().

     {
       return id().event();
     }

EventSelectionIDVector const & art::EventPrincipal::eventSelectionIDs ( ) const

Definition at line 89 of file EventPrincipal.cc.

References history_.

Referenced by event().

   {
     return history_->eventSelectionIDs();
   }

EventAuxiliary::ExperimentType art::EventPrincipal::ExperimentType ( ) const

inline

Definition at line 75 of file EventPrincipal.h.

References aux(), and art::EventAuxiliary::experimentType().

     {
       return aux().experimentType();
     }

void art::EventPrincipal::fillGroup ( BranchDescription const & pd )

overridevirtual

Implements art::Principal.

Definition at line 68 of file EventPrincipal.cc.

References art::Principal::fillGroup(), art::RangeSet::invalid(), art::gfactory::make_group(), art::BranchDescription::productID(), and throwIfExistingGroup().

Referenced by history().

   {
     throwIfExistingGroup(pd);
     Principal::fillGroup(
       gfactory::make_group(pd, pd.productID(), RangeSet::invalid()));
   }

void art::Principal::fillGroup ( std::unique_ptr< Group > && group )

inlineprotectedinherited

Definition at line 205 of file Principal.h.

References art::Principal::branchMapper(), art::Principal::deferredGetter_(), art::Principal::findGroups(), art::Principal::findGroupsForProcess(), art::Principal::findGroupsForProduct(), art::Principal::findGroupsFromInputFile(), art::BranchDescription::friendlyClassName(), art::Principal::getGroup(), art::Principal::getGroupForPtr(), art::Principal::getResolvedGroup(), art::Principal::groups_, art::Principal::matchingSequenceFromInputFile(), art::BranchDescription::moduleLabel(), art::Principal::presentFromSource(), art::Principal::processHistoryID(), art::BranchDescription::processName(), art::BranchDescription::producedClassName(), art::BranchDescription::productID(), art::Principal::setProcessHistoryID(), art::Principal::store_, and art::Principal::tryNextSecondaryFile().

     {
       BranchDescription const& pd = group->productDescription();
       assert(!pd.producedClassName().empty());
       assert(!pd.friendlyClassName().empty());
       assert(!pd.moduleLabel().empty());
       assert(!pd.processName().empty());
       group->setResolvers(branchMapper(), *store_);
       groups_[pd.productID()] = std::move(group);
     }

GroupQueryResult Principal::getByLabel	(	WrappedTypeID const &	wrapped,
		std::string const &	label,
		std::string const &	productInstanceName,
		std::string const &	processName
	)		const

inherited

Definition at line 143 of file Principal.cc.

References art::Principal::findGroupsForProduct(), art::WrappedTypeID::product_type, and art::errors::ProductNotFound.

Referenced by art::DataViewImpl::getByLabel_().

 {
   Selector const sel{ModuleLabelSelector{label} &&
                      ProductInstanceNameSelector{productInstanceName} &&
                      ProcessNameSelector{processName}};
   auto const& results = findGroupsForProduct(wrapped, sel, true);
   if (results.empty()) {
     auto whyFailed =
       std::make_shared<art::Exception>(art::errors::ProductNotFound);
     *whyFailed << "getByLabel: Found zero products matching all criteria\n"
                << "Looking for type: " << wrapped.product_type << "\n"
                << "Looking for module label: " << label << "\n"
                << "Looking for productInstanceName: " << productInstanceName
                << "\n"
                << (processName.empty() ? "" : "Looking for process: ")
                << processName;
     return GroupQueryResult{whyFailed};
   }
   if (results.size() > 1) {
     throw art::Exception(art::errors::ProductNotFound)
       << "getByLabel: Found " << results.size()
       << " products rather than one which match all criteria\n"
       << "Looking for type: " << wrapped.product_type << "\n"
       << "Looking for module label: " << label << "\n"
       << "Looking for productInstanceName: " << productInstanceName << "\n"
       << (processName.empty() ? "" : "Looking for process: ") << processName
       << "\n";
   }
   return results[0];
 }

GroupQueryResult Principal::getByProductID ( ProductID const pid ) const

inherited

Definition at line 131 of file Principal.cc.

References art::Principal::getGroupForPtr(), and art::errors::ProductNotFound.

Referenced by art::DataViewImpl::getByProductID_(), art::Principal::getEDProductGetterImpl(), and art::Principal::productGetter().

 {
   if (auto const g = getGroupForPtr(pid)) {
     return GroupQueryResult{g};
   }
   auto whyFailed =
     std::make_shared<art::Exception>(art::errors::ProductNotFound, "InvalidID");
   *whyFailed << "getGroup: no product with given product id: " << pid << "\n";
   return GroupQueryResult{whyFailed};
 }

GroupQueryResult Principal::getBySelector	(	WrappedTypeID const &	wrapped,
		SelectorBase const &	sel
	)		const

inherited

Definition at line 110 of file Principal.cc.

References art::Principal::findGroupsForProduct(), art::WrappedTypeID::product_type, and art::errors::ProductNotFound.

Referenced by art::DataViewImpl::get_().

 {
   auto const& results = findGroupsForProduct(wrapped, sel, true);
   if (results.empty()) {
     auto whyFailed =
       std::make_shared<art::Exception>(art::errors::ProductNotFound);
     *whyFailed << "getBySelector: Found zero products matching all criteria\n"
                << "Looking for type: " << wrapped.product_type << "\n";
     return GroupQueryResult{whyFailed};
   }
   if (results.size() > 1) {
     throw art::Exception(art::errors::ProductNotFound)
       << "getBySelector: Found " << results.size()
       << " products rather than one which match all criteria\n"
       << "Looking for type: " << wrapped.product_type << "\n";
   }
   return results[0];
 }

EDProductGetter const* art::EDProductGetterFinder::getEDProductGetter ( ProductID const pid ) const

inlineinherited

Definition at line 25 of file EDProductGetterFinder.h.

References art::EDProductGetterFinder::getEDProductGetterImpl().

     {
       return getEDProductGetterImpl(pid);
     }

OutputHandle Principal::getForOutput	(	ProductID const	pid,
		bool	resolveProd
	)		const

inherited

Definition at line 424 of file Principal.cc.

References art::Principal::getResolvedGroup(), art::OutputHandle::invalid(), and art::OutputHandle::rangeOfValidity().

Referenced by art::RootOutputFile::fillBranches(), art::detail::KeptProvenance::insertAncestors(), and art::ProvenanceCheckerOutput::write().

 {
   auto const& g = getResolvedGroup(pid, resolveProd);
   if (g.get() == nullptr) {
     return OutputHandle::invalid();
   }
 
   if (resolveProd) {
     // If a request to resolve the product is made, then it should
     // exist and be marked as present.  Return invalid handles if this
     // is not the case.
     if (g->anyProduct() == nullptr) {
       return OutputHandle::invalid();
     }
     if (!g->anyProduct()->isPresent()) {
       return OutputHandle::invalid();
     }
   }
   if (!g->anyProduct() && !g->productProvenancePtr()) {
     return OutputHandle{g->rangeOfValidity()};
   }
   return OutputHandle{g->anyProduct(),
                       &g->productDescription(),
                       g->productProvenancePtr(),
                       g->rangeOfValidity()};
 }

cet::exempt_ptr< Group const > Principal::getGroup ( ProductID const pid ) const

protectedinherited

Definition at line 525 of file Principal.cc.

References art::Principal::groups_.

Referenced by art::Principal::fillGroup(), art::Principal::findGroupsForProcess(), art::Principal::getGroupForPtr(), history(), art::Principal::removeCachedProduct(), and throwIfExistingGroup().

 {
   auto it = groups_.find(pid);
   return it != groups_.cend() ? it->second.get() : nullptr;
 }

cet::exempt_ptr< Group const > Principal::getGroupForPtr ( ProductID const pid ) const

protectedinherited

Definition at line 481 of file Principal.cc.

References art::Principal::getGroup(), art::Principal::presentFromSource(), art::Principal::producedProducts_, art::Principal::secondaryPrincipals_, and art::Principal::tryNextSecondaryFile().

Referenced by art::Principal::fillGroup(), art::Principal::getByProductID(), and art::Principal::getResolvedGroup().

 {
   bool produced{false};
   if (producedProducts_) {
     auto const& availableProducts = producedProducts_->availableProducts;
     if (availableProducts.find(pid) != availableProducts.cend()) {
       produced = true;
     }
   }
 
   // Look through current process and currently opened primary input file.
   if (produced || presentFromSource(pid)) {
     return getGroup(pid);
   }
 
   // Look through secondary files
   for (auto const& sp : secondaryPrincipals_) {
     if (sp->presentFromSource(pid)) {
       return sp->getGroup(pid);
     }
   }
 
   // Try new secondary files
   while (true) {
     int const err = tryNextSecondaryFile();
     if (err == -2) {
       // No more files.
       return nullptr;
     }
     if (err == -1) {
       // Run, SubRun, or Event not found.
       continue;
     }
     assert(!secondaryPrincipals_.empty());
     auto& new_sp = secondaryPrincipals_.back();
     if (new_sp->presentFromSource(pid)) {
       return new_sp->getGroup(pid);
     }
   }
 
   return nullptr;
 }

Principal::GroupQueryResultVec Principal::getMany	(	WrappedTypeID const &	wrapped,
		SelectorBase const &	sel
	)		const

inherited

Definition at line 178 of file Principal.cc.

References art::Principal::findGroupsForProduct().

Referenced by art::DataViewImpl::getMany_().

 {
   return findGroupsForProduct(wrapped, sel, false);
 }

Principal::GroupQueryResultVec Principal::getMatchingSequence ( SelectorBase const & selector ) const

inherited

Definition at line 195 of file Principal.cc.

References art::Principal::findGroups(), art::Principal::matchingSequenceFromInputFile(), art::Principal::producedProducts_, art::Principal::secondaryPrincipals_, and art::Principal::tryNextSecondaryFile().

Referenced by art::DataViewImpl::getMatchingSequenceByLabel_().

 {
   GroupQueryResultVec results;
 
   // Find groups from current process
   if (producedProducts_) {
     if (findGroups(producedProducts_->viewLookup, selector, results, true) !=
         0) {
       return results;
     }
   }
 
   // Look through currently opened input files
   if (results.empty()) {
     results = matchingSequenceFromInputFile(selector);
     if (!results.empty()) {
       return results;
     }
 
     for (auto const& sp : secondaryPrincipals_) {
       results = sp->matchingSequenceFromInputFile(selector);
       if (!results.empty()) {
         return results;
       }
     }
   }
 
   // Open more secondary files if necessary
   if (results.empty()) {
     while (true) {
       int const err = tryNextSecondaryFile();
       if (err == -2) {
         // No more files.
         break;
       }
       if (err == -1) {
         // Run, SubRun, or Event not found.
         continue;
       }
       assert(!secondaryPrincipals_.empty());
       auto& new_sp = secondaryPrincipals_.back();
       results = new_sp->matchingSequenceFromInputFile(selector);
       if (!results.empty()) {
         return results;
       }
     }
   }
 
   return results;
 }

cet::exempt_ptr< Group const > Principal::getResolvedGroup	(	ProductID const	pid,
		bool	resolveProd
	)		const

protectedinherited

Definition at line 452 of file Principal.cc.

References art::Principal::getGroupForPtr().

Referenced by art::Principal::fillGroup(), and art::Principal::getForOutput().

 {
   // FIXME: This reproduces the behavior of the original getGroup with
   // resolveProv == false but I am not sure this is correct in the
   // case of an unavailable product.
   auto const g = getGroupForPtr(pid);
   if (!g.get() || !resolveProd) {
     return g;
   }
   bool const gotIt = g->resolveProductIfAvailable(g->producedWrapperType());
   if (!gotIt) {
     // Behavior is the same as if the group wasn't there.
     return nullptr;
   }
   return g;
 }

History const& art::EventPrincipal::history ( ) const

inline

Definition at line 104 of file EventPrincipal.h.

References fillGroup(), art::Principal::getGroup(), history_, and put().

Referenced by EventPrincipal(), art::Event::history(), art::Event::processHistoryID(), processHistoryID(), and setProcessHistoryID().

     {
       return *history_;
     }

EventID const& art::EventPrincipal::id ( ) const

inline

Definition at line 59 of file EventPrincipal.h.

References aux(), and art::EventAuxiliary::id().

Referenced by art::OutputModule::doWriteEvent(), event(), art::RootInput::readEvent_(), run(), subRun(), art::Source< T >::throwIfInsane_(), art::RootOutput::write(), and art::EndPathExecutor::writeEvent().

     {
       return aux().id();
     }

bool art::EventPrincipal::isLastInSubRun ( ) const

inline

Definition at line 124 of file EventPrincipal.h.

References lastInSubRun_.

Referenced by art::EndPathExecutor::writeEvent().

     {
       return lastInSubRun_;
     }

bool art::EventPrincipal::isReal ( ) const

inline

Definition at line 69 of file EventPrincipal.h.

References aux(), and art::EventAuxiliary::isRealData().

     {
       return aux().isRealData();
     }

ProcessConfiguration const& art::Principal::processConfiguration ( ) const

inlineinherited

Definition at line 138 of file Principal.h.

References art::Principal::processConfiguration_.

Referenced by art::get_ProductDescription().

     {
       return processConfiguration_;
     }

ProcessHistory const& art::Principal::processHistory ( ) const

inlineinherited

Definition at line 132 of file Principal.h.

References art::Principal::processHistory_.

Referenced by art::Principal::findGroups(), and art::DataViewImpl::processHistory().

     {
       return processHistory_;
     }

ProcessHistoryID const& art::EventPrincipal::processHistoryID ( ) const

inlineoverrideprivatevirtual

Implements art::Principal.

Definition at line 138 of file EventPrincipal.h.

References history(), and art::History::processHistoryID().

     {
       return history().processHistoryID();
     }

EDProductGetter const * Principal::productGetter ( ProductID const pid ) const

inherited

Definition at line 532 of file Principal.cc.

References art::Principal::deferredGetter_(), art::Principal::getByProductID(), and art::GroupQueryResult::result().

Referenced by art::SourceHelper::makePtr(), art::Results::productGetter(), art::Run::productGetter(), art::SubRun::productGetter(), and art::Event::productGetter().

 {
   EDProductGetter const* result{getByProductID(pid).result().get()};
   return result ? result : deferredGetter_(pid);
 }

DelayedReader& art::Principal::productReader ( )

inlineprotectedinherited

Definition at line 198 of file Principal.h.

References art::Principal::store_.

Referenced by EventPrincipal(), art::ResultsPrincipal::ResultsPrincipal(), art::RunPrincipal::RunPrincipal(), and art::SubRunPrincipal::SubRunPrincipal().

     {
       return *store_;
     }

void art::EventPrincipal::put	(	std::unique_ptr< EDProduct > &&	edp,
		BranchDescription const &	pd,
		std::unique_ptr< ProductProvenance const > &&	productProvenance
	)

Definition at line 76 of file EventPrincipal.cc.

References art::Principal::branchMapper(), art::Principal::fillGroup(), art::BranchMapper::insert(), art::RangeSet::invalid(), art::gfactory::make_group(), art::BranchDescription::productID(), and throwIfExistingGroup().

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

   {
     assert(edp);
     branchMapper().insert(std::move(productProvenance));
     throwIfExistingGroup(pd);
     Principal::fillGroup(gfactory::make_group(
       pd, pd.productID(), RangeSet::invalid(), std::move(edp)));
   }

void art::Principal::readImmediate ( ) const

inlineinherited

Definition at line 112 of file Principal.h.

References art::Principal::groups_, and art::Principal::readProvenanceImmediate().

     {
       readProvenanceImmediate();
       for (auto const& val : groups_) {
         if (!val.second->productUnavailable()) {
           val.second->resolveProduct(val.second->producedWrapperType());
         }
       }
     }

void art::Principal::readProvenanceImmediate ( ) const

inlineinherited

Definition at line 123 of file Principal.h.

References art::Principal::branchMapperPtr_, and art::Principal::groups_.

Referenced by art::Principal::readImmediate().

     {
       for (auto const& val : groups_) {
         (void)val.second->productProvenancePtr();
       }
       branchMapperPtr_->setDelayedRead(false);
     }

void Principal::removeCachedProduct ( ProductID const pid ) const

inherited

Definition at line 259 of file Principal.cc.

References art::Principal::getGroup(), art::errors::ProductNotFound, and art::Principal::secondaryPrincipals_.

Referenced by art::DataViewImpl::removeCachedProduct_().

 {
   if (auto g = getGroup(pid)) {
     g->removeCachedProduct();
     return;
   }
   for (auto const& sp : secondaryPrincipals_) {
     if (auto g = sp->getGroup(pid)) {
       g->removeCachedProduct();
       return;
     }
   }
   throw Exception(errors::ProductNotFound, "removeCachedProduct")
     << "Attempt to remove unknown product corresponding to ProductID: " << pid
     << '\n'
     << "Please contact artists@fnal.gov\n";
 }

RunNumber_t art::EventPrincipal::run ( ) const

inline

Definition at line 91 of file EventPrincipal.h.

References id(), and art::EventID::run().

     {
       return id().run();
     }

RangeSet art::EventPrincipal::seenRanges ( ) const

inlineoverridevirtual

Implements art::Principal.

Definition at line 129 of file EventPrincipal.h.

References art::RangeSet::invalid(), and throwIfExistingGroup().

     {
       return RangeSet::invalid();
     }

void art::EventPrincipal::setProcessHistoryID ( ProcessHistoryID const & phid )

inlineoverrideprivatevirtual

Implements art::Principal.

Definition at line 144 of file EventPrincipal.h.

References history(), and art::History::setProcessHistoryID().

     {
       return history().setProcessHistoryID(phid);
     }

void art::Principal::setProducedProducts ( ProductTable const & producedProducts )

inlineinherited

Definition at line 106 of file Principal.h.

References art::Principal::producedProducts_.

     {
       producedProducts_ = cet::make_exempt_ptr(&producedProducts);
     }

void art::EventPrincipal::setSubRunPrincipal ( cet::exempt_ptr< SubRunPrincipal const > srp )

inline

Definition at line 53 of file EventPrincipal.h.

References subRunPrincipal_.

     {
       subRunPrincipal_ = srp;
     }

size_t art::Principal::size ( void ) const

inlineinherited

Definition at line 150 of file Principal.h.

References art::Principal::groups_.

Referenced by art::DataViewImpl::size().

     {
       return groups_.size();
     }

SubRunNumber_t art::EventPrincipal::subRun ( ) const

inline

Definition at line 86 of file EventPrincipal.h.

References id(), and art::EventID::subRun().

     {
       return id().subRun();
     }

SubRunPrincipal const & art::EventPrincipal::subRunPrincipal ( ) const

Definition at line 45 of file EventPrincipal.cc.

References art::errors::NullPointerError, and subRunPrincipal_.

   {
     if (!subRunPrincipal_) {
       throw Exception(errors::NullPointerError)
         << "Tried to obtain a NULL subRunPrincipal.\n";
     }
     return *subRunPrincipal_;
   }

cet::exempt_ptr<SubRunPrincipal const> art::EventPrincipal::subRunPrincipalExemptPtr ( ) const

inline

Definition at line 48 of file EventPrincipal.h.

References subRunPrincipal_.

Referenced by art::Source< T >::throwIfInsane_().

     {
       return subRunPrincipal_;
     }

void art::EventPrincipal::throwIfExistingGroup ( BranchDescription const & pd ) const

private

Definition at line 55 of file EventPrincipal.cc.

References art::BranchDescription::branchType(), art::BranchDescription::friendlyClassName(), art::Principal::getGroup(), art::BranchDescription::moduleLabel(), art::BranchDescription::processName(), art::BranchDescription::productID(), art::BranchDescription::productInstanceName(), and art::errors::ProductRegistrationFailure.

Referenced by fillGroup(), put(), and seenRanges().

   {
     if (getGroup(pd.productID()) != nullptr) {
       throw art::Exception(art::errors::ProductRegistrationFailure,
                            "EventPrincipal::throwIfExistingGroup")
         << "Problem found while adding product provenance: "
         << "product already exists for (" << pd.friendlyClassName() << ","
         << pd.moduleLabel() << "," << pd.productInstanceName() << ","
         << pd.processName() << "," << pd.branchType() << ")\n";
     }
   }

Timestamp const& art::EventPrincipal::time ( ) const

inline

Definition at line 64 of file EventPrincipal.h.

References aux(), and art::EventAuxiliary::time().

     {
       return aux().time();
     }

int Principal::tryNextSecondaryFile ( ) const

protectedinherited

Definition at line 184 of file Principal.cc.

References art::Principal::nextSecondaryFileIdx_, and art::Principal::store_.

Referenced by art::Principal::fillGroup(), art::Principal::findGroupsForProduct(), art::Principal::getGroupForPtr(), and art::Principal::getMatchingSequence().

 {
   int const err = store_->openNextSecondaryFile(nextSecondaryFileIdx_);
   if (err != -2) {
     // there are more files to try
     ++nextSecondaryFileIdx_;
   }
   return err;
 }

Member Data Documentation

EventAuxiliary art::EventPrincipal::aux_

private

Definition at line 150 of file EventPrincipal.h.

Referenced by aux(), and EventPrincipal().

constexpr BranchType art::EventPrincipal::branch_type = Auxiliary::branch_type

static

Definition at line 33 of file EventPrincipal.h.

Referenced by branchType().

std::shared_ptr<History> art::EventPrincipal::history_

private

Definition at line 153 of file EventPrincipal.h.

Referenced by EventPrincipal(), eventSelectionIDs(), and history().

bool art::EventPrincipal::lastInSubRun_ {false}

private

Definition at line 154 of file EventPrincipal.h.

Referenced by EventPrincipal(), and isLastInSubRun().

cet::exempt_ptr<SubRunPrincipal const> art::EventPrincipal::subRunPrincipal_ {nullptr}

private

Definition at line 152 of file EventPrincipal.h.

Referenced by setSubRunPrincipal(), subRunPrincipal(), and subRunPrincipalExemptPtr().

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

art/Framework/Principal/EventPrincipal.h
art/Framework/Principal/EventPrincipal.cc

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation