psana::PrintEventId Class Reference

Example module class for psana which prints event ID from current event. More...

#include <PrintEventId.h>

Inheritance diagram for psana::PrintEventId:

List of all members.

Public Member Functions
	PrintEventId (const std::string &name)
virtual	~PrintEventId ()
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)
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.
Protected Member Functions
void	printId (Event &evt)
	fetch and print event ID

---

Detailed Description

Example module class for psana which prints event ID from current event.

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

Version:

$Id: PrintEventId.h 3319 2012-05-02 23:14:22Z salnikov@SLAC.STANFORD.EDU $

Author:

Andrei Salnikov

Definition at line 47 of file PrintEventId.h.

---

Constructor & Destructor Documentation

psana::PrintEventId::PrintEventId

(

const std::string &

name

)

Definition at line 44 of file PrintEventId.cpp.

psana::PrintEventId::~PrintEventId

(

)

[virtual]

Definition at line 52 of file PrintEventId.cpp.

---

Member Function Documentation

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

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

Definition at line 74 of file PrintEventId.cpp.

References MsgLog, psana::Configurable::name(), and printId().

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

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

Definition at line 58 of file PrintEventId.cpp.

References MsgLog, psana::Configurable::name(), and printId().

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

Method which is called at the beginning of the run.

Definition at line 66 of file PrintEventId.cpp.

References MsgLog, psana::Configurable::name(), and printId().

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

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

Definition at line 90 of file PrintEventId.cpp.

References MsgLog, psana::Configurable::name(), and printId().

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

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

Definition at line 106 of file PrintEventId.cpp.

References MsgLog, psana::Configurable::name(), and printId().

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

Method which is called at the end of the run.

Definition at line 98 of file PrintEventId.cpp.

References MsgLog, psana::Configurable::name(), and printId().

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

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

Definition at line 83 of file PrintEventId.cpp.

References printId().

void psana::PrintEventId::printId

(

Event &

evt

)

[protected]

fetch and print event ID

Definition at line 114 of file PrintEventId.cpp.

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

Referenced by beginCalibCycle(), beginJob(), beginRun(), endCalibCycle(), endJob(), endRun(), and event().

---

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

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

---