GETRunSerie.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETRunSerie.hh
 *
 *  Include file for the GETRunSerie class.
 */
//======================================================================

#ifndef GET_RUN_SERIE_HH
#define GET_RUN_SERIE_HH

//----------------------------------------------------------------------
// includes from GET library
#include "GETRunList.hh"

// includes from GCpp library
#include "GIntervalList.hh"


//======================================================================
/*! \class GETRunSerie
 *
 *  This class defines a serie of runs data files, identified by
 *  a list of run numbers and a file pattern.
 *
 *  The file pattern must contain a "%R" indicating where the run
 *  number is specified in the file name, or "%<n>R" if the run
 *  number is padded with 0.
 */
class GETRunSerie : public GETRunList
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETRunSerie);
  //------------------------------------------------------------

  protected:

    // data file
    GString       run_pattern;      ///< Pattern for file name (containing "%*r" information)
    GIntervalList run_serie;        ///< List of effective run files
    int           current_run_num;  ///< Current run number (-1 if none)

    u_int         serie_event_count;  ///< Number of events in the runs serie

  public:
  //----------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    GETRunSerie ( const string & pattern = "",
                  const string & serie   = "", bool open = true );
    virtual ~GETRunSerie ( );
  //@}

  //----------------------------------------------------------
  /** @name File operations */
  //@{
    virtual int   Open      ( );
    virtual int   Close     ( );
    virtual bool  IsOpen    ( ) const;    // inline
    virtual int   OpenNext  ( );

    virtual bool  AtEnd     ( ) const;    // inline

    virtual int   SetNextRunList ( bool skip = true );
    virtual int   SetRunList     ( int rnum );

  //@}

  //----------------------------------------------------------
  /** @name File information */
  //@{
    virtual int     SetRunPattern ( const string & pattern );
    virtual int     SetRunSerie   ( const string & serie );

    const string  & GetRunPattern ( ) const;    // inline
          string  & GetRunPattern ( );          // inline

    string          GetRunSerie   ( ) const;    // inline

    u_int           GetRunCount   ( ) const;    // inline
    int             GetCurrentRun ( ) const;    // inline
    void            InitCurrentRun ( );         // inline

    virtual void    EventCountIncr     ( );         // inline
    int             GetSerieEventCount ( ) const;   // inline

  //@}

  //----------------------------------------------------------
  /** @name ROOT related functions */
  //@{
  public:

    /*! for use within ROOT.*/
    ClassDef(GETRunSerie,0);
  //@}
};


//----------------------------------------------------------------------
//  Inline functions
#include "icc/GETRunSerie.icc"


//======================================================================
#endif