psana_examples::DumpDgram Class Reference
[Psana_examples]

gets the DgramList or Dgram from the Event. Dumps basic information. More...

#include <DumpDgram.h>

List of all members.

Public Member Functions
	DumpDgram (const std::string &name)
virtual	~DumpDgram ()
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.
Protected Member Functions
void	dgramDump (Event &evt, const std::string &hdr)

---

Detailed Description

gets the DgramList or Dgram from the Event. Dumps basic information.

This example demonstrates how to deal with the raw xtc dgram, if it is present in the event (it will not be if psana's input is hdf5). Ealier versions of psana put a single Pds::Dgram into the event. Later versions that deal with offline event building put a XtcInput::DgramList into the event.

In general users *should not* work with this data. This is the raw data from which psana fills the Event. Users should access the data by getting psana Types from the Event. In general they should not be looking at the Datagrams. However looking at the Datagrams could be useful for diagnosing problems with event building.

Note:

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

See also:

XtcInput::DgramList

Version:

$Id:

Author:

David Schneider

Definition at line 65 of file DumpDgram.h.

---

Constructor & Destructor Documentation

psana_examples::DumpDgram::DumpDgram

(

const std::string &

name

)

Definition at line 47 of file DumpDgram.cpp.

psana_examples::DumpDgram::~DumpDgram

(

)

[virtual]

Definition at line 55 of file DumpDgram.cpp.

---

Member Function Documentation

void psana_examples::DumpDgram::beginCalibCycle	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 72 of file DumpDgram.cpp.

References dgramDump().

void psana_examples::DumpDgram::beginJob	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 60 of file DumpDgram.cpp.

References dgramDump().

void psana_examples::DumpDgram::beginRun	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called at the beginning of the run.

Definition at line 66 of file DumpDgram.cpp.

References dgramDump().

void psana_examples::DumpDgram::dgramDump	(	Event &	evt,
		const std::string &	hdr
	)			[protected]

Definition at line 105 of file DumpDgram.cpp.

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

void psana_examples::DumpDgram::endCalibCycle	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 85 of file DumpDgram.cpp.

References dgramDump().

void psana_examples::DumpDgram::endJob	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 99 of file DumpDgram.cpp.

References dgramDump().

void psana_examples::DumpDgram::endRun	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called at the end of the run.

Definition at line 92 of file DumpDgram.cpp.

References dgramDump().

void psana_examples::DumpDgram::event	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called with event data.

Definition at line 78 of file DumpDgram.cpp.

References dgramDump().

---

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

• psana_examples/include/DumpDgram.h
• psana_examples/src/DumpDgram.cpp

---