psana/include/Step.h

Go to the documentation of this file.

#ifndef PSANA_STEP_H
#define PSANA_STEP_H

//--------------------------------------------------------------------------
// File and Version Information:
//     $Id: Step.h 8825 2014-08-28 01:16:10Z davidsch@SLAC.STANFORD.EDU $
//
// Description:
//     Class Step.
//
//------------------------------------------------------------------------

//-----------------
// C/C++ Headers --
//-----------------
#include <boost/shared_ptr.hpp>

//----------------------
// Base Class Headers --
//----------------------

//-------------------------------
// Collaborating Class Headers --
//-------------------------------
#include "psana/EventIter.h"
#include "psana/EventLoop.h"
#include "PSEnv/Env.h"

//------------------------------------
// Collaborating Class Declarations --
//------------------------------------
namespace psana {
class StepIter;
}

//             ---------------------
//             -- Class Interface --
//             ---------------------

namespace psana {

/// @addtogroup psana

/**
 *  @ingroup psana
 *
 *  @brief 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
 */

class Step  {
public:

  /// Default constructor makes "null" Step object
  Step();

  // Constructor takes event loop object
  Step(const boost::shared_ptr<EventLoop>& evtLoop);
  
  // Destructor
  ~Step () ;
  
  /// This object is converted to true for non-null instance
  operator bool() const { return bool(m_evtLoop); }
  bool operator!() const { return not bool(m_evtLoop); }

  /// Get environment object, cannot be called for "null" object
  PSEnv::Env& env() const;

  /// Returns iterator for events in this step
  EventIter events() { return EventIter(m_evtLoop, EventLoop::EndCalibCycle); }

protected:

private:

  // Data members
  boost::shared_ptr<EventLoop> m_evtLoop;

};

} // namespace psana

#endif // PSANA_STEP_H

---