#include "SourceHelper.h"

Public Member Functions
	SourceHelper (ModuleDescription const &md)

	SourceHelper (SourceHelper const &)=delete

	SourceHelper (SourceHelper &&)=delete

SourceHelper &	operator= (SourceHelper const &)=delete

SourceHelper &	operator= (SourceHelper &&)=delete

template<typename T >
Ptr< T >	makePtr (TypeLabel const &t, Principal const &p, typename Ptr< T >::key_type key) const

RunPrincipal *	makeRunPrincipal (RunAuxiliary runAux) const

RunPrincipal *	makeRunPrincipal (RunID r, Timestamp const &startTime) const

RunPrincipal *	makeRunPrincipal (RunNumber_t r, Timestamp const &startTime) const

SubRunPrincipal *	makeSubRunPrincipal (SubRunAuxiliary subRunAux) const

SubRunPrincipal *	makeSubRunPrincipal (SubRunID const &sr, Timestamp const &startTime) const

SubRunPrincipal *	makeSubRunPrincipal (RunNumber_t r, SubRunNumber_t sr, Timestamp const &startTime) const

EventPrincipal *	makeEventPrincipal (EventAuxiliary eventAux) const

EventPrincipal *	makeEventPrincipal (EventID const &e, Timestamp const &startTime, bool isRealData=true, EventAuxiliary::ExperimentType eType=EventAuxiliary::Data) const

EventPrincipal *	makeEventPrincipal (RunNumber_t r, SubRunNumber_t sr, EventNumber_t e, Timestamp const &startTime, bool isRealData=true, EventAuxiliary::ExperimentType eType=EventAuxiliary::Data) const

template<typename T >
art::Ptr< T >	makePtr (TypeLabel const &tl, Principal const &p, typename Ptr< T >::key_type key) const

Private Member Functions
template<typename T >
T *	makePrincipal_ (typename T::Auxiliary aux) const

void	throwIfProductsNotRegistered_ () const

ProcessHistoryID	updatedProcessHistoryID_ (ProcessHistoryID const &, BranchType, ProcessConfiguration const &) const

void	setPresentProducts (cet::exempt_ptr< ProductTables const > presentProducts)

Private Attributes
cet::exempt_ptr< ProductTables const >	presentProducts_ {nullptr}

ModuleDescription	md_

Friends
template<typename T >
class	Source

Detailed Description

Definition at line 30 of file SourceHelper.h.

Constructor & Destructor Documentation

art::SourceHelper::SourceHelper ( ModuleDescription const & md )

explicit

Definition at line 15 of file SourceHelper.cc.

15 : md_{md} {}

art::SourceHelper::md_

ModuleDescription md_

Definition: SourceHelper.h:89

art::SourceHelper::SourceHelper ( SourceHelper const & )

delete

art::SourceHelper::SourceHelper ( SourceHelper && )

delete

Member Function Documentation

art::EventPrincipal * art::SourceHelper::makeEventPrincipal ( EventAuxiliary eventAux ) const

Definition at line 132 of file SourceHelper.cc.

Referenced by makeEventPrincipal(), fluxr::PPFXFluxReader::readNext(), lris::LArRawInputDriverJP250L::readNext(), lris::LArRawInputDriverLongBo::readNext(), lris::LArRawInputDriverShortBo::readNext(), and lris::LArRawInputDriver::readNext().

 {
   return makePrincipal_<EventPrincipal>(std::move(eventAux));
 }

art::EventPrincipal * art::SourceHelper::makeEventPrincipal	(	EventID const &	e,
		Timestamp const &	startTime,
		bool	isRealData = `true`,
		EventAuxiliary::ExperimentType	eType = `EventAuxiliary::Data`
	)		const

Definition at line 138 of file SourceHelper.cc.

References e, and makeEventPrincipal().

 {
   return makeEventPrincipal(EventAuxiliary{e, startTime, isRealData, eType});
 }

