#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 const &runAux) const

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

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

SubRunPrincipal *	makeSubRunPrincipal (SubRunAuxiliary const &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 const &eventAux, std::unique_ptr< History > &&history) 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
void	throwIfProductsNotRegistered_ () const

ProcessHistoryID	processHistoryID_ (BranchType, ProcessConfiguration const &) const

std::unique_ptr< History >	history_ (ProcessConfiguration const &, std::unique_ptr< History > &&) 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 31 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} {}

python.root_metadata.md

md

Definition: root_metadata.py:196

art::SourceHelper::md_

ModuleDescription md_

Definition: SourceHelper.h:95

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

delete

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

delete

Member Function Documentation

std::unique_ptr< art::History > art::SourceHelper::history_	(	ProcessConfiguration const &	pc,
		std::unique_ptr< History > &&	history
	)		const

private

Definition at line 51 of file SourceHelper.cc.

 {
   // If no event products are present, we do not register the process
   // history, and we return the already-provided history.
   if (presentProducts_->descriptions(InEvent).empty()) {
     return std::move(history);
   }
 
   // To append to the processing history, we must first retrieve the
   // ProcessHistory object corresponding to history's process history
   // ID, if the ID is valid.
   art::ProcessHistory processHistory;
   auto const phid = history->processHistoryID();
   if (phid.isValid()) {
     bool const success = ProcessHistoryRegistry::get(phid, processHistory);
     if (!success) {
       throw Exception{
         errors::LogicError,
         "Error while attempting to create event principal from SourceHelper.\n"}
         << "There is no processing history corresponding to the valid id: "
         << phid << '\n'
         << "Please contact artists@fnal.gov for guidance.";
     }
   }
 
   processHistory.push_back(pc);
   auto const new_phid = processHistory.id();
   art::ProcessHistoryRegistry::emplace(new_phid, processHistory);
   history->setProcessHistoryID(new_phid);
   return std::move(history);
 }

art::EventPrincipal * art::SourceHelper::makeEventPrincipal	(	EventAuxiliary const &	eventAux,
		std::unique_ptr< History > &&	history
	)		const

Definition at line 151 of file SourceHelper.cc.

 {
   if (history.get() == nullptr) {
     throw Exception{
       errors::LogicError,
       "Error while attempting to create principal from SourceHelper.\n"}
       << "The provided 'unique_ptr<History>' object is null, which is not "
          "allowed\n"
          "for this makeEventPrincipal function overload.  Please choose a "
          "different\n"
          "function to use, or provided a non-null History unique pointer.  "
          "Contact\n"
          "artists@fnal.gov for further guidance.";
   }
   throwIfProductsNotRegistered_();
   auto new_history = history_(md_.processConfiguration(), std::move(history));
   auto const processHistoryID = new_history->processHistoryID();
   auto principal = new EventPrincipal{eventAux,
                                       md_.processConfiguration(),
                                       &presentProducts_->get(InEvent),
                                       std::move(new_history)};
   if (processHistoryID.isValid()) {
     principal->markProcessHistoryAsModified();
   }
   return principal;
 }

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

Definition at line 180 of file SourceHelper.cc.

 {
   EventAuxiliary const eventAux{e, startTime, isRealData, eType};
   return makeEventPrincipal(eventAux, std::make_unique<History>());
 }

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 191 of file SourceHelper.cc.

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

template<typename T >

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

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 100 of file SourceHelper.h.

 {
   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 const & runAux ) const

Definition at line 92 of file SourceHelper.cc.

 {
   throwIfProductsNotRegistered_();
   runAux.processHistoryID() =
     processHistoryID_(InRun, md_.processConfiguration());
   auto principal = new RunPrincipal{
     runAux, md_.processConfiguration(), &presentProducts_->get(InRun)};
   if (runAux.processHistoryID().isValid()) {
     principal->markProcessHistoryAsModified();
   }
   return principal;
 }

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

Definition at line 106 of file SourceHelper.cc.

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

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

Definition at line 114 of file SourceHelper.cc.

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

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

Definition at line 121 of file SourceHelper.cc.

 {
   throwIfProductsNotRegistered_();
   auto phid = processHistoryID_(InSubRun, md_.processConfiguration());
   subRunAux.setProcessHistoryID(phid);
   auto principal = new SubRunPrincipal{
     subRunAux, md_.processConfiguration(), &presentProducts_->get(InSubRun)};
   if (subRunAux.processHistoryID().isValid()) {
     principal->markProcessHistoryAsModified();
   }
   return principal;
 }

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

Definition at line 135 of file SourceHelper.cc.

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

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

Definition at line 143 of file SourceHelper.cc.

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

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

delete

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

delete

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

private

Definition at line 34 of file SourceHelper.cc.

 {
   art::ProcessHistory processHistory{};
   // If no products are present for this branch type, we do not
   // register the process history.
   if (presentProducts_->descriptions(bt).empty()) {
     return processHistory.id();
   }
 
   processHistory.push_back(pc);
   auto const phid = processHistory.id();
   art::ProcessHistoryRegistry::emplace(phid, processHistory);
   return phid;
 }

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

private

Definition at line 85 of file SourceHelper.cc.

 {
   presentProducts_ = presentProducts;
 }

void art::SourceHelper::throwIfProductsNotRegistered_ ( ) const

private

Definition at line 18 of file SourceHelper.cc.

 {
   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.";
   }
 }

Friends And Related Function Documentation

template<typename T >

friend class Source

friend

Definition at line 87 of file SourceHelper.h.

Member Data Documentation

ModuleDescription art::SourceHelper::md_

private

Definition at line 95 of file SourceHelper.h.

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

private

Definition at line 94 of file SourceHelper.h.

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

art/art/Framework/IO/Sources/SourceHelper.h
art/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