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...
void	closeFile (boost::shared_ptr< FileBlock >, bool cleaningUpAfterException)
	close current file More...
void	doBeginJob ()
	Called by framework at beginning of job. More...
void	doBeginLumi (LuminosityBlockPrincipal &lbp)
	Called by framework at beginning of lumi block. More...
void	doBeginRun (RunPrincipal &rp)
	Called by framework at beginning of run. More...
void	doEndJob ()
	Called by framework at end of job. More...
void	doEndLumi (LuminosityBlockPrincipal &lbp, bool cleaningUpAfterException)
	Called by framework at end of lumi block. More...
void	doEndRun (RunPrincipal &rp, bool cleaningUpAfterException)
	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...
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	markLumi ()
	Mark lumi as read. More...
int	markRun ()
	Mark run as read. More...
int	maxEvents () const
int	maxLuminosityBlocks () const
ModuleDescription const &	moduleDescription () const
	Accessor for 'module' description. More...
ItemType	nextItemType ()
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...
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	readAndCacheLumi (bool merge, HistoryAppender &historyAppender)
	Read next luminosity block. More...
void	readAndCacheRun (bool merge, HistoryAppender &historyAppender)
	Read next run. More...
EventPrincipal *	readEvent (boost::shared_ptr< LuminosityBlockPrincipal > lbCache)
EventPrincipal *	readEvent (EventID const &)
	Read a specific event. More...
boost::shared_ptr< FileBlock >	readFile ()
	Read next file. More...
boost::shared_ptr < LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary ()
	Read next luminosity block Auxilary. 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...
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)
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 Member Functions
virtual void	setLumi (LuminosityBlockNumber_t lb)
virtual void	setRun (RunNumber_t)

Private Attributes
InputFileCatalog	catalog_
InputFileCatalog	secondaryCatalog_

Additional Inherited Members
Public Types inherited from edm::InputSource
enum	ItemType {   IsInvalid, IsStop, IsFile, IsRun,   IsLumi, IsEvent, IsRepeat }
enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Protected Member Functions inherited from edm::InputSource
void	decreaseRemainingEventsBy (int iSkipped)
EventPrincipal *	eventPrincipalCache ()
boost::shared_ptr < LuminosityBlockPrincipal > const	luminosityBlockPrincipal () const
PrincipalCache const &	principalCache () const
PrincipalCache &	principalCache ()
ProductRegistry &	productRegistryUpdate () const
void	reset () const
void	resetLuminosityBlockAuxiliary () const
void	resetRunAuxiliary () const
boost::shared_ptr < RunPrincipal > const	runPrincipal () const
void	setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)
void	setRunAuxiliary (RunAuxiliary *rp)
void	setTimestamp (Timestamp const &theTime)
	To set the current time, as seen by the input source. More...
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 47 of file EDInputSource.cc.

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

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();
    }

void edm::EDInputSource::setLumi ( LuminosityBlockNumber_t  lb )

privatevirtual

Reimplemented from edm::InputSource.

Definition at line 40 of file EDInputSource.cc.

                                                {
      LogWarning("IllegalCall")
        << "EDInputSource::setLumi()\n"
        << "Luminosity Block ID cannot be modified for an EDInputSource\n";
  }

void edm::EDInputSource::setRun ( RunNumber_t  )

privatevirtual

Reimplemented from edm::InputSource.

Definition at line 33 of file EDInputSource.cc.

                                   {
      LogWarning("IllegalCall")
        << "EDInputSource::setRun()\n"
        << "Run number cannot be modified for an EDInputSource\n";
  }

Member Data Documentation

InputFileCatalog edm::EDInputSource::catalog_

private

Definition at line 41 of file EDInputSource.h.

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

InputFileCatalog edm::EDInputSource::secondaryCatalog_

private

Definition at line 42 of file EDInputSource.h.

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