Modifications in AliESDMuonTrack:

[u/mrichter/AliRoot.git] / MUON / AliMUONRawStreamTracker.h

diff --git a/MUON/AliMUONRawStreamTracker.h b/MUON/AliMUONRawStreamTracker.h
index 0554f09ae88c633c42b8df5c203d0970f0444dd8..7eb7dbe332fb8d832e46a4d99f3e89a3257ba903 100644 (file)
--- a/MUON/AliMUONRawStreamTracker.h
+++ b/MUON/AliMUONRawStreamTracker.h
@@ -9,21 +9,16 @@
 /// \class AliMUONRawStreamTracker
 /// \brief Class for reading MUON raw digits
 ///
-/// \author Christian Finck
-///
-///////////////////////////////////////////////////////////////////////////////
-///
-/// This class provides access to MUON digits in raw data.
-///
-///////////////////////////////////////////////////////////////////////////////
+//  Author: Christian Finck
 
 #include <TObject.h>
-#include <TClonesArray.h>
 #include "AliMUONPayloadTracker.h"
 
 class AliRawReader;
 class AliMUONDDLTracker;
-
+class AliMUONDspHeader;
+class AliMUONBusStruct;
+class AliMUONBlockHeader;
 
 class AliMUONRawStreamTracker: public TObject {
   public :
@@ -31,47 +26,107 @@ class AliMUONRawStreamTracker: public TObject {
     AliMUONRawStreamTracker(AliRawReader* rawReader);
     virtual ~AliMUONRawStreamTracker();
 
-    virtual Bool_t   Next();
-    virtual Bool_t   NextDDL();
-
+    /// Initialize iterator
+    void First();
+
+    /// Returns current DDL object during iteration
+    AliMUONDDLTracker* CurrentDDL() const { return fCurrentDDL; }
+    
+    /// Returns current BlockHeader object during iteration
+    AliMUONBlockHeader* CurrentBlockHeader() const { return fCurrentBlockHeader; }
+    
+    /// Returns current DspHeader object during iteration
+    AliMUONDspHeader* CurrentDspHeader() const { return fCurrentDspHeader; }
+    
+    /// Returns current BusStruct object during iteration
+    AliMUONBusStruct* CurrentBusStruct() const { return fCurrentBusStruct; }
+    
+    /// Advance one step in the iteration. Returns false if finished.
+    virtual Bool_t Next(Int_t& busPatchId, 
+                        UShort_t& manuId, UChar_t& manuChannel, 
+                        UShort_t& adc);
+    
+    virtual Bool_t NextDDL();
+
+    /// Return maximum number of DDL in DATE file
     Int_t GetMaxDDL()   const {return fMaxDDL;}
+    /// Return maximum number of block per DDL in DATE file
     Int_t GetMaxBlock() const {return  fPayload->GetMaxBlock();}
+    /// Return maximum number of Dsp per block in DATE file
     Int_t GetMaxDsp()   const {return  fPayload->GetMaxDsp();}
+    /// Return maximum number of Buspatch per Dsp in DATE file
     Int_t GetMaxBus()   const {return  fPayload->GetMaxBus();}
 
     // check input before assigment
     void SetMaxDDL(Int_t ddl);
     void SetMaxBlock(Int_t blk);
 
-    // does not check, done via BusPatchManager
+    /// Set maximum number of Dsp per block in DATE file
+    /// does not check, done via BusPatchManager
     void SetMaxDsp(Int_t dsp) {fPayload->SetMaxDsp(dsp);}
+    /// Set maximum number of Buspatch per Dsp in DATE file
+    /// does not check, done via BusPatchManager
     void SetMaxBus(Int_t bus) {fPayload->SetMaxBus(bus);}
 
-
+    /// Set object for reading the raw data
     void SetReader(AliRawReader* rawReader) {fRawReader = rawReader;}
 
-    AliMUONDDLTracker*      GetDDLTracker()   const {return fPayload->GetDDLTracker();}
-    Int_t                   GetDDL()          const {return fDDL - 1;}
+    /// Return pointer for DDL
+    AliMUONDDLTracker*      GetDDLTracker() const {return fPayload->GetDDLTracker();}
 
-  private :
+    /// Return pointer for payload
+    AliMUONPayloadTracker*  GetPayLoad()    const {return fPayload;}
 
-    AliRawReader*    fRawReader;    ///< object for reading the raw data
- 
-    Int_t  fDDL;          ///< number of DDL
-    Int_t  fBusPatchId;   ///< entry of buspatch structure
-    Int_t  fDspId;        ///< entry of Dsp header
-    Int_t  fBlkId;        ///< entry of Block header
+    /// Return number of DDL
+    Int_t                   GetDDL()        const {return fDDL - 1;}
 
-    Bool_t fNextDDL;      ///< flag for next DDL to be read
+    /// Whether the iteration is finished or not
+    Bool_t IsDone() const;
 
-    Int_t  fMaxDDL;       ///< maximum number of DDL in DATE file
 
-    AliMUONPayloadTracker* fPayload; ///< pointer to payload decoder
+    /// add error message into error logger
+    void AddErrorMessage();
+
+    /// Enable error info logger
+    void EnabbleErrorLogger() {fEnableErrorLogger = kTRUE;}
 
+    /// error numbers
+    enum rawStreamTrackerError {
+      kGlitchErr      = 1, ///< glitch error 
+      kPaddingWordErr = 2, ///< padding word error
+      kParityErr      = 3  ///< parity error
+    };
+
+  private :
+    /// Not implemented
     AliMUONRawStreamTracker(const AliMUONRawStreamTracker& stream);
+    /// Not implemented
     AliMUONRawStreamTracker& operator = (const AliMUONRawStreamTracker& stream);
 
-    ClassDef(AliMUONRawStreamTracker, 2)    // base class for reading MUON raw digits
+    Bool_t GetNextDDL();
+    Bool_t GetNextBlockHeader();
+    Bool_t GetNextDspHeader();
+    Bool_t GetNextBusStruct();
+
+ 
+ private:
+    AliRawReader*    fRawReader;    ///< object for reading the raw data  
+    Int_t  fDDL;          ///< number of DDL    
+    Int_t  fMaxDDL;       ///< maximum number of DDL in DATE file    
+    AliMUONPayloadTracker* fPayload; ///< pointer to payload decoder
+    
+    AliMUONDDLTracker* fCurrentDDL; //!< for iterator: current ddl ptr
+    Int_t fCurrentDDLIndex; //!< for iterator: current ddl index
+    AliMUONBlockHeader* fCurrentBlockHeader; //!< for iterator: current block ptr
+    Int_t fCurrentBlockHeaderIndex; //!< for iterator: current block index    
+    AliMUONDspHeader* fCurrentDspHeader; //!< for iterator: current dsp ptr
+    Int_t fCurrentDspHeaderIndex; //!< for iterator: current dsp index    
+    AliMUONBusStruct* fCurrentBusStruct; //!< for iterator: current bus ptr
+    Int_t fCurrentBusStructIndex; //!< for iterator: current bus index    
+    Int_t fCurrentDataIndex; //!< for iterator: current data index
+    Bool_t fEnableErrorLogger; //!< flag to enable the error info logger
+    
+    ClassDef(AliMUONRawStreamTracker, 3)    // base class for reading MUON raw digits
 };
 
 #endif