art::SourceHelper Class Reference

#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::shared_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
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 37 of file SourceHelper.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 10 of file SourceHelper.cc.

: md_{md} {}

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

delete

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

delete

Member Function Documentation

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

Definition at line 83 of file SourceHelper.cc.

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

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

{
  throwIfProductsNotRegistered_();
  return new EventPrincipal{eventAux,
                            md_.processConfiguration(),
                            &presentProducts_->get(InEvent),
                            history};
}

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

Definition at line 94 of file SourceHelper.cc.

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

{
  throwIfProductsNotRegistered_();
  EventAuxiliary const eventAux{e, startTime, isRealData, eType};
  return new EventPrincipal{
    eventAux, md_.processConfiguration(), &presentProducts_->get(InEvent)};
}

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

References makeEventPrincipal().

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

References art::Principal::branchType(), md_, and art::Principal::productGetter().

{
  BranchDescription const pd{p.branchType(), tl, md_};
  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 36 of file SourceHelper.cc.

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

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

{
  throwIfProductsNotRegistered_();
  return new RunPrincipal{
    runAux, md_.processConfiguration(), &presentProducts_->get(InRun)};
}

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

Definition at line 44 of file SourceHelper.cc.

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

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

References makeRunPrincipal().

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

art::SubRunPrincipal * art::SourceHelper::makeSubRunPrincipal

(

SubRunAuxiliary const &

subRunAux

)

const

Definition at line 59 of file SourceHelper.cc.

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

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

{
  throwIfProductsNotRegistered_();
  return new SubRunPrincipal{
    subRunAux, md_.processConfiguration(), &presentProducts_->get(InSubRun)};
}

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

Definition at line 67 of file SourceHelper.cc.

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

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

References makeSubRunPrincipal().

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

References presentProducts_.

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

{
  presentProducts_ = presentProducts;
}

void art::SourceHelper::throwIfProductsNotRegistered_ ( ) const

private

Definition at line 13 of file SourceHelper.cc.

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

Referenced by makeEventPrincipal(), makeRunPrincipal(), and makeSubRunPrincipal().

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

Member Data Documentation

ModuleDescription art::SourceHelper::md_

private

Definition at line 97 of file SourceHelper.h.

Referenced by makeEventPrincipal(), makePtr(), makeRunPrincipal(), and makeSubRunPrincipal().

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

private

Definition at line 96 of file SourceHelper.h.

Referenced by makeEventPrincipal(), makeRunPrincipal(), makeSubRunPrincipal(), setPresentProducts(), and throwIfProductsNotRegistered_().

---

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

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