/data3/calcul/jacquem/working_dir/Micromegas/micromegasFrameWork/include/root/CaloHit.hh

Go to the documentation of this file.

/* @version $Revision: 1416 $ * @modifiedby $Author: jacquem $ * @lastmodified $Date: 2011-11-18 16:11:02 +0100 (Fri, 18 Nov 2011) $ */

#ifndef ROOT_CALOHIT
#define ROOT_CALOHIT



/*!
 * \file CaloHit.hh
 * \brief Describe calorimeter hit
 * 
 * -position along x axis: fX
 *
 * -position along y axis: fY
 *
 * -position along z axis: fZ
 *
 * -Threshold value: thr
 *
 * -Delta t time value: deltaT
 *
 * \author Jean Jacquemier
 * \version "$Revision: 1416 $"
 */


#include "TObject.h"
#include "root/MTChannelSoftId.hh"

//////////////////////////////////////////////////////////////////////////
//                                                                      //
// CaloHit                                                              //
//                                                                      //
//////////////////////////////////////////////////////////////////////////

/*! \class CaloHit
* \brief Describe calorimeter hit
* 
* -position along x axis: fX
*
* -position along y axis: fY
*
* -position along z axis: fZ
*
* -Threshold value: thr
*
* -Delta t time value: deltaT
*
*/


class CaloHit:  public TObject {


public:

 /*!
 *  \brief Constructor
 *
 *  CaloHit class constructor
 *
 *  \param none
 */
   CaloHit();

 /*!
 *  \brief Destructor
 *
 *  CaloHit class destructor
 *
 *  \param none
 */
   virtual ~CaloHit();   // virtual to call ~TObject


 /**
 * \fn GetX(void) const
 * \brief Getter for position along x axis
 * \param void.
 * \return Int_t position along x axis  in micrometer
 */
   inline Int_t GetX(void) const { return fX; } ;

 /**
 * \fn GetY(void) const
 * \brief Getter for position along Y axis
 * \param void.
 * \return Int_t position along Y axis in micrometer
 */
   inline Int_t GetY(void) const { return fY; } ;

 /**
 * \fn GetZ(void) const
 * \brief Getter for position along z axis
 * \param void.
 * \return Int_t position along z axis  in micrometer
 */
   inline Int_t GetZ(void) const { return fZ; } ;

 /**
 * \fn GetThreshold(void) const
 * \brief Getter for hit threshold value
 * \param void.
 * \return UInt_t hit threshold value
 */
   inline UInt_t GetThreshold(void) const { return thr; } ;

 /**
 * \fn GetDeltaT(void)
 * \brief Getter for hit deltaT time value
 * \param void.
 * \return Int_t hit deltaT time value
 */
   inline Int_t GetDeltaT(void) const { return deltaT; } ;

/**
 * \fn SetX(const Int_t value)
 * \brief Setter for position along x axis
 * \param  Int_t new position along x axis
 * \return none
 */
   inline void SetX(const Int_t value) { fX = value; }; 

/**
 * \fn SetY(const Int_t value)
 * \brief Setter for position along Y axis
 * \param  Int_t new position along Y axis
 * \return none
 */
   inline void SetY(const Int_t value) { fY = value; }; 

/**
 * \fn SetZ(const Int_t value)
 * \brief Setter for position along Z axis
 * \param  Int_t new position along Z axis
 * \return none
 */
   inline void SetZ(const Int_t value) { fZ = value; }; 

/**
 * \fn SetLayer(const UInt_t value)
 * \brief Setter for layer number
 * \param  UInt_t value = layer number
 * \return none
 */
   inline void SetLayer(const UInt_t value) { layer = value; }; 

/**
 * \fn SetThreshold(const UInt_t value)
 * \brief Setter for hit threshold value
 * \param  UInt_t new  hit threshold value
 * \return none
 */
   inline void SetThreshold(const UInt_t value) { thr = value; }; 

/**
 * \fn SetDeltaT(const Int_t value)
 * \brief Setter for deltaT time value
 * \param  Int_t new deltaT time value
 * \return none
 */
   inline void SetDeltaT(const Int_t value) { deltaT = value; }; 

/**
 * \fn GetLayer(const Int_t value)
 * \brief Setter for deltaT time value
 * \param  Int_t new deltaT time value
 * \return none
 */
   inline UInt_t GetLayer(void) { return layer; }; 


/**
 * \fn GetSolftId()
 * \brief Getter for softId. softId give information on Chamber/Dif/Board/Chip for this channel 
 * \return MTChannelSoftId 
 */
   inline MTChannelSoftId GetSolftId(void) { return softId; }; 

/**
 * \fn SetSolftId(const MTChannelSoftId value)
 * \brief Setter for softId. softId give information on Chamber/Dif/Board/Chip for this channel 
 * \return void 
 */
   inline void SetSoftId(MTChannelSoftId value) { softId = value; }; 

  inline  void SetRowInChamber(UInt_t value) { rowInChamber = value; } 
  inline  void SetColInChamber(UInt_t value) { colInChamber = value; } 

  inline unsigned int GetRowInChamber() const { return rowInChamber; };
  inline unsigned int GetColInChamber() const { return colInChamber; };


private:
   Int_t     fX;
   Int_t     fY;
   Int_t     fZ;
   UInt_t    rowInChamber; // row in Chamber alongside X axis
   UInt_t    colInChamber; // col in Chamber alongside Y axis
   UInt_t    thr;
   Int_t     deltaT;    
   UInt_t    layer;
   MTChannelSoftId softId;

   ClassDef(CaloHit, 34)  //MTEvent structure
};

#endif

---