Classes | Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
art::DecrepitRelicInputSourceImplementation Class Referenceabstract

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

Inheritance diagram for art::DecrepitRelicInputSourceImplementation:
art::InputSource art::EmptyEvent art::RootInput

Classes

struct  Config
 

Public Types

enum  ProcessingMode { Runs, RunsAndSubRuns, RunsSubRunsAndEvents }
 

Public Member Functions

 DecrepitRelicInputSourceImplementation (DecrepitRelicInputSourceImplementation const &)=delete
 
DecrepitRelicInputSourceImplementationoperator= (DecrepitRelicInputSourceImplementation const &)=delete
 
 DecrepitRelicInputSourceImplementation (fhicl::TableFragment< Config > const &, ModuleDescription const &)
 
virtual ~DecrepitRelicInputSourceImplementation () noexcept=0
 
input::ItemType nextItemType () override
 
std::unique_ptr< EventPrincipalreadEvent (cet::exempt_ptr< SubRunPrincipal const > srp) override
 
std::unique_ptr< SubRunPrincipalreadSubRun (cet::exempt_ptr< RunPrincipal const > rp) override
 Read next subRun. More...
 
std::unique_ptr< RunPrincipalreadRun () override
 Read next run. More...
 
std::unique_ptr< FileBlockreadFile () 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< RangeSetHandlerrunRangeSetHandler ()=0
 
virtual std::unique_ptr< RangeSetHandlersubRunRangeSetHandler ()=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< RunPrincipalrunPrincipalExemptPtr ()
 
cet::exempt_ptr< SubRunPrincipalsubRunPrincipalExemptPtr ()
 
std::unique_ptr< RunPrincipalrunPrincipal ()
 
std::unique_ptr< SubRunPrincipalsubRunPrincipal ()
 
std::unique_ptr< EventPrincipaleventPrincipal ()
 
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< RunPrincipalreadRun_ ()=0
 
virtual std::unique_ptr< SubRunPrincipalreadSubRun_ ()=0
 
virtual std::unique_ptr< EventPrincipalreadEvent_ ()=0
 
virtual std::unique_ptr< FileBlockreadFile_ ()
 
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< RunPrincipalrunPrincipal_ {nullptr}
 
std::unique_ptr< SubRunPrincipalsubRunPrincipal_ {nullptr}
 
std::unique_ptr< EventPrincipaleventPrincipal_ {nullptr}
 
cet::exempt_ptr< RunPrincipalcachedRunPrincipal_ {nullptr}
 
cet::exempt_ptr< SubRunPrincipalcachedSubRunPrincipal_ {nullptr}
 

Detailed Description

Definition at line 67 of file DecrepitRelicInputSourceImplementation.h.

Member Enumeration Documentation

Enumerator
Runs 
RunsAndSubRuns 
RunsSubRunsAndEvents 

Definition at line 52 of file InputSource.h.

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().

299  {}
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
std::unique_ptr<EventPrincipal> art::DecrepitRelicInputSourceImplementation::eventPrincipal ( )
inlineprotected
virtual void art::DecrepitRelicInputSourceImplementation::finish ( )
inlineprotectedvirtual

Reimplemented in art::RootInput.

Definition at line 216 of file DecrepitRelicInputSourceImplementation.h.

217  {}
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
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_.

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_.

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

Definition at line 59 of file InputSource.h.

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

60  {
61  return moduleDescription_;
62  }
ModuleDescription moduleDescription_
Definition: InputSource.h:93
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().

65  {
67  }
ModuleDescription moduleDescription_
Definition: InputSource.h:93
ProcessConfiguration const & processConfiguration() const
ProcessingMode art::DecrepitRelicInputSourceImplementation::processingMode ( ) const
inline
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_.

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_.

void art::DecrepitRelicInputSourceImplementation::repeat_ ( )
inline
void art::DecrepitRelicInputSourceImplementation::reset ( )
inlineprotected
void art::DecrepitRelicInputSourceImplementation::resetEventPrincipal ( )
inlineprotected

Definition at line 264 of file DecrepitRelicInputSourceImplementation.h.

References eventPrincipal_.

265  {
266  eventPrincipal_.reset();
267  }
void art::DecrepitRelicInputSourceImplementation::resetRunPrincipal ( )
inlineprotected

Definition at line 254 of file DecrepitRelicInputSourceImplementation.h.

References runPrincipal_.

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

255  {
256  runPrincipal_.reset();
257  }
void art::DecrepitRelicInputSourceImplementation::resetSubRunPrincipal ( )
inlineprotected

Definition at line 259 of file DecrepitRelicInputSourceImplementation.h.

References subRunPrincipal_.

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

260  {
261  subRunPrincipal_.reset();
262  }
void art::DecrepitRelicInputSourceImplementation::rewind ( )
inlineoverridevirtual
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().

232  {
234  return std::move(runPrincipal_);
235  }
cet::exempt_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::runPrincipalExemptPtr ( )
inlineprotected
virtual std::unique_ptr<RangeSetHandler> art::InputSource::runRangeSetHandler ( )
pure virtualinherited
void art::DecrepitRelicInputSourceImplementation::setEventPrincipal ( std::unique_ptr< EventPrincipal > &&  ep)
protected
void art::DecrepitRelicInputSourceImplementation::setRunPrincipal ( std::unique_ptr< RunPrincipal > &&  rp)
protected
void art::DecrepitRelicInputSourceImplementation::setSubRunPrincipal ( std::unique_ptr< SubRunPrincipal > &&  srp)
protected
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_().

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().

bool art::DecrepitRelicInputSourceImplementation::subRunLimitReached ( ) const
inlineprivate
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().

239  {
241  return std::move(subRunPrincipal_);
242  }
cet::exempt_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::subRunPrincipalExemptPtr ( )
inlineprotected

Definition at line 225 of file DecrepitRelicInputSourceImplementation.h.

References cachedSubRunPrincipal_.

226  {
227  return cachedSubRunPrincipal_;
228  }
virtual std::unique_ptr<RangeSetHandler> art::InputSource::subRunRangeSetHandler ( )
pure virtualinherited
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().

Member Data Documentation

cet::exempt_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::cachedRunPrincipal_ {nullptr}
private
cet::exempt_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::cachedSubRunPrincipal_ {nullptr}
private
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
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
int art::DecrepitRelicInputSourceImplementation::remainingSubRuns_ {maxSubRuns_}
private
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
std::unique_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::subRunPrincipal_ {nullptr}
private
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: