Bringing CMakeLists under svn maintenance

[u/mrichter/AliRoot.git] / FMD / AliFMDCalibSampleRate.h

diff --git a/FMD/AliFMDCalibSampleRate.h b/FMD/AliFMDCalibSampleRate.h
index fbd3a34257c46b0bebad40eb4055757e92b95421..30784957626f7a53db8209d1ee485f20e56594ee 100644 (file)
--- a/FMD/AliFMDCalibSampleRate.h
+++ b/FMD/AliFMDCalibSampleRate.h
@@ -5,12 +5,22 @@
  *
  * See cxx source for full Copyright notice                               
  */
+//____________________________________________________________________
+//                                                                          
+// This class stores the sample rate (that is, how many times the
+// ATLRO's sample each VA1 channel).  In principle these can be
+// controlled per half ring, but in real life it's most likely that
+// this value will be the same for all detectors.  This value must be
+// retrived from DCS or the like. 
+//
 /** @file    AliFMDCalibSampleRate.h
     @author  Christian Holm Christensen <cholm@nbi.dk>
     @date    Sun Mar 26 18:32:14 2006
     @brief   Per digitizer card pulser calibration
-    
+    @ingroup FMD_base    
 */
+
+#include <iosfwd>
 #ifndef ROOT_TObject
 # include <TObject.h>
 #endif
@@ -29,31 +39,59 @@ class AliFMDCalibSampleRate : public TObject
 public:
   /** CTOR */
   AliFMDCalibSampleRate();
-  /** Copy CTOR
-      @param o Object to copy from  */
+  /** 
+   * Copy CTOR
+   *
+   * @param o Object to copy from  
+   */
   AliFMDCalibSampleRate(const AliFMDCalibSampleRate& o);
-  /** Assignment operator 
-      @param o Object to assign from 
-      @return Reference to assign from  */
+  /** 
+   * Assignment operator 
+   *
+   * @param o Object to assign from 
+   *
+   * @return Reference to this object 
+   */
   AliFMDCalibSampleRate& operator=(const AliFMDCalibSampleRate& o);
-  /** Set sample for a DDL
-      @param det   Detector #
-      @param ring  Ring ID 
-      @param sec   Sector # 
-      @param str   Strip number (not used)
-      @param rate  Sample rate */
+  /** 
+   * Set sample for a sector
+   *
+   * @param det   Detector #
+   * @param ring  Ring ID 
+   * @param sec   Sector # 
+   * @param str   Strip number (not used)
+   * @param rate  Sample rate 
+   */
   void Set(UShort_t det, Char_t ring, UShort_t sec, UShort_t str, 
           UShort_t rate);
-  /** Get sample rate for a detector 
-      @param det  Detector #
-      @param ring Ring ID 
-      @param sec  Sector # 
-      @param str  Strip number (not used)
-      @return Sample rate */
+  /** 
+   * Get sample rate for a sector
+   *
+   * @param det  Detector #
+   * @param ring Ring ID 
+   * @param sec  Sector # 
+   * @param str  Strip number (not used)
+   *
+   * @return Sample rate 
+   */
   UShort_t Rate(UShort_t det, Char_t ring, UShort_t sec, UShort_t str=0) const;
+  /** 
+   * Write stored samplerates to file
+   *
+   * @param outFile Output file stream
+   */
+  void WriteToFile(std::ostream & outFile, Bool_t* detectors=0);
+  /** 
+   * Read information from file and set sample rates
+   *
+   * @param inFile input file stream
+   */
+  void ReadFromFile(std::istream & inFile);
+
+  const AliFMDUShortMap& Rates() const { return fRates; }
 protected:
   // TArrayI fRates; // Sample rates 
-  AliFMDUShortMap fRates;
+  AliFMDUShortMap fRates; // Sample rates
   ClassDef(AliFMDCalibSampleRate,2); // Sample rates 
 };