art::DecrepitRelicInputSourceImplementation Class Reference

#include "/cvmfs/nova.opensciencegrid.org/externals/art/v2_13_00/source/art/Framework/Core/DecrepitRelicInputSourceImplementation.h"

Inheritance diagram for art::DecrepitRelicInputSourceImplementation:

Classes
struct	Config

Public Types
enum	ProcessingMode { Runs, RunsAndSubRuns, RunsSubRunsAndEvents }

Public Member Functions
	DecrepitRelicInputSourceImplementation (DecrepitRelicInputSourceImplementation const &)=delete
DecrepitRelicInputSourceImplementation &	operator= (DecrepitRelicInputSourceImplementation const &)=delete
	DecrepitRelicInputSourceImplementation (fhicl::TableFragment< Config > const &, ModuleDescription const &)
virtual	~DecrepitRelicInputSourceImplementation () noexcept=0
input::ItemType	nextItemType () override
std::unique_ptr< EventPrincipal >	readEvent (cet::exempt_ptr< SubRunPrincipal const > srp) override
std::unique_ptr< SubRunPrincipal >	readSubRun (cet::exempt_ptr< RunPrincipal const > rp) override
	Read next subRun. More...
std::unique_ptr< RunPrincipal >	readRun () override
	Read next run. More...
std::unique_ptr< FileBlock >	readFile () override
	Read next file. More...
void	closeFile () override
	close current file More...
void	skipEvents (int offset) override
void	rewind () override
	Begin again at the first event. More...
void	issueReports (EventID const &eventID)
	issue an event report More...
void	repeat_ ()
	Reset the remaining number of events/subRuns to the maximum number. More...
int	maxEvents () const
int	remainingEvents () const
int	maxSubRuns () const
int	remainingSubRuns () const
void	doBeginJob () override
	Called by framework at beginning of job. More...
void	doEndJob () override
	Called by framework at end of job. More...
Timestamp const &	timestamp () const
	Accessor for the current time, as seen by the input source. More...
ProcessingMode	processingMode () const
	RunsSubRunsAndEvents (default), RunsAndSubRuns, or Runs. More...
auto const &	moduleDescription () const
auto const &	processConfiguration () const
virtual std::unique_ptr< RangeSetHandler >	runRangeSetHandler ()=0
virtual std::unique_ptr< RangeSetHandler >	subRunRangeSetHandler ()=0

Protected Member Functions
void	setTimestamp (Timestamp const &theTime)
	To set the current time, as seen by the input source. More...
input::ItemType	state () const
virtual void	finish ()
cet::exempt_ptr< RunPrincipal >	runPrincipalExemptPtr ()
cet::exempt_ptr< SubRunPrincipal >	subRunPrincipalExemptPtr ()
std::unique_ptr< RunPrincipal >	runPrincipal ()
std::unique_ptr< SubRunPrincipal >	subRunPrincipal ()
std::unique_ptr< EventPrincipal >	eventPrincipal ()
void	setRunPrincipal (std::unique_ptr< RunPrincipal > &&rp)
void	setSubRunPrincipal (std::unique_ptr< SubRunPrincipal > &&srp)
void	setEventPrincipal (std::unique_ptr< EventPrincipal > &&ep)
void	resetRunPrincipal ()
void	resetSubRunPrincipal ()
void	resetEventPrincipal ()
void	reset ()

Private Member Functions
bool	eventLimitReached () const
bool	subRunLimitReached () const
bool	limitReached () const
virtual input::ItemType	getNextItemType ()=0
input::ItemType	nextItemType_ ()
virtual std::unique_ptr< RunPrincipal >	readRun_ ()=0
virtual std::unique_ptr< SubRunPrincipal >	readSubRun_ ()=0
virtual std::unique_ptr< EventPrincipal >	readEvent_ ()=0
virtual std::unique_ptr< FileBlock >	readFile_ ()
virtual void	closeFile_ ()
virtual void	skip (int)
virtual void	rewind_ ()
virtual void	beginJob ()
virtual void	endJob ()

