framework::EventProcessor Class Reference

Wrapper class for fire::Processor which does the necessary modifications on the constructors and adds the old configure method. More...

#include <EventProcessor.h>

Inheritance diagram for framework::EventProcessor:

Collaboration diagram for framework::EventProcessor:

Public Member Functions
	EventProcessor (const std::string &name, framework::Process &p)
	Construct a legacy event processor. More...
virtual void	process (fire::Event &event)=0
	pass on pure virtual process function More...
virtual void	configure (config::Parameters &ps)
	Legacy configure method. More...
Public Member Functions inherited from fire::Processor
	Processor (const config::Parameters &ps)
	Configure the processor upon construction. More...
virtual	~Processor ()=default
	virtual default destructor so derived classes can be destructed
virtual void	beforeNewRun (RunHeader &header)
	Handle allowing processors to modify run headers before the run begins. More...
virtual void	onNewRun (const RunHeader &runHeader)
	Callback for the Processor to take any necessary action when the run being processed changes. More...
virtual void	onFileOpen (const std::string &file_name)
	Callback for the Processor to take any necessary action when a new input event file is opened. More...
virtual void	onFileClose (const std::string &file_name)
	Callback for the Processor to take any necessary action when a event input file is closed. More...
virtual void	onProcessStart ()
	Callback for the Processor to take any necessary action when the processing of events starts.
virtual void	onProcessEnd ()
	Callback for the Processor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.
const std::string &	getName () const
	Get the processor name.
virtual void	attach (Process *p) final
	Attach the current process to this processor. More...
template<class T >
const T &	getCondition (const std::string &condition_name)
	Access a conditions object for the current event. More...

Static Private Member Functions
static fire::config::Parameters	minimal_parameter_set (const std::string &name)
	Construct the minimal parameter set for a fire::Processor. More...

Additional Inherited Members
Protected Member Functions inherited from fire::Processor
void	setStorageHint (StorageControl::Hint hint, const std::string &purpose="") const
	Mark the current event as having the given storage control hint from this processor and the given purpose string. More...
void	abortEvent ()
	Abort the event immediately. More...
void	fatalError (const std::string &msg)
	End processing due to a fatal runtime error. More...
Protected Attributes inherited from fire::Processor
logging::logger	theLog_
	The logger for this Processor. More...

Detailed Description

Wrapper class for fire::Processor which does the necessary modifications on the constructors and adds the old configure method.

Deprecated:

This class is meant to be used only in the transitory phase where legacy processors are still supported. This class will be dropped when legacy processors are dropped.

Constructor & Destructor Documentation

EventProcessor()

framework::EventProcessor::EventProcessor ( const std::string &  name, framework::Process &  p  )

inline

Construct a legacy event processor.

See also

minimal_parameter_set for creating the parameter set to be passed to fire::Processor

fire::Processor::attach for providing the current handle to the Process

Parameters

[in]	name	Name of this processor
[in]	p	handle to current process

Member Function Documentation

configure()

virtual void framework::EventProcessor::configure ( config::Parameters &  ps )

inlinevirtual

Legacy configure method.

This method is here solely to support legacy processors

Parameters

[in]

ps

Parameter set to configure the processor with

minimal_parameter_set()

static fire::config::Parameters framework::EventProcessor::minimal_parameter_set ( const std::string &  name )

inlinestaticprivate

Construct the minimal parameter set for a fire::Processor.

This just involves putting the name parameter into the set of Parameters under the key name.

Parameters

[in]

name

Name of this processor

Returns

minimal parameter set ‘{ 'name’ : name }`

process()

virtual void framework::EventProcessor::process ( fire::Event &  event )

pure virtual

pass on pure virtual process function

Implements fire::Processor.

Implemented in framework::Producer, and framework::Analyzer.

---

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

• include/Framework/EventProcessor.h