psana::StepIter Class Reference
[psana package]

Class representing iterator over steps (calib cycles). More...

#include <StepIter.h>

List of all members.

Public Types
typedef Step	value_type
Public Member Functions
	StepIter ()
	Default constructor makes invalid iterator.
	StepIter (const boost::shared_ptr< EventLoop > &evtLoop, EventLoop::EventType stopType)
	Constructor takes event loop instance.
	~StepIter ()
value_type	next ()
	get next Step, when done returns object which is convertible to "false"
std::pair< value_type, boost::shared_ptr< PSEvt::Event > >	nextWithEvent ()
	get next Step and corresponding event.

---

Detailed Description

Class representing iterator over steps (calib cycles).

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

Version:

Id

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

Author:

Andy Salnikov

Definition at line 56 of file StepIter.h.

---

Member Typedef Documentation

typedef Step psana::StepIter::value_type

Definition at line 59 of file StepIter.h.

---

Constructor & Destructor Documentation

psana::StepIter::StepIter

(

)

Default constructor makes invalid iterator.

Definition at line 39 of file StepIter.cpp.

psana::StepIter::StepIter	(	const boost::shared_ptr< EventLoop > &	evtLoop,
		EventLoop::EventType	stopType
	)

Constructor takes event loop instance.

Do not use EventLoop::Event for stop type, first it does not make sense, second this iterator uses it for special purpose.

Definition at line 45 of file StepIter.cpp.

psana::StepIter::~StepIter

(

)

Definition at line 54 of file StepIter.cpp.

---

Member Function Documentation

StepIter::value_type psana::StepIter::next

(

)

get next Step, when done returns object which is convertible to "false"

Definition at line 93 of file StepIter.cpp.

References nextWithEvent().

Referenced by BOOST_AUTO_TEST_CASE().

std::pair< StepIter::value_type, boost::shared_ptr< PSEvt::Event > > psana::StepIter::nextWithEvent

(

)

get next Step and corresponding event.

Definition at line 61 of file StepIter.cpp.

References psana::EventLoop::BeginCalibCycle, psana::EventLoop::Event, and psana::EventLoop::None.

Referenced by next().

---

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

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

---