Private Attributes
int	maxEvents_
int	maxSubRuns_
int const	reportFrequency_
int	remainingEvents_ {maxEvents_}
int	remainingSubRuns_ {maxSubRuns_}
int	readCount_ {}
ProcessingMode	processingMode_ {RunsSubRunsAndEvents}
Timestamp	time_ {Timestamp::invalidTimestamp()}
bool	doneReadAhead_ {false}
input::ItemType	state_ {input::IsInvalid}
std::unique_ptr< RunPrincipal >	runPrincipal_ {nullptr}
std::unique_ptr< SubRunPrincipal >	subRunPrincipal_ {nullptr}
std::unique_ptr< EventPrincipal >	eventPrincipal_ {nullptr}
cet::exempt_ptr< RunPrincipal >	cachedRunPrincipal_ {nullptr}
cet::exempt_ptr< SubRunPrincipal >	cachedSubRunPrincipal_ {nullptr}

Detailed Description

Definition at line 67 of file DecrepitRelicInputSourceImplementation.h.

Member Enumeration Documentation

enum art::InputSource::ProcessingMode

inherited

Enumerator
Runs
RunsAndSubRuns
RunsSubRunsAndEvents

Definition at line 52 of file InputSource.h.

{ Runs, RunsAndSubRuns, RunsSubRunsAndEvents };

Constructor & Destructor Documentation

art::DecrepitRelicInputSourceImplementation::DecrepitRelicInputSourceImplementation ( DecrepitRelicInputSourceImplementation const &  )

delete

art::DecrepitRelicInputSourceImplementation::DecrepitRelicInputSourceImplementation	(	fhicl::TableFragment< Config > const &	,
		ModuleDescription const &
	)

virtual art::DecrepitRelicInputSourceImplementation::~DecrepitRelicInputSourceImplementation ( )

pure virtualnoexcept

Member Function Documentation

virtual void art::DecrepitRelicInputSourceImplementation::beginJob ( )

privatevirtual

Reimplemented in art::EmptyEvent.

Referenced by closeFile_().

void art::DecrepitRelicInputSourceImplementation::closeFile ( )

overridevirtual

close current file

Implements art::InputSource.

virtual void art::DecrepitRelicInputSourceImplementation::closeFile_ ( )

inlineprivatevirtual

Reimplemented in art::RootInput.

Definition at line 298 of file DecrepitRelicInputSourceImplementation.h.

References beginJob(), endJob(), rewind_(), and skip().

    {}

void art::DecrepitRelicInputSourceImplementation::doBeginJob ( )

overridevirtual

Called by framework at beginning of job.

Reimplemented from art::InputSource.

Referenced by remainingSubRuns().

void art::DecrepitRelicInputSourceImplementation::doEndJob ( )

overridevirtual

Called by framework at end of job.

Reimplemented from art::InputSource.

Referenced by remainingSubRuns().

virtual void art::DecrepitRelicInputSourceImplementation::endJob ( )

privatevirtual

Reimplemented in art::RootInput, and art::EmptyEvent.

Referenced by closeFile_().

bool art::DecrepitRelicInputSourceImplementation::eventLimitReached ( ) const

inlineprivate

Definition at line 277 of file DecrepitRelicInputSourceImplementation.h.

References remainingEvents_.

Referenced by limitReached().

    {
      return remainingEvents_ == 0;
    }

std::unique_ptr<EventPrincipal> art::DecrepitRelicInputSourceImplementation::eventPrincipal ( )

inlineprotected

Definition at line 245 of file DecrepitRelicInputSourceImplementation.h.

References lem_server::ep, eventPrincipal_, setEventPrincipal(), setRunPrincipal(), and setSubRunPrincipal().

Referenced by art::RootInput::readEvent_().

    {
      return std::move(eventPrincipal_);
    }

virtual void art::DecrepitRelicInputSourceImplementation::finish ( )

