STEER/AliModule.h

   1 #ifndef ALIMODULE_H
   2 #define ALIMODULE_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 #include "Riostream.h"
   9
  10 #include "TAttLine.h"
  11 #include "TAttMarker.h"
  12 #include "TNamed.h"
  13
  14 #include "AliRndm.h"
  15
  16 class TClonesArray;
  17 class TBrowser;
  18 class TArrayI;
  19 class TFile;
  20 class TTree;
  21 class AliLoader;
  22 class AliTrackReference;
  23 class AliDigitizer;
  24 class AliRunDigitizer;
  25 class AliTracker;
  26 class AliESD;
  27 class AliRunLoader;
  28
  29
  30 class AliModule : public TNamed , public TAttLine, public TAttMarker,
  31                   public AliRndm {
  32 public:
  33
  34   // Creators - distructors
  35   AliModule(const char* name, const char *title);
  36   AliModule();
  37   AliModule(const AliModule &mod);
  38   virtual ~AliModule();
  39
  40   // Inline functions
  41   virtual  int           GetNdigits() const {return 0;}
  42   virtual  int           GetNhits()  const {return 0;}
  43   virtual  TArrayI      *GetIdtmed()   const {return fIdtmed;}
  44   virtual  TList        *Histograms() const {return fHistograms;}
  45   virtual  TList        *Nodes()  const {return fNodes;}
  46   virtual  TClonesArray *Digits() const {return 0;}
  47   virtual  TClonesArray *Hits()   const {return 0;}
  48   virtual  TObjArray    *Points() const {return 0;}
  49   virtual  Int_t         GetIshunt() const {return 0;}
  50   virtual  void          SetIshunt(Int_t) {}
  51   virtual  Bool_t        IsActive() const {return fActive;}
  52   virtual  Bool_t        IsFolder() const {return kTRUE;}
  53   virtual  Int_t&        LoMedium() {return fLoMedium;}
  54   virtual  Int_t&        HiMedium() {return fHiMedium;}
  55   virtual  Int_t         GetDebug() const {return fDebug;}
  56   virtual  void          SetDebug(Int_t deb=0) {fDebug=deb;}
  57
  58   // Module composition
  59   virtual void AliMaterial(Int_t imat, const char* name, Float_t a,
  60                            Float_t z, Float_t dens, Float_t radl,
  61                            Float_t absl, Float_t *buf=0, Int_t nwbuf=0) const;
  62   virtual void AliGetMaterial(Int_t imat, char* name, Float_t &a,
  63                               Float_t &z, Float_t &dens, Float_t &radl,
  64                               Float_t &absl) const;
  65   virtual void AliMixture(Int_t imat, const char *name, Float_t *a,
  66                           Float_t *z, Float_t dens, Int_t nlmat,
  67                           Float_t *wmat) const;
  68   virtual void AliMedium(Int_t numed, const char *name, Int_t nmat,
  69                           Int_t isvol, Int_t ifield, Float_t fieldm,
  70                           Float_t tmaxfd, Float_t stemax, Float_t deemax,
  71                           Float_t epsil, Float_t stmin, Float_t *ubuf=0,
  72                           Int_t nbuf=0) const;
  73   virtual void AliMatrix(Int_t &nmat, Float_t theta1, Float_t phi1,
  74                           Float_t theta2, Float_t phi2, Float_t theta3,
  75                           Float_t phi3) const;
  76
  77   // Virtual methods
  78   virtual void  BuildGeometry() {};
  79   virtual Int_t IsVersion() const =0;
  80
  81
  82   // Other methods
  83   virtual void        AddDigit(Int_t*, Int_t*){
  84   Error("AddDigit","Digits cannot be added to module %s\n",fName.Data());}
  85   virtual void        AddHit(Int_t, Int_t*, Float_t *) {
  86   Error("AddDigit","Hits cannot be added to module %s\n",fName.Data());}
  87   virtual void        Hits2SDigits() {}
  88   virtual AliDigitizer* CreateDigitizer(AliRunDigitizer* /*manager*/) const
  89     {return NULL;}
  90   virtual void        SDigits2Digits() {}
  91   virtual void        Hits2Digits() {}
  92   virtual void        Digits2Reco() {}
  93   virtual void        Reconstruct() const {}
  94   virtual AliTracker* CreateTracker() const {return NULL;}
  95   virtual void        FillESD(AliESD* /*esd*/) const {}
  96   virtual void        Digits2Raw() {}
  97   virtual void        Raw2Digits() {}
  98   virtual void        Browse(TBrowser *) {}
  99   virtual void        CreateGeometry() {}
 100   virtual void        CreateMaterials() {}
 101   virtual void        Disable();
 102   virtual void        Enable();
 103   virtual void        PreTrack(){}
 104   virtual void        PostTrack(){}
 105   virtual void        FinishEvent() {}
 106   virtual void        FinishRun() {}
 107   virtual void        FinishPrimary() {}
 108   virtual void        Init() {}
 109   virtual void        LoadPoints(Int_t ) {}
 110
 111
 112
 113   virtual void        MakeBranch(Option_t * /*opt =" "*/) {}
 114   virtual void        MakeTree(Option_t *) {}//skowron
 115
 116   virtual AliLoader*  MakeLoader(const char* topfoldername);//skowron
 117   virtual AliLoader*  GetLoader() const {return 0x0;} //skowron
 118
 119
 120   virtual void        Paint(Option_t *) {}
 121   virtual void        ResetDigits() {}
 122   virtual void        ResetSDigits() {}
 123   virtual void        ResetHits() {}
 124   virtual void        ResetPoints() {}
 125   virtual void        SetTreeAddress();
 126   virtual void        SetTimeGate(Float_t) {}
 127   virtual Float_t     GetTimeGate() const {return 1.e10;}
 128   virtual void        StepManager() {}
 129   virtual void        DisableStepManager() {fEnable = kFALSE;}
 130   virtual Bool_t      StepManagerIsEnabled() const {return fEnable;}
 131   virtual void        SetBufferSize(Int_t) {}
 132   virtual Float_t     ZMin() const;
 133   virtual Float_t     ZMax() const;
 134   virtual void        SetEuclidFile(char *material,char *geometry=0);
 135   virtual void        ReadEuclid(const char *filnam, char *topvol);
 136   virtual void        ReadEuclidMedia(const char *filnam);
 137 // Track reference related
 138   TClonesArray *TrackReferences()   const {return fTrackReferences;}
 139   virtual void        RemapTrackHitIDs(Int_t *) {}
 140   virtual void        RemapTrackReferencesIDs(Int_t *map); //remaping track references MI
 141   virtual void        ResetTrackReferences();
 142   virtual void        AddTrackReference(Int_t label);
 143   virtual  AliTrackReference * FirstTrackReference(Int_t track);
 144   virtual  AliTrackReference * NextTrackReference();
 145   virtual void        MakeBranchTR(Option_t *opt=" ");
 146   TTree* TreeTR();  //shorcut method for accessing treeTR from folder
 147
 148   void                SetRunLoader(AliRunLoader* runLoader)
 149     {fRunLoader = runLoader;}
 150
 151 //
 152   AliModule& operator=(const AliModule &mod)
 153     {mod.Copy(*this); return (*this);}
 154
 155 protected:
 156   void Copy(TObject &mod) const;
 157
 158   // Data members
 159
 160   TString       fEuclidMaterial;  //!Name of the Euclid file for materials (if any)
 161   TString       fEuclidGeometry;  //!Name of the Euclid file for geometry (if any)
 162
 163   TArrayI      *fIdtmed;      //!List of tracking medium numbers
 164   TArrayI      *fIdmate;      //!List of material numbers
 165   Int_t         fLoMedium;   //!Minimum tracking medium ID for this Module
 166   Int_t         fHiMedium;   //!Maximum tracking medium ID for this Module
 167
 168   Bool_t        fActive;      //Detector activity flag
 169   TList        *fHistograms;  //List of histograms
 170   TList        *fNodes;       //List of geometry nodes
 171   Int_t         fDebug;       //Debug flag
 172   Bool_t        fEnable;      //StepManager enabling flag
 173   TClonesArray *fTrackReferences;     //!list of track references - for one primary track only -MI
 174   Int_t         fMaxIterTrackRef;     //!for track refernce iterator routines
 175   Int_t         fCurrentIterTrackRef; //!for track refernce iterator routines
 176
 177   AliRunLoader* fRunLoader;   //!local pointer to run loader
 178
 179   ClassDef(AliModule,6)  //Base class for ALICE Modules
 180 };
 181 #endif