psana::Run Class Reference
[psana package]

Class representing a run. More...

#include <Run.h>

List of all members.

Public Member Functions
	Run ()
	Default constructor makes "null" run object.
	Run (const boost::shared_ptr< EventLoop > &evtLoop, int run)
	~Run ()
	operator bool () const
	This object is converted to true for non-null instance.
bool	operator! () const
PSEnv::Env &	env () const
	Get environment object, cannot be called for "null" source.
int	run () const
	Get run number, -1 returned for if unknown.
EventIter	events ()
	Returns iterator for events in this run.
StepIter	steps ()
	Returns iterator for steps in this run.
Index &	index ()
	Returns run index for random access.

---

Detailed Description

Class representing a run.

Main purpose of this class is to provide iteration over contained events or steps.

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

Version:

Id

Run.h 8013 2014-04-17 02:29:27Z cpo@SLAC.STANFORD.EDU

Author:

Andy Salnikov

Definition at line 61 of file Run.h.

---

Constructor & Destructor Documentation

psana::Run::Run

(

)

Default constructor makes "null" run object.

Definition at line 40 of file Run.cpp.

psana::Run::Run	(	const boost::shared_ptr< EventLoop > &	evtLoop,
		int	run
	)

Definition at line 47 of file Run.cpp.

psana::Run::~Run

(

)

Definition at line 56 of file Run.cpp.

---

Member Function Documentation

PSEnv::Env & psana::Run::env

(

)

const

Get environment object, cannot be called for "null" source.

Definition at line 62 of file Run.cpp.

EventIter psana::Run::events

(

)

[inline]

Returns iterator for events in this run.

Definition at line 84 of file Run.h.

References psana::EventLoop::EndRun.

Referenced by BOOST_AUTO_TEST_CASE().

Index& psana::Run::index

(

)

[inline]

Returns run index for random access.

Definition at line 90 of file Run.h.

psana::Run::operator bool

(

)

const [inline]

This object is converted to true for non-null instance.

Definition at line 74 of file Run.h.

bool psana::Run::operator!

(

)

const [inline]

Definition at line 75 of file Run.h.

int psana::Run::run

(

)

const [inline]

Get run number, -1 returned for if unknown.

Definition at line 81 of file Run.h.

StepIter psana::Run::steps

(

)

[inline]

Returns iterator for steps in this run.

Definition at line 87 of file Run.h.

References psana::EventLoop::EndRun.

Referenced by BOOST_AUTO_TEST_CASE().

---

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

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

---