GETRunList.hh

Go to the documentation of this file.

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

#ifndef GET_RUN_LIST_HH
#define GET_RUN_LIST_HH

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

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


//======================================================================
/*! \class GETRunList
 *
 *  This class defines a list of runs data files, instead of a
 *  single file.
 *
 */
class GETRunList : public GETRunFile
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETRunList);
  //------------------------------------------------------------

  protected:

    // data file
    string      run_file_pattern;   ///< Pattern for file name selection
    GStringList run_file_list;      ///< List of effective run files
    int         current_file_num;   ///< Number of currently opened file (-1 if none)

    u_int       list_event_count;   ///< Number of events in the file list

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

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

    virtual bool  AtEnd     ( ) const;    // inline
  //@}

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

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

    const GStringList & GetFileList ( ) const;    // inline
          GStringList & GetFileList ( );          // inline

    u_int               GetFileCount ( ) const;   // inline

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

  //@}

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

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


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


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