inlineprotectedvirtual

Reimplemented in art::RootInput.

Definition at line 216 of file DecrepitRelicInputSourceImplementation.h.

    {}

virtual input::ItemType art::DecrepitRelicInputSourceImplementation::getNextItemType ( )

privatepure virtual

Implemented in art::RootInput, and art::EmptyEvent.

Referenced by limitReached().

void art::DecrepitRelicInputSourceImplementation::issueReports

(

EventID const &

eventID

)

issue an event report

Referenced by rewind().

bool art::DecrepitRelicInputSourceImplementation::limitReached ( ) const

inlineprivate

Definition at line 287 of file DecrepitRelicInputSourceImplementation.h.

References eventLimitReached(), getNextItemType(), nextItemType_(), readEvent_(), readFile_(), readRun_(), readSubRun_(), and subRunLimitReached().

    {
      return eventLimitReached() || subRunLimitReached();
    }

int art::DecrepitRelicInputSourceImplementation::maxEvents ( ) const

inline

Accessor for maximum number of events to be read. -1 is used for unlimited.

Definition at line 150 of file DecrepitRelicInputSourceImplementation.h.

References maxEvents_.

    {
      return maxEvents_;
    }

int art::DecrepitRelicInputSourceImplementation::maxSubRuns ( ) const

inline

Accessor for maximum number of subRuns to be read. -1 is used for unlimited.

Definition at line 166 of file DecrepitRelicInputSourceImplementation.h.

References maxSubRuns_.

    {
      return maxSubRuns_;
    }

auto const& art::InputSource::moduleDescription ( ) const

inlineinherited

Definition at line 59 of file InputSource.h.

Referenced by art::EmptyEvent::readRun_(), and art::EmptyEvent::readSubRun_().

    {
      return moduleDescription_;
    }

input::ItemType art::DecrepitRelicInputSourceImplementation::nextItemType ( )

overridevirtual

Implements art::InputSource.

Reimplemented in art::RootInput.

Referenced by art::RootInput::nextItemType().

input::ItemType art::DecrepitRelicInputSourceImplementation::nextItemType_ ( )

private

Referenced by limitReached().

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

delete

auto const& art::InputSource::processConfiguration ( ) const

inlineinherited

Definition at line 64 of file InputSource.h.

References getGoodRuns4SAM::n.

Referenced by art::EmptyEvent::readRun_(), art::EmptyEvent::readSubRun_(), art::EmptyEvent::reallyReadEvent(), and art::RootInput::RootInput().

    {
      return moduleDescription_.processConfiguration();
    }

ProcessingMode art::DecrepitRelicInputSourceImplementation::processingMode ( ) const

inline

RunsSubRunsAndEvents (default), RunsAndSubRuns, or Runs.

Definition at line 194 of file DecrepitRelicInputSourceImplementation.h.

References processingMode_.

Referenced by art::EmptyEvent::getNextItemType(), art::EmptyEvent::readEvent_(), art::EmptyEvent::readSubRun_(), art::EmptyEvent::reallyReadEvent(), and art::RootInput::RootInput().

    {
      return processingMode_;
    }

std::unique_ptr<EventPrincipal> art::DecrepitRelicInputSourceImplementation::readEvent ( cet::exempt_ptr< SubRunPrincipal const >  srp )

overridevirtual

Read next event Indicate inability to get a new event by returning a null unique_ptr.

Implements art::InputSource.

Reimplemented in art::RootInput.

Referenced by art::RootInput::readEvent_().

virtual std::unique_ptr<EventPrincipal> art::DecrepitRelicInputSourceImplementation::readEvent_ ( )

privatepure virtual

Implemented in art::RootInput, and art::EmptyEvent.

Referenced by limitReached().

std::unique_ptr<FileBlock> art::DecrepitRelicInputSourceImplementation::readFile ( )

overridevirtual

Read next file.

Implements art::InputSource.

Reimplemented in art::RootInput.