art::EventPrincipal * art::SourceHelper::makeEventPrincipal	(	RunNumber_t	r,
		SubRunNumber_t	sr,
		EventNumber_t	e,
		Timestamp const &	startTime,
		bool	isRealData = `true`,
		EventAuxiliary::ExperimentType	eType = `EventAuxiliary::Data`
	)		const

Definition at line 148 of file SourceHelper.cc.

References makeEventPrincipal(), and r.

 {
   return makeEventPrincipal(EventID{r, sr, e}, startTime, isRealData, eType);
 }

template<typename T >

T * art::SourceHelper::makePrincipal_ ( typename T::Auxiliary aux ) const

private

Definition at line 74 of file SourceHelper.cc.

References md_, presentProducts_, art::ModuleDescription::processConfiguration(), throwIfProductsNotRegistered_(), and updatedProcessHistoryID_().

 {
   throwIfProductsNotRegistered_();
   constexpr auto branch_type = T::branch_type;
   aux.setProcessHistoryID(updatedProcessHistoryID_(
     aux.processHistoryID(), branch_type, md_.processConfiguration()));
   auto principal =
     new T{aux, md_.processConfiguration(), &presentProducts_->get(branch_type)};
   if (aux.processHistoryID().isValid()) {
     principal->markProcessHistoryAsModified();
   }
   return principal;
 }

template<typename T >

Ptr<T> art::SourceHelper::makePtr	(	TypeLabel const &	t,
		Principal const &	p,
		typename Ptr< T >::key_type	key
	)		const

Referenced by fluxr::PPFXFluxReader::readNext().

template<typename T >

art::Ptr<T> art::SourceHelper::makePtr	(	TypeLabel const &	tl,
		Principal const &	p,
		typename Ptr< T >::key_type	key
	)		const

Definition at line 94 of file SourceHelper.h.

References art::Principal::branchType(), md_, art::ModuleDescription::moduleLabel(), art::ModuleDescription::parameterSetID(), art::ModuleDescription::processConfiguration(), and art::Principal::productGetter().

 {
   BranchDescription const pd{p.branchType(),
                              tl,
                              md_.moduleLabel(),
                              md_.parameterSetID(),
                              md_.processConfiguration()};
   ProductID const pid{pd.productID()};
   return Ptr<T>{pid, key, p.productGetter(pid)};
 }

art::RunPrincipal * art::SourceHelper::makeRunPrincipal ( RunAuxiliary runAux ) const

Definition at line 89 of file SourceHelper.cc.

Referenced by makeRunPrincipal(), fluxr::PPFXFluxReader::readNext(), lris::LArRawInputDriverJP250L::readNext(), lris::LArRawInputDriverLongBo::readNext(), lris::LArRawInputDriverShortBo::readNext(), and lris::LArRawInputDriver::readNext().

 {
   return makePrincipal_<RunPrincipal>(std::move(runAux));
 }

art::RunPrincipal * art::SourceHelper::makeRunPrincipal	(	RunID	r,
		Timestamp const &	startTime
	)		const

Definition at line 95 of file SourceHelper.cc.

References art::Timestamp::invalidTimestamp(), makeRunPrincipal(), and r.

 {
   return makeRunPrincipal(
     RunAuxiliary{r, startTime, Timestamp::invalidTimestamp()});
 }

art::RunPrincipal * art::SourceHelper::makeRunPrincipal	(	RunNumber_t	r,
		Timestamp const &	startTime
	)		const

Definition at line 103 of file SourceHelper.cc.

References makeRunPrincipal().

 {
   return makeRunPrincipal(RunID{r}, startTime);
 }

art::SubRunPrincipal * art::SourceHelper::makeSubRunPrincipal ( SubRunAuxiliary subRunAux ) const

Definition at line 110 of file SourceHelper.cc.

Referenced by makeSubRunPrincipal(), fluxr::PPFXFluxReader::readNext(), lris::LArRawInputDriverJP250L::readNext(), lris::LArRawInputDriverLongBo::readNext(), lris::LArRawInputDriverShortBo::readNext(), and lris::LArRawInputDriver::readNext().

 {
   return makePrincipal_<SubRunPrincipal>(std::move(subRunAux));
 }

