Added documentation of each file.
[u/mrichter/AliRoot.git] / FMD / AliFMDRawReader.h
CommitLineData
e802be3e 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$ */
c2fc1258 11/** @file AliFMDRawReader.h
12 @author Christian Holm Christensen <cholm@nbi.dk>
13 @date Mon Mar 27 12:45:23 2006
14 @brief Class to read raw data
15*/
e802be3e 16//____________________________________________________________________
17//
18// Class to read ADC values from a AliRawReader object.
088f8e79 19// Note, that it uses an ALTRO reader, which is wrong.
20// Perhaps we need to implement it our selves
e802be3e 21//
e802be3e 22#ifndef ROOT_TTask
23# include <TTask.h>
24#endif
25
26//____________________________________________________________________
27class AliRawReader;
1a1fdef7 28class TTree;
d760ea03 29class TClonesArray;
e802be3e 30
31
32//____________________________________________________________________
9f662337 33/** @brief Class to read ALTRO formated raw data from an AliRawReader
34 object.
35 @code
36 AliRawReader* reader = new AliRawReaderFile(0);
37 AliFMDRawReader* fmdReader = new AliFMDRawReader(reader);
38 TClonesArray* array = new TClonesArray("AliFMDDigit");
39 fmdReader->ReadAdcs(array);
40 @endcode
41 @ingroup FMD_rec
42*/
e802be3e 43class AliFMDRawReader : public TTask
44{
45public:
9f662337 46 /** CTOR
47 @param reader Raw reader
48 @param array Output tree */
1a1fdef7 49 AliFMDRawReader(AliRawReader* reader, TTree* array);
9f662337 50 /** DTOR */
088f8e79 51 virtual ~AliFMDRawReader() {}
9f662337 52 /** Read in, and store in output tree
53 @param option Not used */
d760ea03 54 virtual void Exec(Option_t* option="");
9f662337 55 /** Read ADC's into a TClonesArray of AliFMDDigit objects.
56 @param array Array to read into
57 @return @c true on success */
d760ea03 58 virtual Bool_t ReadAdcs(TClonesArray* array);
e802be3e 59protected:
1a1fdef7 60 TTree* fTree; //! Pointer to tree to read into
e802be3e 61 AliRawReader* fReader; //! Pointer to raw reader
62 UShort_t fSampleRate; // The sample rate (if 0, inferred from data)
63 ClassDef(AliFMDRawReader, 0) // Read FMD raw data into a cache
64};
65
66#endif
67//____________________________________________________________________
68//
69// Local Variables:
70// mode: C++
71// End:
72//
73// EOF
74//