Corrected Doxygen warnings:
[u/mrichter/AliRoot.git] / MUON / AliMUONPayloadTracker.h
1 #ifndef ALIMUONPAYLOADTRACKER_H
2 #define ALIMUONPAYLOADTRACKER_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 raw
9 /// \class AliMUONPayloadTracker
10 /// \brief Class for decoding the payload for tracker raw data 
11 ///
12 //  Author Christian Finck
13
14 #include <TObject.h>
15
16 class AliMUONDDLTracker;
17 class AliMUONBusStruct;
18 class AliMUONDspHeader;
19 class AliMUONBlockHeader;
20
21 class AliMUONPayloadTracker: public TObject {
22   public :
23     AliMUONPayloadTracker();
24     virtual ~AliMUONPayloadTracker();
25
26     Int_t GetMaxBlock() const {return fMaxBlock;}
27     Int_t GetMaxDsp()   const {return fMaxDsp;}
28     Int_t GetMaxBus()   const {return fMaxBus;}
29
30     // check input before assigment
31     void SetMaxBlock(Int_t blk);
32
33     // does not check, done via BusPatchManager
34     void SetMaxDsp(Int_t dsp) {fMaxDsp = dsp;}
35     void SetMaxBus(Int_t bus) {fMaxBus = bus;}
36
37     void ResetDDL();
38
39     Bool_t Decode(UInt_t* buffer, Int_t datasize);
40
41     AliMUONBusStruct*       GetBusPatchInfo() const {return fBusStruct;}
42     AliMUONDDLTracker*      GetDDLTracker()   const {return fDDLTracker;}
43
44   private :
45
46     Int_t  fBusPatchId;   ///< entry of buspatch structure
47     Int_t  fDspId;        ///< entry of Dsp header
48     Int_t  fBlkId;        ///< entry of Block header
49
50     Int_t fMaxDDL;        ///< maximum number of DDL in DATE file
51     Int_t fMaxBlock;      ///< maximum number of block per DDL in DATE file
52     Int_t fMaxDsp;        ///< maximum number of Dsp per block in DATE file
53     Int_t fMaxBus;        ///< maximum number of Buspatch per Dsp in DATE file
54
55     AliMUONDDLTracker*      fDDLTracker;      //!< pointer for buspatch structure
56     AliMUONBusStruct*       fBusStruct;       //!< pointer for local structure
57     AliMUONBlockHeader*     fBlockHeader;     //!< pointer for block structure 
58     AliMUONDspHeader*       fDspHeader;       //!< pointer for dsp structure 
59
60     AliMUONPayloadTracker(const AliMUONPayloadTracker& stream);
61     AliMUONPayloadTracker& operator = (const AliMUONPayloadTracker& stream);
62
63     Bool_t CheckDataParity();
64
65     ClassDef(AliMUONPayloadTracker, 1)    // base class for reading MUON raw digits
66 };
67
68 #endif