Referenced by art::RootInput::readFile().

virtual std::unique_ptr<FileBlock> art::DecrepitRelicInputSourceImplementation::readFile_ ( )

privatevirtual

Reimplemented in art::RootInput.

Referenced by limitReached().

std::unique_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::readRun ( )

overridevirtual

Read next run.

Implements art::InputSource.

Reimplemented in art::RootInput.

Referenced by art::RootInput::readRun().

virtual std::unique_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::readRun_ ( )

privatepure virtual

Implemented in art::RootInput, and art::EmptyEvent.

Referenced by limitReached().

std::unique_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::readSubRun ( cet::exempt_ptr< RunPrincipal const >  rp )

overridevirtual

Read next subRun.

Implements art::InputSource.

Reimplemented in art::RootInput.

Referenced by art::RootInput::readSubRun().

virtual std::unique_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::readSubRun_ ( )

privatepure virtual

Implemented in art::RootInput, and art::EmptyEvent.

Referenced by limitReached().

int art::DecrepitRelicInputSourceImplementation::remainingEvents ( ) const

inline

Accessor for remaining number of events to be read. -1 is used for unlimited.

Definition at line 158 of file DecrepitRelicInputSourceImplementation.h.

References remainingEvents_.

    {
      return remainingEvents_;
    }

int art::DecrepitRelicInputSourceImplementation::remainingSubRuns ( ) const

inline

Accessor for remaining number of subRuns to be read. -1 is used for unlimited.

Definition at line 174 of file DecrepitRelicInputSourceImplementation.h.

References doBeginJob(), doEndJob(), and remainingSubRuns_.

    {
      return remainingSubRuns_;
    }

void art::DecrepitRelicInputSourceImplementation::repeat_ ( )

inline

Reset the remaining number of events/subRuns to the maximum number.

Definition at line 140 of file DecrepitRelicInputSourceImplementation.h.

References doneReadAhead_, maxEvents_, maxSubRuns_, remainingEvents_, and remainingSubRuns_.

Referenced by rewind().

    {
      remainingEvents_ = maxEvents_;
      remainingSubRuns_ = maxSubRuns_;
      doneReadAhead_ = false;
    }

void art::DecrepitRelicInputSourceImplementation::reset ( )

inlineprotected

Definition at line 269 of file DecrepitRelicInputSourceImplementation.h.

References doneReadAhead_, art::input::IsInvalid, and state_.

    {
      doneReadAhead_ = false;
      state_ = input::IsInvalid;
    }

void art::DecrepitRelicInputSourceImplementation::resetEventPrincipal ( )

inlineprotected

Definition at line 264 of file DecrepitRelicInputSourceImplementation.h.

References eventPrincipal_.

    {
      eventPrincipal_.reset();
    }

void art::DecrepitRelicInputSourceImplementation::resetRunPrincipal ( )

inlineprotected

Definition at line 254 of file DecrepitRelicInputSourceImplementation.h.

References runPrincipal_.

Referenced by art::EmptyEvent::getNextItemType(), and art::EmptyEvent::rewind_().

    {
      runPrincipal_.reset();
    }

void art::DecrepitRelicInputSourceImplementation::resetSubRunPrincipal ( )

inlineprotected

Definition at line 259 of file DecrepitRelicInputSourceImplementation.h.

References subRunPrincipal_.

Referenced by art::EmptyEvent::getNextItemType(), and art::EmptyEvent::rewind_().

    {
      subRunPrincipal_.reset();
    }

void art::DecrepitRelicInputSourceImplementation::rewind ( )

inlineoverridevirtual

Begin again at the first event.

Reimplemented from art::InputSource.

Definition at line 127 of file DecrepitRelicInputSourceImplementation.h.

References doneReadAhead_, eventID, art::input::IsInvalid, issueReports(), repeat_(), rewind_(), and state_.

    {
      repeat_();
      doneReadAhead_ = false;
      state_ = input::IsInvalid;
      rewind_();
    }

