Simple processor for testing. More...

#include <TestProcessor.h>

Inheritance diagram for marlin::TestProcessor:

Public Member Functions
virtual Processor *	newProcessor ()
	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	processRunHeader (LCRunHeader *run)
	Called for every run.

virtual void	processEvent (LCEvent *evt)
	Called for every event - the working horse.

virtual void	check (LCEvent *evt)
	Called for every event - right after processEvent() has been called for this processor. More...

virtual void	end ()
	Called after data processing for clean up.

Public Member Functions inherited from marlin::Processor
	Processor (const std::string &typeName)
	Possible verbosity levels. More...

virtual	~Processor ()
	Destructor.

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 Member Functions
void	printEndMessage () const
	Test method for const. More...

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...

Protected Attributes
int	_nRun

int	_nEvt

bool	_doCalibration

int	_nLoops

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 {}

Detailed Description

Simple processor for testing.

Writes something to stdout for every callbackmethod.

Input - Prerequisites

none

Output

none

Author: F. Gaede, DESY

Version

Id:: TestProcessor.h,v 1.7 2007-05-23 13:12:21 gaede Exp

Member Function Documentation

void marlin::TestProcessor::check ( LCEvent * )

virtual

Called for every event - right after processEvent() has been called for this processor.

Use to check processing and/or produce check plots.

Reimplemented from marlin::Processor.

void marlin::TestProcessor::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.

References marlin::Processor::name(), and marlin::Processor::parameters().

virtual Processor* marlin::TestProcessor::newProcessor ( )

inlinevirtual

Return a new instance of the processor.

Has to be implemented by subclasses.

Implements marlin::Processor.

void marlin::TestProcessor::printEndMessage ( ) const

protected

Test method for const.

Referenced by end().

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

TestProcessor.h
TestProcessor.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Input - Prerequisites

Output

Member Function Documentation