marlin::DataSourceProcessor Class Reference

#include <DataSourceProcessor.h>

Inheritance diagram for marlin::DataSourceProcessor:

List of all members.


Public Member Functions
	DataSourceProcessor (const std::string &typeName)
virtual void	readDataSource (int numEvents)=0
virtual Processor *	newProcessor ()=0
virtual void	init ()
virtual void	processRunHeader (LCRunHeader *)
virtual void	processEvent (LCEvent *)
virtual void	check (LCEvent *)
virtual void	end ()
virtual const std::string &	type () const
virtual const std::string &	name () const
virtual StringParameters *	parameters ()
virtual void	printDescription ()
virtual void	printDescriptionXML (std::ostream &stream=std::cout)
virtual void	printParameters ()
const std::string &	description ()
bool	isFirstEvent ()
std::string	getLCIOInType (const std::string &colName)
std::string	getLCIOOutType (const std::string &colName)
bool	isInputCollectionName (const std::string &parameterName)
bool	isOutputCollectionName (const std::string &parameterName)
Protected Member Functions
void	setReturnValue (bool val)
void	setReturnValue (const std::string &name, bool val)
template<class T>
void	registerProcessorParameter (const std::string &name, const std::string &description, T &parameter, const T &defaultVal, int setSize=0)
void	registerInputCollection (const std::string &type, const std::string &name, const std::string &description, std::string &parameter, const std::string &defaultVal, int setSize=0)
void	registerOutputCollection (const std::string &type, const std::string &name, const std::string &description, std::string &parameter, const std::string &defaultVal, int setSize=0)
void	registerInputCollections (const std::string &type, const std::string &name, const std::string &description, StringVec &parameter, const StringVec &defaultVal, int setSize=0)
template<class T>
void	registerOptionalParameter (const std::string &name, const std::string &description, T &parameter, const T &defaultVal, int setSize=0)
bool	parameterSet (const std::string &name)
Protected Attributes
std::string	_description
std::string	_typeName
std::string	_processorName
StringParameters *	_parameters
ProcParamMap	_map
bool	_isFirstEvent
LCIOTypeMap	_inTypeMap
LCIOTypeMap	_outTypeMap

Detailed Description

Base class for data source handlers that can read arbitrary non-LCIO input files and create LCIO events and run headers from that. If a user subclass is defined as active processor in the steering file _and_ there are no LCIO input files defined than this class is called to generate the LCIO data stream.

Author:: F. Gaede, DESY

Version:

Id: DataSourceProcessor.h,v 1.3 2005/10/11 12:56:28 gaede Exp

Definition at line 20 of file DataSourceProcessor.h.

Constructor & Destructor Documentation

marlin::DataSourceProcessor::DataSourceProcessor ( const std::string & typeName )

Definition at line 10 of file DataSourceProcessor.cc.

Member Function Documentation

virtual void marlin::Processor::check ( LCEvent * ) [inline, virtual, inherited]

Called for every event - right after processEvent() has been called for all processors. Use to check processing and/or produce check plots.
Reimplemented in marlin::SimpleFastMCProcessor, and marlin::TestProcessor.
Definition at line 89 of file Processor.h.

const std::string& marlin::Processor::description ( ) [inline, inherited]

Description of processor.
Definition at line 126 of file Processor.h.
Referenced by marlin::CMProcessor::CMProcessor(), marlin::Processor::printDescription(), and marlin::Processor::printDescriptionXML().

virtual void marlin::Processor::end ( ) [inline, virtual, inherited]

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.
Reimplemented in tpc_tracking::CustomMarlinProcessor, marlin::LCIOOutputProcessor, marlin::SimpleFastMCProcessor, marlin::StdHepReader, marlin::TestProcessor, and tpc_tracking::CustomMarlinProcessor.
Definition at line 96 of file Processor.h.
Referenced by marlin::CCProcessor::clearParameters(), marlin::ProcessorMgr::dumpRegisteredProcessors(), marlin::ProcessorMgr::dumpRegisteredProcessorsXML(), marlin::ProcessorMgr::getAvailableProcessorTypes(), marlin::XMLFixCollTypes::parse(), and marlin::ProcessorMgr::readDataSource().

std::string marlin::Processor::getLCIOInType ( const std::string & colName ) [inherited]

Return the LCIO input type for the collection colName - empty string if colName is not a registered collection name
Definition at line 231 of file Processor.cc.
References marlin::Processor::_inTypeMap, and marlin::Processor::isInputCollectionName().
Referenced by marlin::CCProcessor::addColsFromParam(), and marlin::XMLFixCollTypes::parse().

std::string marlin::Processor::getLCIOOutType ( const std::string & colName ) [inherited]

