luiza::DataSourceProcessor Class Reference

Base class for processors accessing input data. More...

#include <DataSourceProcessor.h>

Inheritance diagram for luiza::DataSourceProcessor:

Public Member Functions
bool	OpenDataSource ()
Public Member Functions inherited from luiza::Processor
	Processor (const std::string &typeName)
	Default constructor. More...
virtual	~Processor ()
	Destructor.
virtual Processor *	newProcessor ()=0
	Return a new instance of the processor. More...
virtual void	init ()
	Called at the begin of the job before anything is read. More...
virtual void	startAnalysis (GloriaDataContainer *)
	Called before first data processing loop. More...
virtual void	processData (GloriaDataContainer *)
	Called for every data processing loop. More...
virtual void	check (GloriaDataContainer *)
	Called for every loop - right after processData() call. More...
virtual void	concludeAnalysis (GloriaDataContainer *)
	Called after all data processing loops. More...
virtual void	end ()
	Called after data processing is finished. More...
virtual const std::string &	type () const
	Return type name for the processor (as set in constructor).
virtual const std::string &	name () const
	Return name of this processor.
virtual const std::string &	logLevelName () const
	Return name of the local verbosity level of this processor - "" if not set.
virtual StringParameters *	parameters ()
	Return parameters defined for this Processor.
virtual void	printDescription ()
	Print information about this processor in ASCII steering file format.
virtual void	printDescriptionXML (std::ostream &stream=std::cout)
	Print information about this processor in XML steering file format.
template<class T >
void	printParameters ()
	Print the parameters and their values depending on the given verbosity level.
void	printParameters ()
	Print the parameters and their values with verbosity level MESSAGE.
const std::string &	description ()
	Description of processor.
bool	isFirstEvent ()
	True if first event in processEvent(evt) - use this e.g. to initialize histograms etc.
GloriaCollectionType	getGloriaInType (const std::string &colName)
	Return the input type for the collection colName. More...
GloriaCollectionType	getGloriaOutType (const std::string &colName)
	Return the output type for the collection colName. More...
bool	isInputCollectionName (const std::string &parameterName)
	Check if parameter defines collection. More...
bool	isOutputCollectionName (const std::string &parameterName)
	True if the given parameter defines an LCIO output collection */.

Additional Inherited Members
Protected Member Functions inherited from luiza::Processor
void	setReturnValue (bool val)
	Set the return value for this processor - typically at end of processEvent(). More...
void	setReturnValue (const std::string &name, bool val)
	Set a named return value for this processor - typically at end of processEvent() More...
template<class T >
void	registerProcessorParameter (const std::string &name, const std::string &description, T &parameter, const T &defaultVal, int setSize=0)
	Register a steering variable for this processor - call in constructor of processor. More...
void	registerInputCollection (const GloriaCollectionType &type, const std::string &name, const std::string &description, std::string &parameter, const std::string &defaultVal, int setSize=0)
	Register parameter describing input collection. More...
void	registerOutputCollection (const GloriaCollectionType &type, const std::string &name, const std::string &description, std::string &parameter, const std::string &defaultVal, int setSize=0)
	Register parameter describing output collection. More...
void	registerInputCollections (const GloriaCollectionType &type, const std::string &name, const std::string &description, StringVec &parameter, const StringVec &defaultVal, int setSize=0)
	Register parameter describing input collections. More...
template<class T >
void	registerOptionalParameter (const std::string &name, const std::string &description, T &parameter, const T &defaultVal, int setSize=0)
	Same as registerProcessorParameter except that the parameter is optional. More...
bool	parameterSet (const std::string &name)
	Tests whether the parameter has been set in the steering file.
template<class T >
void	message (const std::string &message) const
	Print message according to verbosity level. More...
template<class T >
void	message (const std::basic_ostream< char, std::char_traits< char > > &m) const
	Similar to message(const std::string& message) More...
std::stringstream &	log () const
	Returns an empty stringstream that is used by the message method.
virtual void	setProcessorParameters (StringParameters *parameters)
	Allow friend class CCProcessor to change/reset processor parameters.
virtual void	updateParameters ()
	Allow friend class CCProcessor to update processor parameters.
virtual void	updateTelescopeParameters (std::string name)
	Allow to update processor parameters for given telescope name. More...
virtual void	updateTelescopeParameters (GloriaFitsHeader *header)
	Update processor parameters based on FITS header. More...
Protected Attributes inherited from luiza::Processor
std::string	_description
	Describes what the processor does. Set in constructor.

Detailed Description

Base class for processors accessing input data.

Base class for data source handlers that can read arbitrary input files (or net) and create data collections to be processed by other processors. When all data sources are read and closed data processing finishes.

Author

A.F.Zarnecki, University of Warsaw

Member Function Documentation

bool luiza::DataSourceProcessor::OpenDataSource ( )

inline

User call back to read the data source and create the LCIO event and run header. The user needs to call ProcessMgr::processRunHeader(LCRunHeader* rhdr) and ProcessMgr::processEvent(LCEvent* evt) in order to call the relevant Processor methods in readDataSource().

Parameters

numEvents

The number of events the DataSourceProcessor should generate.

Referenced by luiza::ProcessorMgr::processData().

---

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

• DataSourceProcessor.h
• DataSourceProcessor.cc