psana_examples/include/DumpAlias.h

Go to the documentation of this file.

#ifndef PSANA_EXAMPLES_DUMPALIAS_H
#define PSANA_EXAMPLES_DUMPALIAS_H

//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: DumpAlias.h 6920 2013-10-07 22:09:39Z salnikov@SLAC.STANFORD.EDU $
//
// Description:
//      Class DumpAlias.
//
//------------------------------------------------------------------------

//-----------------
// C/C++ Headers --
//-----------------

//----------------------
// Base Class Headers --
//----------------------
#include "psana/Module.h"

//-------------------------------
// Collaborating Class Headers --
//-------------------------------

//------------------------------------
// Collaborating Class Declarations --
//------------------------------------

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

namespace psana_examples {

/// @addtogroup psana_examples

/**
 *  @ingroup psana_examples
 *
 *  Psana module which dumps contents of alias configuration object
 *
 *  @note This software was developed for the LCLS project.  If you use all or 
 *  part of it, please give an appropriate acknowledgment.
 *
 *  @version \$Id: DumpAlias.h 6920 2013-10-07 22:09:39Z salnikov@SLAC.STANFORD.EDU $
 *
 *  @author Andy Salnikov
 */

class DumpAlias : public Module {
public:

  // Default constructor
  DumpAlias (const std::string& name) ;

  // Destructor
  virtual ~DumpAlias () ;

  /// Method which is called at the beginning of the calibration cycle
  virtual void beginCalibCycle(Event& evt, Env& env);
  
  /// Method which is called with event data, this is the only required 
  /// method, all other methods are optional
  virtual void event(Event& evt, Env& env);
  
protected:

private:

  Source m_src;         // Data source set from config file

};

} // namespace psana_examples

#endif // PSANA_EXAMPLES_DUMPALIAS_H

---