Return the LCIO output type for the collection colName - empty string if colName is not a registered collection name
Definition at line 240 of file Processor.cc.
References marlin::Processor::_outTypeMap, and marlin::Processor::isOutputCollectionName().
Referenced by marlin::CCProcessor::addColsFromParam(), and marlin::XMLFixCollTypes::parse().

virtual void marlin::Processor::init ( ) [inline, virtual, inherited]

Called at the begin of the job before anything is read. Use to initialize the processor, e.g. book histograms.
Reimplemented in tpc_tracking::CustomMarlinProcessor, tpc_tracking::LoadPadGeometryProcessor, LoadSettingsProcessor, marlin::LCIOOutputProcessor, marlin::SimpleFastMCProcessor, marlin::StdHepReader, marlin::TestProcessor, tpc_tracking::CustomMarlinProcessor, tpc_tracking::LoadPadGeometryProcessor, and LoadSettingsProcessor.
Definition at line 74 of file Processor.h.
Referenced by marlin::Processor::baseInit().

bool marlin::Processor::isFirstEvent ( ) [inline, inherited]

True if first event in processEvent(evt) - use this e.g. to initialize histograms etc.
Definition at line 131 of file Processor.h.
Referenced by marlin::SimpleFastMCProcessor::check(), and marlin::StdHepReader::readDataSource().

bool marlin::Processor::isInputCollectionName ( const std::string & parameterName ) [inherited]

True if the given parameter defines an LCIO input collection, i.e. the type has been defined with setLCIOInType().
Definition at line 249 of file Processor.cc.
References marlin::Processor::_inTypeMap.
Referenced by marlin::CCProcessor::addColsFromParam(), marlin::Processor::getLCIOInType(), marlin::XMLFixCollTypes::parse(), and marlin::Processor::printDescriptionXML().

bool marlin::Processor::isOutputCollectionName ( const std::string & parameterName ) [inherited]

True if the given parameter defines an LCIO output collection
Definition at line 257 of file Processor.cc.
References marlin::Processor::_outTypeMap.
Referenced by marlin::CCProcessor::addColsFromParam(), marlin::Processor::getLCIOOutType(), marlin::XMLFixCollTypes::parse(), and marlin::Processor::printDescriptionXML().

virtual const std::string& marlin::Processor::name ( ) const [inline, virtual, inherited]

Return name of this processor.
Definition at line 105 of file Processor.h.
Referenced by marlin::TestProcessor::check(), marlin::TestProcessor::end(), marlin::SimpleFastMCProcessor::end(), marlin::LCIOOutputProcessor::end(), marlin::TestProcessor::init(), marlin::Processor::printDescriptionXML(), marlin::Processor::printParameters(), marlin::TestProcessor::processEvent(), marlin::TestProcessor::processRunHeader(), marlin::ProcessorMgr::setProcessorReturnValue(), marlin::SkipEventException::SkipEventException(), and marlin::StopProcessingException::StopProcessingException().

virtual Processor* marlin::Processor::newProcessor ( ) [pure virtual, inherited]

Return a new instance of the processor. Has to be implemented by subclasses.
Implemented in marlin::LCIOOutputProcessor, marlin::SimpleFastMCProcessor, marlin::StdHepReader, and marlin::TestProcessor.
Referenced by marlin::ProcessorMgr::addActiveProcessor(), and marlin::CMProcessor::CMProcessor().

virtual StringParameters* marlin::Processor::parameters ( ) [inline, virtual, inherited]

Return parameters defined for this Processor.
Definition at line 109 of file Processor.h.
Referenced by marlin::TestProcessor::init().

bool marlin::Processor::parameterSet ( const std::string & name ) [protected, inherited]

Tests whether the parameter has been set in the steering file
Definition at line 194 of file Processor.cc.
References marlin::Processor::_map, and marlin::ProcessorParameter::valueSet().
Referenced by marlin::LCIOOutputProcessor::dropCollections(), and marlin::LCIOOutputProcessor::init().

void marlin::Processor::printDescription ( ) [virtual, inherited]

Print information about this processor in ASCII steering file format.
Definition at line 75 of file Processor.cc.
References marlin::Processor::_map, marlin::ProcessorParameter::defaultValue(), marlin::ProcessorParameter::description(), marlin::Processor::description(), marlin::ProcessorParameter::isOptional(), marlin::ProcessorParameter::name(), marlin::ProcessorParameter::type(), and marlin::Processor::type().
Referenced by marlin::ProcessorMgr::dumpRegisteredProcessors().

void marlin::Processor::printParameters ( ) [virtual, inherited]

