psana::EventKeys Class Reference

Example module class for psana which dumps the list of keys in event. More...

#include <EventKeys.h>

Inheritance diagram for psana::EventKeys:

List of all members.

Public Member Functions
	EventKeys (const std::string &name)
virtual	~EventKeys ()
virtual void	beginJob (Event &evt, Env &env)
	Method which is called once at the beginning of the job.
virtual void	beginRun (Event &evt, Env &env)
	Method which is called at the beginning of the run.
virtual void	beginCalibCycle (Event &evt, Env &env)
	Method which is called at the beginning of the calibration cycle.
virtual void	event (Event &evt, Env &env)
	Method which is called with event data.
virtual void	endCalibCycle (Event &evt, Env &env)
	Method which is called at the end of the calibration cycle.
virtual void	endRun (Event &evt, Env &env)
	Method which is called at the end of the run.
virtual void	endJob (Event &evt, Env &env)
	Method which is called once at the end of the job.

---

Detailed Description

Example module class for psana which dumps the list of keys in event.

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

See also:

AdditionalClass

Version:

$Id: EventKeys.h 8884 2014-09-11 18:43:40Z dubrovin@SLAC.STANFORD.EDU $

Author:

Andrei Salnikov

Definition at line 49 of file EventKeys.h.

---

Constructor & Destructor Documentation

psana::EventKeys::EventKeys

(

const std::string &

name

)

Definition at line 56 of file EventKeys.cpp.

References psana::Configurable::config().

psana::EventKeys::~EventKeys

(

)

[virtual]

Definition at line 68 of file EventKeys.cpp.

---

Member Function Documentation

void psana::EventKeys::beginCalibCycle	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called at the beginning of the calibration cycle.

Definition at line 102 of file EventKeys.cpp.

References logger, MsgLog, psana::Configurable::name(), and printKeys().

void psana::EventKeys::beginJob	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called once at the beginning of the job.

Definition at line 74 of file EventKeys.cpp.

References logger, MsgLog, psana::Configurable::name(), and printKeys().

void psana::EventKeys::beginRun	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called at the beginning of the run.

Definition at line 88 of file EventKeys.cpp.

References logger, MsgLog, psana::Configurable::name(), and printKeys().

void psana::EventKeys::endCalibCycle	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called at the end of the calibration cycle.

Definition at line 137 of file EventKeys.cpp.

References logger, MsgLog, psana::Configurable::name(), and printKeys().

void psana::EventKeys::endJob	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called once at the end of the job.

Definition at line 157 of file EventKeys.cpp.

References logger, MsgLog, psana::Configurable::name(), and printKeys().

void psana::EventKeys::endRun	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called at the end of the run.

Definition at line 147 of file EventKeys.cpp.

References logger, MsgLog, psana::Configurable::name(), and printKeys().

void psana::EventKeys::event	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called with event data.

Method which is called with event data, this is the only required method, all other methods are optional

Definition at line 117 of file EventKeys.cpp.

References logger, MsgLog, psana::Configurable::name(), and printKeys().

---

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

• psana/include/EventKeys.h
• psana/src/EventKeys.cpp

---