GanilParam.hh

Go to the documentation of this file.

//======================================================================
/*! \file GanilParam.hh
 *
 *  Déclaration des méthodes de la classe GanilParam qui représente les
 *  paramètres bruts de l'acquisition GANIL.
 */
//======================================================================

#ifndef GANIL_PARAM_HH
#define GANIL_PARAM_HH

#include "GanilCommon.hh"
#include "Param.hh"
#include "Data.hh"

#define GANIL_PARAM_TYPE_FLAG   0x00000003    ///<  Bits définissant le type de paramètre
#define GANIL_PARAM_USER_FLAG   0x00000010    ///<  Bit définissant l'usage: 0 param. GANIL / 1 param. USER

//======================================================================
/*! \class GanilParam
 *
 *  Classe représentant les paramètres bruts de l'acquisition GANIL.
 *  Le champ \ref type contient plusieurs information:
 *    - bits 0 et 1: mode de fonctionnement du paramètre: single,
 *      multihit, ou array (voir la classe Param)
 *    - bit 4: s'il est à 0, c'est un paramètre de l'acquisition GANIL,
 *      et est mis à 1, c'est un paramètre utilisateur.
 */
class GanilParam
{
  friend class GanilParamInfo;
  friend class GanilRun;

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

  protected:
    u_int     type;     ///<  Type de paramètre (single, multihit, array)
    u_int     datatype; ///<  Type de données du paramètre (entier/réel, 16/32/64 bits, signé/non signé)

    string    name;     ///<  Nom du paramètre brut
    u_int     label;    ///<  Label du paramètre (différent de number en mode EBYEDAT)
    u_int     mask;     ///<  Masque binaire associéc5f9
    u_int     branch;   ///<  Numéro de branche

  public:
    // constructeur par défaut
    GanilParam ( );

    // constructeur complet
    GanilParam ( const u_int   p_type,
                 const string &p_name,
                 const u_int   p_label,
                 const u_int   p_datatype = DATA_TYPE_U_INT2,
                 const u_int   p_mask     = 0);

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

    // destructeur
    virtual  ~GanilParam ( );

//----------------------------------------------------------------------
    // comparaison
    bool    operator == ( const GanilParam &par );

    // Opérateur de comparaison (non-équivalence).
    bool    operator != ( const GanilParam &par );

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

    // Retourne le nom du paramètre.
    string  Name() const;

    // Retourne le label du paramètre.
    u_int   Label() const;

    // Retourne le masque binaire du paramètre.
    u_int   Mask() const;

    // Retourne le numéro de branche du paramètre.
    u_int   Branch() const;

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


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


/*! Opérateur de comparaison (non-équivalence).
 *  \param  par   paramètre GANIL à comparer
 */
inline bool GanilParam::operator != ( const GanilParam &par )
  { return ( ! (*this == par) ); }

/*! Retourne le nom du paramètre.
 */
inline  string  GanilParam::Name() const
  { return (name); }

/*! Retourne le label du paramètre.
 */
inline u_int GanilParam::Label() const
  { return (label); }

/*! Retourne le masque binaire du paramètre.
 */
inline u_int GanilParam::Mask() const
  { return (mask); }

/*! Retourne le numéro de branche du paramètre.
 */
inline u_int GanilParam:: Branch() const
  { return (branch); }


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