Print the parameters and its values.
Definition at line 53 of file Processor.cc.
References marlin::Processor::_map, and marlin::Processor::name().
Referenced by marlin::StdHepReader::init(), marlin::SimpleFastMCProcessor::init(), and marlin::LCIOOutputProcessor::init().

virtual void marlin::Processor::processEvent ( LCEvent * ) [inline, virtual, inherited]

Called for every event - the working horse.
Reimplemented in marlin::LCIOOutputProcessor, marlin::SimpleFastMCProcessor, and marlin::TestProcessor.
Definition at line 83 of file Processor.h.

virtual void marlin::Processor::processRunHeader ( LCRunHeader * ) [inline, virtual, inherited]

Called for every run, e.g. overwrite to initialize run dependent histograms.
Reimplemented in marlin::LCIOOutputProcessor, marlin::SimpleFastMCProcessor, and marlin::TestProcessor.
Definition at line 79 of file Processor.h.

virtual void marlin::DataSourceProcessor::readDataSource ( int numEvents ) [pure virtual]

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.

Implemented in marlin::StdHepReader.
Referenced by marlin::ProcessorMgr::readDataSource().

void marlin::Processor::registerInputCollection ( const std::string & type,

const std::string & name,

const std::string & description,

std::string & parameter,

const std::string & defaultVal,

int setSize = 0

) [inline, protected, inherited]

Specialization of registerProcessorParameter() for a parameter that defines an input collection - can be used fo checking the consistency of the steering file.
Definition at line 195 of file Processor.h.
Referenced by marlin::SimpleFastMCProcessor::SimpleFastMCProcessor().

void marlin::Processor::registerInputCollections ( const std::string & type,

const std::string & name,

const std::string & description,

StringVec & parameter,

const StringVec & defaultVal,

int setSize = 0

) [inline, protected, inherited]

Specialization of registerProcessorParameter() for a parameter that defines one or several input collections - can be used fo checking the consistency of the steering file.
Definition at line 223 of file Processor.h.

template<class T>

void marlin::Processor::registerOptionalParameter ( const std::string & name,

const std::string & description,

T & parameter,

const T & defaultVal,

int setSize = 0

) [inline, protected, inherited]

Same as registerProcessorParameter except that the parameter is optional. The value of the parameter will still be set to the default value, which is used to print an example steering line. Use parameterSet() to check whether it actually has been set in the steering file.
Definition at line 241 of file Processor.h.
Referenced by marlin::LCIOOutputProcessor::LCIOOutputProcessor().

void marlin::Processor::registerOutputCollection ( const std::string & type,

const std::string & name,

const std::string & description,

std::string & parameter,

const std::string & defaultVal,

int setSize = 0

) [inline, protected, inherited]

Specialization of registerProcessorParameter() for a parameter that defines an output collection - can be used fo checking the consistency of the steering file.
Definition at line 209 of file Processor.h.

template<class T>

void marlin::Processor::registerProcessorParameter ( const std::string & name,

const std::string & description,

T & parameter,

const T & defaultVal,

int setSize = 0

) [inline, protected, inherited]

Register a steering variable for this processor - call in constructor of processor. The default value has to be of the _same_ type as the parameter, e.g.
float _cut ;
...
registerProcessorParameter( "Cut", "cut...", _cut , float( 3.141592 ) ) ;
as implicit conversions don't work for templates.
The optional parameter setSize is used for formating the printout of parameters. This can be used if the parameter values are expected to come in sets of fixed size.
Definition at line 181 of file Processor.h.
Referenced by LoadSettingsProcessor::construct(), tpc_tracking::LoadPadGeometryProcessor::construct(), marlin::LCIOOutputProcessor::LCIOOutputProcessor(), marlin::SimpleFastMCProcessor::SimpleFastMCProcessor(), and marlin::StdHepReader::StdHepReader().

void marlin::Processor::setReturnValue ( const std::string & name,

bool val

) [protected, inherited]

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.
Definition at line 261 of file Processor.cc.

void marlin::Processor::setReturnValue ( bool val ) [protected, inherited]

Set the 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 the name of the processor.
Definition at line 222 of file Processor.cc.
Referenced by marlin::TestProcessor::processEvent().

virtual const std::string& marlin::Processor::type ( ) const [inline, virtual, inherited]

Return type name for the processor (as set in constructor).
Definition at line 101 of file Processor.h.
Referenced by marlin::Processor::printDescription(), marlin::Processor::printDescriptionXML(), and marlin::ProcessorMgr::registerProcessor().

Member Data Documentation

std::string marlin::Processor::_description [protected, inherited]

Describes what the processor does. Set in constructor.
Definition at line 306 of file Processor.h.