virtual void art::DecrepitRelicInputSourceImplementation::rewind_ ( )

privatevirtual

Reimplemented in art::RootInput, and art::EmptyEvent.

Referenced by closeFile_(), and rewind().

std::unique_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::runPrincipal ( )

inlineprotected

Definition at line 231 of file DecrepitRelicInputSourceImplementation.h.

References cachedRunPrincipal_, and runPrincipal_.

Referenced by art::RootInput::readRun().

    {
      cachedRunPrincipal_ = runPrincipal_.get();
      return std::move(runPrincipal_);
    }

cet::exempt_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::runPrincipalExemptPtr ( )

inlineprotected

Definition at line 220 of file DecrepitRelicInputSourceImplementation.h.

References cachedRunPrincipal_.

Referenced by art::RootInput::nextItemType(), and art::RootInput::readSubRun_().

    {
      return cachedRunPrincipal_;
    }

virtual std::unique_ptr<RangeSetHandler> art::InputSource::runRangeSetHandler ( )

pure virtualinherited

Implemented in art::SamplingInput, art::Source< T >, art::RootInput, and art::EmptyEvent.

void art::DecrepitRelicInputSourceImplementation::setEventPrincipal ( std::unique_ptr< EventPrincipal > &&  ep )

protected

Referenced by eventPrincipal(), and art::RootInput::nextItemType().

void art::DecrepitRelicInputSourceImplementation::setRunPrincipal ( std::unique_ptr< RunPrincipal > &&  rp )

protected

Referenced by eventPrincipal(), and art::RootInput::nextItemType().

void art::DecrepitRelicInputSourceImplementation::setSubRunPrincipal ( std::unique_ptr< SubRunPrincipal > &&  srp )

protected

Referenced by eventPrincipal(), and art::RootInput::nextItemType().

void art::DecrepitRelicInputSourceImplementation::setTimestamp ( Timestamp const &  theTime )

inlineprotected

To set the current time, as seen by the input source.

Definition at line 202 of file DecrepitRelicInputSourceImplementation.h.

References time_.

Referenced by art::EmptyEvent::rewind_().

    {
      time_ = theTime;
    }

virtual void art::DecrepitRelicInputSourceImplementation::skip ( int  )

privatevirtual

Reimplemented in art::EmptyEvent.

Referenced by closeFile_().

void art::DecrepitRelicInputSourceImplementation::skipEvents ( int  offset )

overridevirtual

Skip the number of events specified. Offset may be negative.

Reimplemented from art::InputSource.

input::ItemType art::DecrepitRelicInputSourceImplementation::state ( ) const

inlineprotected

Definition at line 208 of file DecrepitRelicInputSourceImplementation.h.

References state_.

Referenced by art::RootInput::AccessState::state().

    {
      return state_;
    }

bool art::DecrepitRelicInputSourceImplementation::subRunLimitReached ( ) const

inlineprivate

Definition at line 282 of file DecrepitRelicInputSourceImplementation.h.

References remainingSubRuns_.

Referenced by limitReached().

    {
      return remainingSubRuns_ == 0;
    }

std::unique_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::subRunPrincipal ( )

inlineprotected

Definition at line 238 of file DecrepitRelicInputSourceImplementation.h.

References cachedSubRunPrincipal_, and subRunPrincipal_.

Referenced by art::RootInput::readSubRun().

    {
      cachedSubRunPrincipal_ = subRunPrincipal_.get();
      return std::move(subRunPrincipal_);
    }

cet::exempt_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::subRunPrincipalExemptPtr ( )

inlineprotected

Definition at line 225 of file DecrepitRelicInputSourceImplementation.h.

References cachedSubRunPrincipal_.

    {
      return cachedSubRunPrincipal_;
    }

virtual std::unique_ptr<RangeSetHandler> art::InputSource::subRunRangeSetHandler ( )

pure virtualinherited

