]> git.uio.no Git - u/mrichter/AliRoot.git/blob - FMD/AliFMDRawReader.h
Added a lot of Doxygen documentation
[u/mrichter/AliRoot.git] / FMD / AliFMDRawReader.h
1 #ifndef ALIFMDRAWREADER_H
2 #define ALIFMDRAWREADER_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights
4  * reserved. 
5  *
6  * Latest changes by Christian Holm Christensen <cholm@nbi.dk>
7  *
8  * See cxx source for full Copyright notice                               
9  */
10 /* $Id$ */
11 //____________________________________________________________________
12 // 
13 // Class to read ADC values from a AliRawReader object. 
14 // Note, that it uses an ALTRO reader, which is wrong. 
15 // Perhaps we need to implement it our selves
16 // 
17 #ifndef ROOT_TTask
18 # include <TTask.h>
19 #endif
20
21 //____________________________________________________________________
22 class AliRawReader;
23 class TTree;
24 class TClonesArray;
25
26
27 //____________________________________________________________________
28 /** @brief Class to read ALTRO formated raw data from an AliRawReader
29     object. 
30     @code 
31     AliRawReader*    reader    = new AliRawReaderFile(0);
32     AliFMDRawReader* fmdReader = new AliFMDRawReader(reader);
33     TClonesArray*    array     = new TClonesArray("AliFMDDigit");
34     fmdReader->ReadAdcs(array);
35     @endcode 
36     @ingroup FMD_rec
37 */
38 class AliFMDRawReader : public TTask 
39 {
40 public:
41   /** CTOR 
42       @param reader Raw reader
43       @param array  Output tree */
44   AliFMDRawReader(AliRawReader* reader, TTree* array);
45   /** DTOR */
46   virtual ~AliFMDRawReader() {}
47   /** Read in, and store in output tree 
48       @param option Not used */
49   virtual void   Exec(Option_t* option="");
50   /** Read ADC's into a TClonesArray of AliFMDDigit objects. 
51       @param array Array to read into 
52       @return @c true on success */
53   virtual Bool_t ReadAdcs(TClonesArray* array);
54 protected:
55   TTree*        fTree;       //! Pointer to tree to read into 
56   AliRawReader* fReader;     //! Pointer to raw reader 
57   UShort_t      fSampleRate; // The sample rate (if 0, inferred from data)
58   ClassDef(AliFMDRawReader, 0) // Read FMD raw data into a cache 
59 };
60
61 #endif
62 //____________________________________________________________________
63 //
64 // Local Variables:
65 //   mode: C++
66 // End:
67 //
68 // EOF
69 //