Added documentation of each file.
[u/mrichter/AliRoot.git] / FMD / AliFMDCalibSampleRate.h
1 #ifndef ALIFMDCALIBSAMPLERATE_H
2 #define ALIFMDCALIBSAMPLERATE_H
3 /* Copyright(c) 1998-2000, ALICE Experiment at CERN, All rights
4  * reserved. 
5  *
6  * See cxx source for full Copyright notice                               
7  */
8 /** @file    AliFMDCalibSampleRate.h
9     @author  Christian Holm Christensen <cholm@nbi.dk>
10     @date    Sun Mar 26 18:32:14 2006
11     @brief   Per digitizer card pulser calibration
12     
13 */
14 #ifndef ROOT_TObject
15 # include <TObject.h>
16 #endif
17 #ifndef ALIFMDUSHORTMAP_H
18 # include "AliFMDUShortMap.h"
19 #endif
20 #ifndef ROOT_TArrayI
21 # include <TArrayI.h>
22 #endif
23 //____________________________________________________________________
24 /** @brief Per digitizer card pulser calibration
25     @ingroup FMD_base
26 */
27 class AliFMDCalibSampleRate : public TObject
28 {
29 public:
30   /** CTOR */
31   AliFMDCalibSampleRate();
32   /** Copy CTOR
33       @param o Object to copy from  */
34   AliFMDCalibSampleRate(const AliFMDCalibSampleRate& o);
35   /** Assignment operator 
36       @param o Object to assign from 
37       @return Reference to assign from  */
38   AliFMDCalibSampleRate& operator=(const AliFMDCalibSampleRate& o);
39   /** Set sample for a DDL
40       @param det   Detector #
41       @param ring  Ring ID 
42       @param sec   Sector # 
43       @param str   Strip number (not used)
44       @param rate  Sample rate */
45   void Set(UShort_t det, Char_t ring, UShort_t sec, UShort_t str, 
46            UShort_t rate);
47   /** Get sample rate for a detector 
48       @param det  Detector #
49       @param ring Ring ID 
50       @param sec  Sector # 
51       @param str  Strip number (not used)
52       @return Sample rate */
53   UShort_t Rate(UShort_t det, Char_t ring, UShort_t sec, UShort_t str=0) const;
54 protected:
55   // TArrayI fRates; // Sample rates 
56   AliFMDUShortMap fRates;
57   ClassDef(AliFMDCalibSampleRate,2); // Sample rates 
58 };
59
60 #endif
61 //____________________________________________________________________
62 //
63 // Local Variables:
64 //   mode: C++
65 // End:
66 //
67
68