CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Private Member Functions
edm::VectorInputSource Class Referenceabstract

#include <VectorInputSource.h>

Inheritance diagram for edm::VectorInputSource:
edm::EDInputSource edm::InputSource edm::ProductRegistryHelper edm::PoolSource

Public Member Functions

void dropUnwantedBranches (std::vector< std::string > const &wantedBranches)
 
template<typename T >
size_t loopRandom (EventPrincipal &cache, size_t number, T eventOperator, CLHEP::HepRandomEngine *)
 
template<typename T >
size_t loopRandomWithID (EventPrincipal &cache, LuminosityBlockID const &id, size_t number, T eventOperator, CLHEP::HepRandomEngine *)
 
template<typename T >
size_t loopSequential (EventPrincipal &cache, size_t number, T eventOperator)
 
template<typename T >
size_t loopSequentialWithID (EventPrincipal &cache, LuminosityBlockID const &id, size_t number, T eventOperator)
 
template<typename T , typename Collection >
size_t loopSpecified (EventPrincipal &cache, Collection const &events, T eventOperator)
 
 VectorInputSource (ParameterSet const &pset, InputSourceDescription const &desc)
 
virtual ~VectorInputSource ()
 
- Public Member Functions inherited from edm::EDInputSource
InputFileCatalogcatalog (int n=0)
 
 EDInputSource (ParameterSet const &pset, InputSourceDescription const &desc)
 
std::vector< FileCatalogItem >
const & 
fileCatalogItems (int n=0) const
 
std::vector< std::string > const & fileNames (int n=0) const
 
std::vector< std::string > const & logicalFileNames (int n=0) const
 
virtual ~EDInputSource ()
 
- Public Member Functions inherited from edm::InputSource
boost::shared_ptr
< ActivityRegistry
actReg () const
 Accessor for Activity Registry. More...
 
boost::shared_ptr
< BranchIDListHelper
branchIDListHelper () const
 Accessor for branchIDListHelper. More...
 
void closeFile (FileBlock *, bool cleaningUpAfterException)
 close current file More...
 
void doBeginJob ()
 Called by framework at beginning of job. More...
 
void doBeginLumi (LuminosityBlockPrincipal &lbp, ProcessContext const *)
 Called by framework at beginning of lumi block. More...
 
void doBeginRun (RunPrincipal &rp, ProcessContext const *)
 Called by framework at beginning of run. More...
 
void doEndJob ()
 Called by framework at end of job. More...
 
void doEndLumi (LuminosityBlockPrincipal &lbp, bool cleaningUpAfterException, ProcessContext const *)
 Called by framework at end of lumi block. More...
 
void doEndRun (RunPrincipal &rp, bool cleaningUpAfterException, ProcessContext const *)
 Called by framework at end of run. More...
 
void doPostForkReacquireResources (boost::shared_ptr< multicore::MessageReceiverForSource >)
 
void doPreForkReleaseResources ()
 Called by the framework before forking the process. More...
 
ProcessingController::ForwardState forwardState () const
 
bool goToEvent (EventID const &eventID)
 
 InputSource (ParameterSet const &, InputSourceDescription const &)
 Constructor. More...
 
 InputSource (InputSource const &)=delete
 
void issueReports (EventID const &eventID)
 issue an event report More...
 
LuminosityBlockNumber_t luminosityBlock () const
 Accessor for current luminosity block number. More...
 
boost::shared_ptr
< LuminosityBlockAuxiliary
luminosityBlockAuxiliary () const
 Called by the framework to merge or insert lumi in principal cache. More...
 
int maxEvents () const
 
int maxLuminosityBlocks () const
 
ModuleDescription const & moduleDescription () const
 Accessor for 'module' description. More...
 
ItemType nextItemType ()
 Advances the source to the next item. More...
 
InputSourceoperator= (InputSource const &)=delete
 
bool primary () const
 Accessor for primary input source flag. More...
 
ProcessConfiguration const & processConfiguration () const
 Accessor for Process Configuration. More...
 
std::string const & processGUID () const
 Accessor for global process identifier. More...
 
ProcessHistoryRegistry const & processHistoryRegistry () const
 Const accessor for process history registry. More...
 
ProcessHistoryRegistryprocessHistoryRegistryForUpdate ()
 Non-const accessor for process history registry. More...
 
ProcessingMode processingMode () const
 RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...
 
boost::shared_ptr
< ProductRegistry const > 
productRegistry () const
 Accessor for product registry. More...
 
bool randomAccess () const
 
void readAndMergeLumi (LuminosityBlockPrincipal &lbp)
 Read next luminosity block (same as a prior lumi) More...
 
void readAndMergeRun (RunPrincipal &rp)
 Read next run (same as a prior run) More...
 
void readEvent (EventPrincipal &ep, StreamContext &)
 Read next event. More...
 
bool readEvent (EventPrincipal &ep, EventID const &, StreamContext &)
 Read a specific event. More...
 
std::unique_ptr< FileBlockreadFile ()
 Read next file. More...
 
void readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
 Read next luminosity block (new lumi) More...
 
boost::shared_ptr
< LuminosityBlockAuxiliary
readLuminosityBlockAuxiliary ()
 Read next luminosity block Auxilary. More...
 
void readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
 Read next run (new run) More...
 
boost::shared_ptr< RunAuxiliaryreadRunAuxiliary ()
 Read next run Auxiliary. More...
 
ProcessHistoryID const & reducedProcessHistoryID () const
 
void registerProducts ()
 Register any produced products. More...
 
int remainingEvents () const
 
int remainingLuminosityBlocks () const
 
void repeat ()
 Reset the remaining number of events/lumis to the maximum number. More...
 
SharedResourcesAcquirerresourceSharedWithDelayedReader () const
 Returns nullptr if no resource shared between the Source and a DelayedReader. More...
 
ProcessingController::ReverseState reverseState () const
 
void rewind ()
 Begin again at the first event. More...
 
RunNumber_t run () const
 Accessor for current run number. More...
 
boost::shared_ptr< RunAuxiliaryrunAuxiliary () const
 Called by the framework to merge or insert run in principal cache. More...
 
void setLuminosityBlockNumber_t (LuminosityBlockNumber_t lb)
 Set the luminosity block ID. More...
 
void setRunNumber (RunNumber_t r)
 Set the run number. More...
 
void skipEvents (int offset)
 
bool skipForForking ()
 
Timestamp const & timestamp () const
 Accessor for the current time, as seen by the input source. More...
 
virtual ~InputSource ()
 Destructor. More...
 

Private Member Functions

void clearEventPrincipal (EventPrincipal &cache)
 
virtual void dropUnwantedBranches_ (std::vector< std::string > const &wantedBranches)=0
 
virtual void readOneRandom (EventPrincipal &cache, CLHEP::HepRandomEngine *)=0
 
virtual bool readOneRandomWithID (EventPrincipal &cache, LuminosityBlockID const &id, CLHEP::HepRandomEngine *)=0
 
virtual bool readOneSequential (EventPrincipal &cache)=0
 
virtual bool readOneSequentialWithID (EventPrincipal &cache, LuminosityBlockID const &id)=0
 
virtual void readOneSpecified (EventPrincipal &cache, EventID const &event)=0
 

Additional Inherited Members

- Public Types inherited from edm::InputSource
enum  ItemType {
  IsInvalid, IsStop, IsFile, IsRun,
  IsLumi, IsEvent, IsRepeat, IsSynchronize
}
 
enum  ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
 
typedef
ProductRegistryHelper::TypeLabelList 
TypeLabelList
 
- Static Public Member Functions inherited from edm::EDInputSource
static void fillDescription (ParameterSetDescription &desc)
 
- Static Public Member Functions inherited from edm::InputSource
static const std::string & baseType ()
 
static void fillDescription (ParameterSetDescription &desc)
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &)
 
- Protected Member Functions inherited from edm::InputSource
void decreaseRemainingEventsBy (int iSkipped)
 
bool eventCached () const
 
boost::shared_ptr
< LuminosityBlockPrincipal >
const 
luminosityBlockPrincipal () const
 
bool newLumi () const
 
bool newRun () const
 
ProcessHistoryRegistryprocessHistoryRegistryUpdate () const
 
ProductRegistryproductRegistryUpdate () const
 
void reset () const
 
void resetEventCached ()
 
void resetLuminosityBlockAuxiliary (bool isNewLumi=true) const
 
void resetNewLumi ()
 
void resetNewRun ()
 
void resetRunAuxiliary (bool isNewRun=true) const
 
boost::shared_ptr
< RunPrincipal > const 
runPrincipal () const
 
void setEventCached ()
 Called by the framework to merge or ached() const {return eventCached_;}. More...
 
void setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)
 
void setNewLumi ()
 
void setNewRun ()
 
void setRunAuxiliary (RunAuxiliary *rp)
 
void setTimestamp (Timestamp const &theTime)
 To set the current time, as seen by the input source. More...
 
virtual void skip (int offset)
 
ItemType state () const
 

Detailed Description

Definition at line 23 of file VectorInputSource.h.

Constructor & Destructor Documentation

edm::VectorInputSource::VectorInputSource ( ParameterSet const &  pset,
InputSourceDescription const &  desc 
)
explicit

Definition at line 8 of file VectorInputSource.cc.

8  :
9  EDInputSource(pset, desc) {}
EDInputSource(ParameterSet const &pset, InputSourceDescription const &desc)
edm::VectorInputSource::~VectorInputSource ( )
virtual

Definition at line 11 of file VectorInputSource.cc.

11 {}

Member Function Documentation

void edm::VectorInputSource::clearEventPrincipal ( EventPrincipal cache)
private

Definition at line 19 of file VectorInputSource.cc.

References edm::EventPrincipal::clearEventPrincipal().

Referenced by loopRandom(), loopRandomWithID(), loopSequential(), loopSequentialWithID(), and loopSpecified().

19  {
20  cache.clearEventPrincipal();
21  }
void edm::VectorInputSource::dropUnwantedBranches ( std::vector< std::string > const &  wantedBranches)

Definition at line 14 of file VectorInputSource.cc.

References dropUnwantedBranches_().

14  {
15  this->dropUnwantedBranches_(wantedBranches);
16  }
virtual void dropUnwantedBranches_(std::vector< std::string > const &wantedBranches)=0
virtual void edm::VectorInputSource::dropUnwantedBranches_ ( std::vector< std::string > const &  wantedBranches)
privatepure virtual

Implemented in edm::PoolSource.

Referenced by dropUnwantedBranches().

template<typename T >
size_t edm::VectorInputSource::loopRandom ( EventPrincipal cache,
size_t  number,
T  eventOperator,
CLHEP::HepRandomEngine *  engine 
)

Definition at line 54 of file VectorInputSource.h.

References clearEventPrincipal(), i, contentValuesFiles::number, and readOneRandom().

54  {
55  size_t i = 0U;
56  for(; i < number; ++i) {
57  clearEventPrincipal(cache);
58  readOneRandom(cache, engine);
59  eventOperator(cache);
60  }
61  return i;
62  }
int i
Definition: DBlmapReader.cc:9
void clearEventPrincipal(EventPrincipal &cache)
virtual void readOneRandom(EventPrincipal &cache, CLHEP::HepRandomEngine *)=0
template<typename T >
size_t edm::VectorInputSource::loopRandomWithID ( EventPrincipal cache,
LuminosityBlockID const &  id,
size_t  number,
T  eventOperator,
CLHEP::HepRandomEngine *  engine 
)

Definition at line 77 of file VectorInputSource.h.

References clearEventPrincipal(), newFWLiteAna::found, i, contentValuesFiles::number, and readOneRandomWithID().

