GETRunFile.hh

Go to the documentation of this file.

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

#ifndef GET_RUN_FILE_HH
#define GET_RUN_FILE_HH

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

// includes from ROOT
#include <TSystem.h>
#include <TROOT.h>


//======================================================================
/*! \class GETRunFile
 *
 *  This is the base class for runs data files.
 *  It manages a single file, while derived classes may handle more
 *  complicated groups of files.
 *
 *  The run files are only open in read mode.
 */
class GETRunFile
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETRunFile);
  //------------------------------------------------------------

  protected:

    // data file
    FILE  * run_file_ptr;       ///< Pointer to experimental data file
    string  run_file_name;      ///< Name of the experimental data file

    u_int   file_event_count;   ///< Number of events in the file

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

  //----------------------------------------------------------
  /** @name File operations */
  //@{
    virtual int   Open      ( const string & fname );

    virtual int   Open      ( );          // inline
    virtual int   Close     ( );
    virtual bool  IsOpen    ( ) const;    // inline
    virtual int   OpenNext  ( );          // inline

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

  //----------------------------------------------------------
  /** @name File information */
  //@{
    int             GetFileLun ( ) const;         // inline

    virtual int     SetFileName ( const string & fname );

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

    FILE  * GetFilePtr ( );                   // inline

    virtual void    EventCountIncr ( );           // inline
    int             GetFileEventCount ( ) const;  // inline
  //@}


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

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


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


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