art::SubRunPrincipal * art::SourceHelper::makeSubRunPrincipal	(	SubRunID const &	sr,
		Timestamp const &	startTime
	)		const

Definition at line 116 of file SourceHelper.cc.

References art::Timestamp::invalidTimestamp(), and makeSubRunPrincipal().

 {
   return makeSubRunPrincipal(
     SubRunAuxiliary{sr, startTime, Timestamp::invalidTimestamp()});
 }

art::SubRunPrincipal * art::SourceHelper::makeSubRunPrincipal	(	RunNumber_t	r,
		SubRunNumber_t	sr,
		Timestamp const &	startTime
	)		const

Definition at line 124 of file SourceHelper.cc.

References makeSubRunPrincipal(), and r.

 {
   return makeSubRunPrincipal(SubRunID{r, sr}, startTime);
 }

SourceHelper& art::SourceHelper::operator= ( SourceHelper const & )

delete

SourceHelper& art::SourceHelper::operator= ( SourceHelper && )

delete

void art::SourceHelper::setPresentProducts ( cet::exempt_ptr< ProductTables const > presentProducts )

private

Definition at line 66 of file SourceHelper.cc.

References presentProducts_.

 {
   presentProducts_ = presentProducts;
 }

void art::SourceHelper::throwIfProductsNotRegistered_ ( ) const

private

Definition at line 18 of file SourceHelper.cc.

References presentProducts_, and art::errors::ProductRegistrationFailure.

Referenced by makePrincipal_().

 {
   if (!presentProducts_) {
     throw Exception(
       errors::ProductRegistrationFailure,
       "Error while attempting to create principal from SourceHelper.\n")
       << "Principals cannot be created until product registration is "
          "complete.\n"
          "This can happen if you are attempting to create a Principal\n"
          "outside of your 'readNext' function, or if you are using a\n"
          "different SourceHelper object than the one provided by art.\n"
          "Please contact artists@fnal.gov for guidance.";
   }
 }

art::ProcessHistoryID art::SourceHelper::updatedProcessHistoryID_	(	ProcessHistoryID const &	processHistoryID,
		BranchType	bt,
		ProcessConfiguration const &	pc
	)		const

private

Definition at line 34 of file SourceHelper.cc.

References art::thread_safe_registry_via_id< K, M >::emplace(), art::thread_safe_registry_via_id< K, M >::get(), art::Hash< I >::isValid(), art::errors::LogicError, and presentProducts_.

Referenced by makePrincipal_().

 {
   // If no products are present for this branch type, we do not
   // update the process history.
   if (presentProducts_->descriptions(bt).empty()) {
     return processHistoryID;
   }
 
   art::ProcessHistory processHistory{};
   if (processHistoryID.isValid()) {
     bool const found =
       ProcessHistoryRegistry::get(processHistoryID, processHistory);
     if (!found) {
       throw Exception(
         errors::LogicError,
         "Error while attempting to create principal from SourceHelper.\n")
         << "The provided process-history ID\n"
         << "  " << processHistory << '\n'
         << "does not correspond to a known process history.\n"
            "Please contact artists@fnal.gov for guidance.";
     }
   }
   processHistory.push_back(pc);
   auto const phid = processHistory.id();
   art::ProcessHistoryRegistry::emplace(phid, processHistory);
   return phid;
 }

Friends And Related Function Documentation

template<typename T >

friend class Source

friend

Definition at line 79 of file SourceHelper.h.

Member Data Documentation

ModuleDescription art::SourceHelper::md_

private

Definition at line 89 of file SourceHelper.h.

Referenced by makePrincipal_(), and makePtr().

cet::exempt_ptr<ProductTables const> art::SourceHelper::presentProducts_ {nullptr}

private

Definition at line 88 of file SourceHelper.h.

Referenced by makePrincipal_(), setPresentProducts(), throwIfProductsNotRegistered_(), and updatedProcessHistoryID_().

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

art/Framework/IO/Sources/SourceHelper.h
art/Framework/IO/Sources/SourceHelper.cc

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation