edm::EDInputSource Class Reference

#include <EDInputSource.h>

Inheritance diagram for edm::EDInputSource:

Public Member Functions
InputFileCatalog &	catalog (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...
InputSource &	operator= (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...
ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()
	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< FileBlock >	readFile ()
	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< RunAuxiliary >	readRunAuxiliary ()
	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...
SharedResourcesAcquirer *	resourceSharedWithDelayedReader () 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< RunAuxiliary >	runAuxiliary () 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...

Static Public Member Functions
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 &)

Private Attributes
InputFileCatalog	catalog_
InputFileCatalog	secondaryCatalog_

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
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
ProcessHistoryRegistry &	processHistoryRegistryUpdate () const
ProductRegistry &	productRegistryUpdate () 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 19 of file EDInputSource.h.

Constructor & Destructor Documentation

edm::EDInputSource::EDInputSource ( ParameterSet const &  pset, InputSourceDescription const &  desc  )

explicit

Definition at line 17 of file EDInputSource.cc.

References edm::errors::Configuration, edm::InputFileCatalog::empty(), edm::hlt::Exception, edm::ParameterSet::getUntrackedParameter(), and secondaryCatalog_.

                                                                                           :
      InputSource(pset, desc),
      catalog_(pset.getUntrackedParameter<std::vector<std::string> >("fileNames"),
        pset.getUntrackedParameter<std::string>("overrideCatalog", std::string())),
      secondaryCatalog_(pset.getUntrackedParameter<std::vector<std::string> >("secondaryFileNames", std::vector<std::string>()),
        pset.getUntrackedParameter<std::string>("overrideCatalog", std::string())) {

     if (secondaryCatalog_.empty() && pset.getUntrackedParameter<bool>("needSecondaryFileNames", false)) {
    throw Exception(errors::Configuration, "EDInputSource") << "'secondaryFileNames' must be specified\n";
     }
  }

edm::EDInputSource::~EDInputSource ( )

virtual

Definition at line 29 of file EDInputSource.cc.

                                {
  }

Member Function Documentation

InputFileCatalog& edm::EDInputSource::catalog ( int  n = 0 )

inline

Definition at line 33 of file EDInputSource.h.

References catalog_, n, and secondaryCatalog_.

{return n ? secondaryCatalog_ : catalog_;}

std::vector<FileCatalogItem> const& edm::EDInputSource::fileCatalogItems ( int  n = 0 ) const

inline

Definition at line 30 of file EDInputSource.h.

References catalog_, edm::InputFileCatalog::fileCatalogItems(), n, and secondaryCatalog_.

                                                                        {
      return n ? secondaryCatalog_.fileCatalogItems() : catalog_.fileCatalogItems();
    }

std::vector<std::string> const& edm::EDInputSource::fileNames ( int  n = 0 ) const

inline

Definition at line 27 of file EDInputSource.h.

References catalog_, edm::InputFileCatalog::fileNames(), n, and secondaryCatalog_.

                                                           {
      return n ? secondaryCatalog_.fileNames() : catalog_.fileNames();
    }

void edm::EDInputSource::fillDescription ( ParameterSetDescription &  desc )

static

Definition at line 33 of file EDInputSource.cc.

References edm::ParameterSetDescription::addUntracked(), edm::InputSource::fillDescription(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edm::PoolSource::fillDescriptions().

                                                               {
    std::vector<std::string> defaultStrings;
    desc.addUntracked<std::vector<std::string> >("fileNames")
        ->setComment("Names of files to be processed.");
    desc.addUntracked<std::vector<std::string> >("secondaryFileNames", defaultStrings)
        ->setComment("Names of secondary files to be processed.");
    desc.addUntracked<bool>("needSecondaryFileNames", false)
        ->setComment("If True, 'secondaryFileNames' must be specified and be non-empty.");
    desc.addUntracked<std::string>("overrideCatalog", std::string());
    InputSource::fillDescription(desc);
  }

std::vector<std::string> const& edm::EDInputSource::logicalFileNames ( int  n = 0 ) const

inline

Definition at line 24 of file EDInputSource.h.

References catalog_, edm::InputFileCatalog::logicalFileNames(), n, and secondaryCatalog_.

                                                                  {
      return n ? secondaryCatalog_.logicalFileNames() : catalog_.logicalFileNames();
    }

Member Data Documentation

InputFileCatalog edm::EDInputSource::catalog_

private

Definition at line 38 of file EDInputSource.h.

Referenced by catalog(), fileCatalogItems(), fileNames(), and logicalFileNames().

InputFileCatalog edm::EDInputSource::secondaryCatalog_

private

Definition at line 39 of file EDInputSource.h.

Referenced by catalog(), EDInputSource(), fileCatalogItems(), fileNames(), and logicalFileNames().