Updating documentation

[u/mrichter/AliRoot.git] / TRD / AliTRDdigitsManager.h

diff --git a/TRD/AliTRDdigitsManager.h b/TRD/AliTRDdigitsManager.h
index da5d8664476bc2f5f38f79869ecea1138c759748..1972d53f59725363df27e9bb49ca2f161e5b22c8 100644 (file)
--- a/TRD/AliTRDdigitsManager.h
+++ b/TRD/AliTRDdigitsManager.h
@@ -1,94 +1,91 @@
-#ifndef TRDdigitsManager_H
-#define TRDdigitsManager_H
+#ifndef ALITRDDIGITSMANAGER_H
+#define ALITRDDIGITSMANAGER_H
 
 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                               */
 
-/* $Id: AliTRDdigitsManager.h,v */
+/* $Id$ */
 
 /////////////////////////////////////////////////////////////
 //  Manages the TRD digits                                 //
 /////////////////////////////////////////////////////////////
 
-#include "TObject.h"
+#include <TObject.h>
 
-#include "AliTRDsegmentArray.h"
-#include "AliTRDdataArrayI.h"
-#include "AliTRDdigit.h"
+class TFile;
+class TTree;
 
-const Int_t  kNDict = 3;
+class AliTRDsegmentArray;
+class AliTRDdataArray;
+class AliTRDdigit;
+class AliTRDSignalIndex;
 
 class AliTRDdigitsManager : public TObject {
 
  public:
 
-  AliTRDdigitsManager();
-  ~AliTRDdigitsManager();
+  enum { kNDict = 3 };
 
-  virtual Bool_t              MakeBranch();
-  virtual Bool_t              ReadDigits();
-  virtual Bool_t              WriteDigits();
+  AliTRDdigitsManager();
+  AliTRDdigitsManager(const AliTRDdigitsManager &m);
+  virtual ~AliTRDdigitsManager();
+  AliTRDdigitsManager &operator=(const AliTRDdigitsManager &m);
 
-  virtual void                SetRaw();
+  virtual void                Copy(TObject &m) const;
 
-  virtual Bool_t              IsRaw()                { return fIsRaw;         };
-  virtual AliTRDsegmentArray *GetDigits()            { return fDigits;        };
-  virtual AliTRDsegmentArray *GetDictionary(Int_t i) { return fDictionary[i]; };
+  virtual void                CreateArrays();
+  virtual void                ResetArrays();
+  virtual Bool_t              BuildIndexes(Int_t det);
 
-          AliTRDdigit        *GetDigit(Int_t row, Int_t col, Int_t time, Int_t det);
-          Int_t               GetTrack(Int_t track, Int_t row, Int_t col, Int_t time, Int_t det);
+  virtual Bool_t              MakeBranch(TTree *tree);
+  virtual Bool_t              ReadDigits(TTree *tree);
+  virtual Bool_t              WriteDigits();
 
-  inline  AliTRDdataArrayI   *GetDigits(Int_t det);
-  inline  AliTRDdataArrayI   *GetDictionary(Int_t det, Int_t i);
-  inline  Int_t               GetTrack(Int_t track, AliTRDdigit *Digit);
+  virtual void                SetEvent(Int_t evt)             { fEvent           = evt;  };
+  virtual void                SetSDigits(Int_t v = 1)         { fHasSDigits      = v;    };
+  virtual void                SetUseDictionaries(Bool_t kval) { fUseDictionaries = kval; };
 
- protected:
+  virtual Bool_t              UsesDictionaries() const        { return fUseDictionaries; };
+  virtual Bool_t              HasSDigits() const              { return fHasSDigits;      };
+  static  Int_t               NDict()                         { return fgkNDict;         }; 
 
-  AliTRDsegmentArray *fDigits;             //! Digits data Array
-  AliTRDsegmentArray *fDictionary[kNDict]; //! Track dictionary data array
+  virtual AliTRDsegmentArray *GetDigits() const               { return fDigits;          };
+  virtual AliTRDsegmentArray *GetDictionary(Int_t i) const    { return fDictionary[i];   };
 
-  Bool_t              fIsRaw;              //  Flag indicating raw digits
+          AliTRDdigit        *GetDigit(Int_t row, Int_t col, Int_t time, Int_t det) const;
+          Int_t               GetTrack(Int_t track, Int_t row, Int_t col
+                                     , Int_t time, Int_t det) const;
 
-  ClassDef(AliTRDdigitsManager,1)          //  Manages the TRD digits
+          AliTRDdataArray    *GetDigits(Int_t det) const;
+          AliTRDdataArray    *GetDictionary(Int_t det, Int_t i) const;
 
-};
+         AliTRDSignalIndex  *GetIndexes(Int_t det);
+         TObjArray          *GetIndexes()                    { return fSignalIndexes;   };
 
-//_____________________________________________________________________________
-inline AliTRDdataArrayI *AliTRDdigitsManager::GetDigits(Int_t det) 
-{
-  //
-  // Returns the digits array for one detector
-  //
+         void                RemoveDigits(Int_t det);
+         void                RemoveDictionaries(Int_t det);
+         void                ClearIndexes(Int_t det);
 
-  return (AliTRDdataArrayI *) fDigits->At(det);
+          Int_t               GetTrack(Int_t track, AliTRDdigit *digit) const;
+          Short_t             GetDigitAmp(Int_t row, Int_t col, Int_t time, Int_t det) const;
 
-}
+ protected:
 
-//_____________________________________________________________________________
-inline AliTRDdataArrayI *AliTRDdigitsManager::GetDictionary(Int_t det, Int_t i) 
-{
-  //
-  // Returns the dictionary for one detector
-  //
+  static const Int_t  fgkNDict;            //  Number of track dictionary arrays
 
-  return (AliTRDdataArrayI *) fDictionary[i]->At(det);
+  Int_t               fEvent;              //  Event number
+  TTree              *fTree;               //! Tree for the digits arrays
 
-}
+  AliTRDsegmentArray *fDigits;             //! Digits data array
+  AliTRDsegmentArray *fDictionary[kNDict]; //! Track dictionary data array
 
-//_____________________________________________________________________________
-inline Int_t AliTRDdigitsManager::GetTrack(Int_t track, AliTRDdigit *Digit)
-{
-  // 
-  // Returns the MC-track numbers from the dictionary for a given digit
-  //
+  Bool_t              fHasSDigits;         //  Switch for the summable digits
 
-  Int_t row  = Digit->GetRow();
-  Int_t col  = Digit->GetCol();
-  Int_t time = Digit->GetTime();
-  Int_t det  = Digit->GetDetector();
+  TObjArray          *fSignalIndexes;      //  Provides access to the active pads and tbins
+  Bool_t              fUseDictionaries;    //  Use dictionaries or not (case of real data)
 
-  return GetTrack(track,row,col,time,det);
+  ClassDef(AliTRDdigitsManager,7)          //  Manages the TRD digits
 
-}
+};
 
 #endif