77  {
78  size_t i = 0U;
79  for(; i < number; ++i) {
80  clearEventPrincipal(cache);
81  bool found = readOneRandomWithID(cache, id, engine);
82  if(!found) break;
83  eventOperator(cache);
84  }
85  return i;
86  }
int i
Definition: DBlmapReader.cc:9
virtual bool readOneRandomWithID(EventPrincipal &cache, LuminosityBlockID const &id, CLHEP::HepRandomEngine *)=0
void clearEventPrincipal(EventPrincipal &cache)
template<typename T >
size_t edm::VectorInputSource::loopSequential ( EventPrincipal cache,
size_t  number,
T  eventOperator 
)

Definition at line 65 of file VectorInputSource.h.

References clearEventPrincipal(), newFWLiteAna::found, i, contentValuesFiles::number, and readOneSequential().

65  {
66  size_t i = 0U;
67  for(; i < number; ++i) {
68  clearEventPrincipal(cache);
69  bool found = readOneSequential(cache);
70  if(!found) break;
71  eventOperator(cache);
72  }
73  return i;
74  }
int i
Definition: DBlmapReader.cc:9
void clearEventPrincipal(EventPrincipal &cache)
virtual bool readOneSequential(EventPrincipal &cache)=0
template<typename T >
size_t edm::VectorInputSource::loopSequentialWithID ( EventPrincipal cache,
LuminosityBlockID const &  id,
size_t  number,
T  eventOperator 
)

Definition at line 89 of file VectorInputSource.h.

References clearEventPrincipal(), newFWLiteAna::found, i, contentValuesFiles::number, and readOneSequentialWithID().

89  {
90  size_t i = 0U;
91  for(; i < number; ++i) {
92  clearEventPrincipal(cache);
93  bool found = readOneSequentialWithID(cache, id);
94  if(!found) break;
95  eventOperator(cache);
96  }
97  return i;
98  }
int i
Definition: DBlmapReader.cc:9
void clearEventPrincipal(EventPrincipal &cache)
virtual bool readOneSequentialWithID(EventPrincipal &cache, LuminosityBlockID const &id)=0
template<typename T , typename Collection >
size_t edm::VectorInputSource::loopSpecified ( EventPrincipal cache,
Collection const &  events,
T  eventOperator 
)

Definition at line 101 of file VectorInputSource.h.

References clearEventPrincipal(), i, and readOneSpecified().

101  {
102  size_t i = 0U;
103  for(typename Collection::const_iterator it = events.begin(), itEnd = events.end(); it != itEnd; ++it) {
104  clearEventPrincipal(cache);
105  readOneSpecified(cache, *it);
106  eventOperator(cache);
107  ++i;
108  }
109  return i;
110  }
int i
Definition: DBlmapReader.cc:9
void clearEventPrincipal(EventPrincipal &cache)
virtual void readOneSpecified(EventPrincipal &cache, EventID const &event)=0
tuple events
Definition: patZpeak.py:19
virtual void edm::VectorInputSource::readOneRandom ( EventPrincipal cache,
CLHEP::HepRandomEngine *   
)
privatepure virtual

Implemented in edm::PoolSource.

Referenced by loopRandom().

virtual bool edm::VectorInputSource::readOneRandomWithID ( EventPrincipal cache,
LuminosityBlockID const &  id,
CLHEP::HepRandomEngine *   
)
privatepure virtual

Implemented in edm::PoolSource.

Referenced by loopRandomWithID().

virtual bool edm::VectorInputSource::readOneSequential ( EventPrincipal cache)
privatepure virtual

Implemented in edm::PoolSource.

Referenced by loopSequential().

virtual bool edm::VectorInputSource::readOneSequentialWithID ( EventPrincipal cache,
LuminosityBlockID const &  id 
)
privatepure virtual

Implemented in edm::PoolSource.

Referenced by loopSequentialWithID().

virtual void edm::VectorInputSource::readOneSpecified ( EventPrincipal cache,
EventID const &  event 
)
privatepure virtual

Implemented in edm::PoolSource.

Referenced by loopSpecified().