GanilBuffer.hh

Go to the documentation of this file.

//======================================================================
/*! \file GanilBuffer.hh
 *
 *  Déclaration des méthodes de la classe GanilBuffer qui gère les
 *  buffers de l'acquisition GANIL.
 */
//======================================================================

#ifndef GANIL_BUFFER_HH
#define GANIL_BUFFER_HH

#include "GanilCommon.hh"
#include "GanilEventBufferInfo.hh"

#define GANIL_BUFFER_DEFAULT_SIZE   16384     ///< Taille par défaut des buffers GANIL
#define GANIL_BUFFER_TYPE_NUMBER    11        ///< Nombre de types de buffers GANIL


class GanilRun;

//======================================================================
/*! \class GanilBuffer
 *
 *  Classe qui gère les buffers d'acquisition GANIL.
 */
class GanilBuffer
{
  friend class GanilRun;
  friend class GanilScaler;

  /// Types de buffers de l'acquisition GANIL
  enum GanilBufferTypes
  {
    bufferTypeUnknown  =  0,  // Numero d'identification de buffer de type inconnu
    bufferTypeFileh    =  1,  // Numero d'identification de buffer de type FILEH
    bufferTypeEventh   =  2,  // Numero d'identification de buffer de type EVENTH
    bufferTypeComment  =  3,  // Numero d'identification de buffer de type COMMENT
    bufferTypeParam    =  4,  // Numero d'identification de buffer de type PARAM
    bufferTypeScaler   =  5,  // Numero d'identification de buffer de type SCALER
    bufferTypeEventdb  =  6,  // Numero d'identification de buffer de type EVENTDB
    bufferTypeEbyedat  =  7,  // Numero d'identification de buffer de type EBYEDAT
    bufferTypeSpecth   =  8,  // Numero d'identification de buffer de type SPECTH
    bufferTypeSpectd   =  9,  // Numero d'identification de buffer de type SPECTD
    bufferTypeEndrun   = 10   // Numero d'identification de buffer de type ENDRUN
  };

  ///flags d'information (bits 16 a 31: specifique type d'analyse)
  enum GanilBufferFlags
  {
    bufferFlagFileh   = 0x00010000, // Bit d'état indiquant la lecture de buffers FILEH
    bufferFlagEventh  = 0x00020000, // Bit d'état indiquant la lecture de buffers EVENTH
    bufferFlagComment = 0x00040000, // Bit d'état indiquant la lecture de buffers COMMENT
    bufferFlagParam   = 0x00080000, // Bit d'état indiquant la lecture de buffers PARAM
    bufferFlagScaler  = 0x00100000, // Bit d'état indiquant la lecture de buffers SCALER
    bufferFlagEventdb = 0x00200000, // Bit d'état indiquant la lecture de buffers EVENTDB
    bufferFlagEbyedat = 0x00400000, // Bit d'état indiquant la lecture de buffers EBYEDAT
    bufferFlagSpecth  = 0x00800000, // Bit d'état indiquant la lecture de buffers SPECTH
    bufferFlagSpectd  = 0x01000000, // Bit d'état indiquant la lecture de buffers SPECTD
    bufferFlagEndrun  = 0x02000000, // Bit d'état indiquant la lecture de buffers ENDRUN

    bufferFlagHeader  = 0x000F0000, // Masque sur les bits d'état des buffers d'entête
    bufferFlagEvent   = 0x00600000  // Masque sur les bits d'état des buffers d'événement
  };

//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(GanilBuffer);
//----------------------------------------------------------------------

  protected:
    u_int       size;       ///< taille du buffer
    u_int       cursor;     ///< position dans le buffer
    bool        eob;        ///< test de la fin de buffer
    u_int       type;       ///< type de buffer
    string      id;         ///< chaîne d'identification du type de buffer
    u_int       number;     ///< numéro de buffer
    u_int       event_num;  ///< numéro d'événement (acq. GANIL)
    GanilRun  * run_base;   ///< pointeur sur le gestinnaire du run

    /// table des statistiques de types de buffer
    u_int       stat[GANIL_BUFFER_TYPE_NUMBER];

#ifndef __MAKECINT__
    byte      * buffer;     ///<  pointeur sur la table du buffer
#endif


    GanilEventBufferInfo  buffer_info;  ///<  Information des buffers de type EBYEDAT

  public:

