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