psana::DataSource Class Reference
[psana package]

Class representing a data source for psana framework. More...

#include <DataSource.h>

List of all members.

Public Member Functions

 DataSource ()
 Default constructor makes "null" data source.
 DataSource (const boost::shared_ptr< InputModule > &inputModule, const std::vector< boost::shared_ptr< Module > > &modules, const boost::shared_ptr< PSEnv::Env > &env)
 Make an instance of data source.
 ~DataSource ()
bool empty () const
PSEnv::Envenv () const
 Get environment object, cannot be called for "null" source.
EventIter events ()
 Returns iterator for events.
StepIter steps ()
 Returns iterator for steps.
RunIter runs ()
 Returns iterator for runs.
void addmodule (boost::shared_ptr< Module > module)
bool liveAvail (int numEvents)


Detailed Description

Class representing a data source for psana framework.

Class encapsulates input data in the form of input module and provides different ways to iterator over those data.

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

Version:
Id
DataSource.h 10732 2015-09-23 22:07:46Z davidsch@SLAC.STANFORD.EDU
Author:
Andy Salnikov

Definition at line 65 of file DataSource.h.


Constructor & Destructor Documentation

psana::DataSource::DataSource (  ) 

Default constructor makes "null" data source.

Definition at line 41 of file DataSource.cpp.

psana::DataSource::DataSource ( const boost::shared_ptr< InputModule > &  inputModule,
const std::vector< boost::shared_ptr< Module > > &  modules,
const boost::shared_ptr< PSEnv::Env > &  env 
)

Make an instance of data source.

Constructor takes instance of input module, and a list of user modules.

Definition at line 46 of file DataSource.cpp.

psana::DataSource::~DataSource (  ) 

Definition at line 60 of file DataSource.cpp.


Member Function Documentation

void psana::DataSource::addmodule ( boost::shared_ptr< Module module  )  [inline]

Definition at line 104 of file DataSource.h.

bool psana::DataSource::empty (  )  const [inline]

Returns true if data source has no data ("null" source)

Definition at line 89 of file DataSource.h.

Referenced by psana::PSAnaApp::runApp().

PSEnv::Env & psana::DataSource::env (  )  const

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

Definition at line 66 of file DataSource.cpp.

EventIter psana::DataSource::events (  )  [inline]

Returns iterator for events.

Definition at line 95 of file DataSource.h.

References psana::EventLoop::None.

Referenced by psana::PSAnaApp::runApp().

bool psana::DataSource::liveAvail ( int  numEvents  ) 

Definition at line 53 of file DataSource.cpp.

RunIter psana::DataSource::runs (  )  [inline]

Returns iterator for runs.

Definition at line 101 of file DataSource.h.

StepIter psana::DataSource::steps (  )  [inline]

Returns iterator for steps.

Definition at line 98 of file DataSource.h.

References psana::EventLoop::None.


The documentation for this class was generated from the following files:
Generated on 19 Dec 2016 for PSANAclasses by  doxygen 1.4.7