Implemented in art::SamplingInput, art::Source< T >, art::RootInput, and art::EmptyEvent.

Timestamp const& art::DecrepitRelicInputSourceImplementation::timestamp ( ) const

inline

Accessor for the current time, as seen by the input source.

Definition at line 187 of file DecrepitRelicInputSourceImplementation.h.

References time_.

Referenced by art::EmptyEvent::reallyReadEvent().

    {
      return time_;
    }

Member Data Documentation

cet::exempt_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::cachedRunPrincipal_ {nullptr}

private

Definition at line 320 of file DecrepitRelicInputSourceImplementation.h.

Referenced by runPrincipal(), and runPrincipalExemptPtr().

cet::exempt_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::cachedSubRunPrincipal_ {nullptr}

private

Definition at line 321 of file DecrepitRelicInputSourceImplementation.h.

Referenced by subRunPrincipal(), and subRunPrincipalExemptPtr().

bool art::DecrepitRelicInputSourceImplementation::doneReadAhead_ {false}

private

Definition at line 315 of file DecrepitRelicInputSourceImplementation.h.

Referenced by repeat_(), reset(), and rewind().

std::unique_ptr<EventPrincipal> art::DecrepitRelicInputSourceImplementation::eventPrincipal_ {nullptr}

private

Definition at line 319 of file DecrepitRelicInputSourceImplementation.h.

Referenced by eventPrincipal(), and resetEventPrincipal().

int art::DecrepitRelicInputSourceImplementation::maxEvents_

private

Definition at line 306 of file DecrepitRelicInputSourceImplementation.h.

Referenced by maxEvents(), and repeat_().

int art::DecrepitRelicInputSourceImplementation::maxSubRuns_

private

Definition at line 307 of file DecrepitRelicInputSourceImplementation.h.

Referenced by maxSubRuns(), and repeat_().

ProcessingMode art::DecrepitRelicInputSourceImplementation::processingMode_ {RunsSubRunsAndEvents}

private

Definition at line 313 of file DecrepitRelicInputSourceImplementation.h.

Referenced by processingMode().

int art::DecrepitRelicInputSourceImplementation::readCount_ {}

private

Definition at line 312 of file DecrepitRelicInputSourceImplementation.h.

int art::DecrepitRelicInputSourceImplementation::remainingEvents_ {maxEvents_}

private

Definition at line 310 of file DecrepitRelicInputSourceImplementation.h.

Referenced by eventLimitReached(), remainingEvents(), and repeat_().

int art::DecrepitRelicInputSourceImplementation::remainingSubRuns_ {maxSubRuns_}

private

Definition at line 311 of file DecrepitRelicInputSourceImplementation.h.

Referenced by remainingSubRuns(), repeat_(), and subRunLimitReached().

int const art::DecrepitRelicInputSourceImplementation::reportFrequency_

private

Definition at line 308 of file DecrepitRelicInputSourceImplementation.h.

std::unique_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::runPrincipal_ {nullptr}

private

Definition at line 317 of file DecrepitRelicInputSourceImplementation.h.

Referenced by resetRunPrincipal(), and runPrincipal().

input::ItemType art::DecrepitRelicInputSourceImplementation::state_ {input::IsInvalid}

private

Definition at line 316 of file DecrepitRelicInputSourceImplementation.h.

Referenced by reset(), art::RootInput::AccessState::resetState(), rewind(), art::RootInput::AccessState::state(), and state().

std::unique_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::subRunPrincipal_ {nullptr}

private

Definition at line 318 of file DecrepitRelicInputSourceImplementation.h.

Referenced by resetSubRunPrincipal(), and subRunPrincipal().

Timestamp art::DecrepitRelicInputSourceImplementation::time_ {Timestamp::invalidTimestamp()}

private

Definition at line 314 of file DecrepitRelicInputSourceImplementation.h.

Referenced by setTimestamp(), and timestamp().

---

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

• art/Framework/Core/DecrepitRelicInputSourceImplementation.h