Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUONRawStreamTracker.h
1 #ifndef ALIMUONRAWSTREAMTRACKER_H
2 #define ALIMUONRAWSTREAMTRACKER_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 /*$Id$*/
7
8 /// \ingroup base
9 /// \class AliMUONRawStreamTracker
10 /// \brief Class for reading MUON raw digits
11 ///
12 //  Author: Christian Finck
13
14 #include <TObject.h>
15 #include "AliMUONPayloadTracker.h"
16
17 class AliRawReader;
18 class AliMUONDDLTracker;
19
20
21 class AliMUONRawStreamTracker: public TObject {
22   public :
23     AliMUONRawStreamTracker();
24     AliMUONRawStreamTracker(AliRawReader* rawReader);
25     virtual ~AliMUONRawStreamTracker();
26
27     virtual Bool_t   Next();
28     virtual Bool_t   NextDDL();
29
30     Int_t GetMaxDDL()   const {return fMaxDDL;}
31     Int_t GetMaxBlock() const {return  fPayload->GetMaxBlock();}
32     Int_t GetMaxDsp()   const {return  fPayload->GetMaxDsp();}
33     Int_t GetMaxBus()   const {return  fPayload->GetMaxBus();}
34
35     // check input before assigment
36     void SetMaxDDL(Int_t ddl);
37     void SetMaxBlock(Int_t blk);
38
39     // does not check, done via BusPatchManager
40     void SetMaxDsp(Int_t dsp) {fPayload->SetMaxDsp(dsp);}
41     void SetMaxBus(Int_t bus) {fPayload->SetMaxBus(bus);}
42
43
44     void SetReader(AliRawReader* rawReader) {fRawReader = rawReader;}
45
46     AliMUONDDLTracker*      GetDDLTracker()   const {return fPayload->GetDDLTracker();}
47     Int_t                   GetDDL()          const {return fDDL - 1;}
48
49   private :
50
51     AliRawReader*    fRawReader;    ///< object for reading the raw data
52  
53     Int_t  fDDL;          ///< number of DDL
54     Int_t  fBusPatchId;   ///< entry of buspatch structure
55     Int_t  fDspId;        ///< entry of Dsp header
56     Int_t  fBlkId;        ///< entry of Block header
57
58     Bool_t fNextDDL;      ///< flag for next DDL to be read
59
60     Int_t  fMaxDDL;       ///< maximum number of DDL in DATE file
61
62     AliMUONPayloadTracker* fPayload; ///< pointer to payload decoder
63
64     AliMUONRawStreamTracker(const AliMUONRawStreamTracker& stream);
65     AliMUONRawStreamTracker& operator = (const AliMUONRawStreamTracker& stream);
66
67     ClassDef(AliMUONRawStreamTracker, 2)    // base class for reading MUON raw digits
68 };
69
70 #endif