marlin::StdHepReader Class Reference

Reads binary StdHep files. More...

#include <StdHepReader.h>

Inheritance diagram for marlin::StdHepReader:

Public Member Functions
virtual StdHepReader *	newProcessor ()
	Return a new instance of the processor. More...
virtual void	readDataSource (int numEvents)
	Creates events with MCParticle collections from the StdHep input file and calls all active processors' processEvent() and processRunHeader Method.
virtual void	init ()
	Called at the begin of the job before anything is read. More...
virtual void	end ()
	Called after data processing for clean up in the inverse order of the init() method so that resources allocated in the first processor also will be available for all following processors.
Public Member Functions inherited from marlin::DataSourceProcessor
	DataSourceProcessor (const std::string &typeName)
Public Member Functions inherited from marlin::Processor
	Processor (const std::string &typeName)
	Possible verbosity levels. More...
virtual	~Processor ()
	Destructor.
virtual void	processRunHeader (LCRunHeader *)
	Called for every run, e.g. More...
virtual void	processEvent (LCEvent *)
	Called for every event - the working horse.
virtual void	check (LCEvent *)
	Called for every event - right after processEvent() has been called for this processor. 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 std::shared_ptr < 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. More...
std::string	getLCIOInType (const std::string &colName)
	Return the LCIO input type for the collection colName - empty string if colName is not a registered collection name.
std::string	getLCIOOutType (const std::string &colName)
	Return the LCIO output type for the collection colName - empty string if colName is not a registered collection name.
bool	isInputCollectionName (const std::string &parameterName)
	True if the given parameter defines an LCIO input collection, i.e. More...
bool	isOutputCollectionName (const std::string &parameterName)
	True if the given parameter defines an LCIO output collection.
virtual void	setParameters (std::shared_ptr< StringParameters > parameters)
	Helper function returns the ProcessorParameter for the given name. More...
virtual void	setName (const std::string &processorName)
	Set processor name.

Protected Attributes
std::string	_fileName
Protected Attributes inherited from marlin::Processor
std::string	_description =""
	Describes what the processor does. More...
std::string	_typeName =""
std::string	_processorName =""
std::shared_ptr< StringParameters >	_parameters {}
ProcParamMap	_map {}
bool	_isFirstEvent = false
LCIOTypeMap	_inTypeMap {}
LCIOTypeMap	_outTypeMap {}
std::string	_logLevelName {}

Additional Inherited Members
Protected Member Functions inherited from marlin::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() The value can be used in a condition in the steering file referred to by ProcessorName.name of the processor.
template<class T >
void	registerProcessorParameter (const std::string &parameterName, const std::string &parameterDescription, T &parameter, const T &defaultVal, int setSize=0)
	Register a steering variable for this processor - call in constructor of processor. More...
void	registerInputCollection (const std::string &collectionType, const std::string &parameterName, const std::string &parameterDescription, std::string &parameter, const std::string &defaultVal, int setSize=0)
	Specialization of registerProcessorParameter() for a parameter that defines an input collection - can be used fo checking the consistency of the steering file.
void	registerOutputCollection (const std::string &collectionType, const std::string &parameterName, const std::string &parameterDescription, std::string &parameter, const std::string &defaultVal, int setSize=0)
	Specialization of registerProcessorParameter() for a parameter that defines an output collection - can be used fo checking the consistency of the steering file.
void	registerInputCollections (const std::string &collectionType, const std::string &parameterName, const std::string &parameterDescription, StringVec &parameter, const StringVec &defaultVal, int setSize=0)
	Specialization of registerProcessorParameter() for a parameter that defines one or several input collections - can be used fo checking the consistency of the steering file.
template<class T >
void	registerOptionalParameter (const std::string &parameterName, const std::string &parameterDescription, 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.
void	checkForExistingParameter (const std::string &parameterName)
	Tests whether the parameter has been registered before. More...
template<class T >
void	message (const std::string &m) const
	Print message according to verbosity level of the templated parameter (one of DEBUG, MESSAGE, WARNING, ERROR ) and the global parameter "Verbosity". More...
template<class T >
void	message (const std::basic_ostream< char, std::char_traits< char > > &m) const
	Same as message(const std::string& message) except that it allows the output of more complex messages in the argument using the log() method, e.g. More...
std::stringstream &	log () const
	Returns an empty stringstream that is used by the message method. More...

Detailed Description

Reads binary StdHep files.

Example processor for reading non-LCIO input files - creates events with MCParticle collections from binary StdHep files. Has to be the first active processor and requires that no LCIO input collection is used (parameter LCIOInputFiles).

Input - Prerequisites

StdHep file.

Output

LCEvent with MCParticle collection.

Parameters

StdHepFileName

name of input file

Author

F. Gaede, DESY

Version

Id:

StdHepReader.h,v 1.3 2005-10-11 12:56:28 gaede Exp

Member Function Documentation

void marlin::StdHepReader::init ( )

virtual

Called at the begin of the job before anything is read.

Use to initialize the processor, e.g. book histograms.

Reimplemented from marlin::Processor.

StdHepReader * marlin::StdHepReader::newProcessor ( )

virtual

Return a new instance of the processor.

Has to be implemented by subclasses.

Implements marlin::Processor.

---

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

• StdHepReader.h
• StdHepReader.cc