    // constructeur
    GanilBuffer ( GanilRun *ptr = NULL, const u_int s = GANIL_BUFFER_DEFAULT_SIZE );

    // constructeur de recopie
    GanilBuffer ( const GanilBuffer & );

    // opérateur d'affectation
    virtual GanilBuffer & operator = ( const GanilBuffer &original );

    // destructeur
    virtual  ~GanilBuffer ( );

//----------------------------------------------------------------------

  protected:
    // détermine le type de buffer
    void  SetType ( );

    // saisie des infos d'un buffer EBYEDAT
    void  SetEbyedatInfo ( );

    // saisie des infos d'un buffer EVENTDB
    void  SetEventDBInfo ( );

//----------------------------------------------------------------------
  public:
    GanilRun  * GetRunBase ( ) const;
    u_int       Size       ( ) const; 
    u_int       GetType    ( ) const; 
    string      GetId      ( ) const; 
    u_int       GetNumber  ( ) const;
    u_int       GetEventNumber ( ) const;
    bool        EndOfBuffer    ( ) const;

    u_int   GetBufferStat ( const u_int t ) const;

  protected:
    void    SetEOB ( const bool b = true );

    // lecture d'un buffer
    int     Read ( FILE * );

  public:
    // Extraction de données du buffer
    string      ExtractString ( const char end );
    string      ExtractString ( const u_int len );
    Int2        ExtractInt2   ( );
    Int4        ExtractInt4   ( );
    U_Int2      ExtractUInt2  ( );
    U_Int4      ExtractUInt4  ( );

    // Passe n caratères du buffer, pour des parties de buffer à ignorer.
    void  Skip ( const u_int n );

//----------------------------------------------------------------------

  protected:

    // Initialisation d'un buffer
    void  Reset ( );

    // Lecture d'un événement
    int   ReadEvent   ( GanilRun * );

    // Lecture d'un événement EVENTDB
    int   ReadEventDB ( GanilRun * );

    // Lecture d'un événement EBYEDAT
    int   ReadEbyedat ( GanilRun * );


//----------------------------------------------------------------------
//  pour ROOT...
  public:
    /*! Définition à usage de ROOT... */
    ClassDef(GanilBuffer,0);
} ;


//======================================================================
//  METHODES INLINE
//======================================================================

/*! Retourne le pointeur sur le gestinnaire de run.*/
inline GanilRun * GanilBuffer::GetRunBase() const
  { return (run_base); }

/*! Retourne la taille de buffer.*/
inline u_int GanilBuffer::Size() const
  { return (size); }

/*! Retourne le type de buffer.*/
inline u_int GanilBuffer::GetType() const
  { return (type); }

/*! Retourne l'identifiant du type de buffer.*/
inline string GanilBuffer::GetId() const
  { return (id); }

/*! Retourne le numéro de buffer.*/
inline u_int GanilBuffer::GetNumber() const
  { return (number); }

/*! Retourne le numéro d'événement GANIL.*/
inline u_int GanilBuffer::GetEventNumber() const
  { return (event_num); }

/*! Retourne vrai si le buffer est traité complètement.*/
inline bool GanilBuffer::EndOfBuffer() const
  { return (eob); }

/*! Positionne l'indication de fin de buffer.
 *  \param  b   état de l'indicateur
 */
inline void GanilBuffer::SetEOB ( const bool b )
  { eob = b; if (eob) cursor = size; }

/*! Retourne le nombre de buffers d'un type donné. *  \param  t   type de buffers
 */
inline u_int GanilBuffer::GetBufferStat ( const u_int t ) const
  { return ((t < GANIL_BUFFER_TYPE_NUMBER) ? stat[t] : 0); }


/*! Passe \b n caratères du buffer, pour des parties de buffer
 *  à ignorer.
 *  \param  n   nombre d'octets à passer
 */
inline void GanilBuffer::Skip ( const u_int n )
  { if (cursor+n < size) cursor += n; }



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

 *  \param  t   type de buffers
 */
inline u_int GanilBuffer::GetBufferStat ( const u_int t ) const
  { return ((t < GANIL_BUFFER_TYPE_NUMBER) ? stat[t] : 0); }


/*! Passe \b n caratères du buffer, pour des parties de buffer
 *  à ignorer.
 *  \param  n   nombre d'octets à passer
 */
inline void GanilBuffer::Skip ( const u_int n )
  { if (cursor+n < size) cursor += n; }



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