psana::Step Class Reference
[psana package]

Class representing a step (calib cycle). More...

#include <Step.h>

List of all members.

Public Member Functions
	Step ()
	Default constructor makes "null" Step object.
	Step (const boost::shared_ptr< EventLoop > &evtLoop)
	~Step ()
	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.
EventIter	events ()
	Returns iterator for events in this step.

---

Detailed Description

Class representing a step (calib cycle).

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

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

Version:

Id

Step.h 8825 2014-08-28 01:16:10Z davidsch@SLAC.STANFORD.EDU

Author:

Andy Salnikov

Definition at line 60 of file Step.h.

---

Constructor & Destructor Documentation

psana::Step::Step

(

)

Default constructor makes "null" Step object.

Definition at line 39 of file Step.cpp.

psana::Step::Step

(

const boost::shared_ptr< EventLoop > &

evtLoop

)

Definition at line 45 of file Step.cpp.

psana::Step::~Step

(

)

Definition at line 53 of file Step.cpp.

---

Member Function Documentation

PSEnv::Env & psana::Step::env

(

)

const

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

Definition at line 59 of file Step.cpp.

EventIter psana::Step::events

(

)

[inline]

Returns iterator for events in this step.

Definition at line 80 of file Step.h.

References psana::EventLoop::EndCalibCycle.

Referenced by BOOST_AUTO_TEST_CASE().

psana::Step::operator bool

(

)

const [inline]

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

Definition at line 73 of file Step.h.

bool psana::Step::operator!

(

)

const [inline]

Definition at line 74 of file Step.h.

---

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

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

---