Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUONTrackHit.h
1 #ifndef ALIMUONTRACKHIT_H
2 #define ALIMUONTRACKHIT_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 // Revision of includes 07/05/2004
8
9 /// \ingroup rec
10 /// \class AliMUONTrackHit
11 /// \brief Reconstructed track hit in ALICE dimuon spectrometer
12 ///
13 ////////////////////////////////////////////////////////
14 /// Reconstructed track hit in ALICE dimuon spectrometer
15 ////////////////////////////////////////////////////////
16
17 #include <TObject.h>
18 #include "AliMUONTrackParam.h" // object belongs to the class
19
20 class AliMUONHitForRec;
21
22 class AliMUONTrackHit : public TObject 
23 {
24  public:
25   AliMUONTrackHit(); // Constructor
26   virtual ~AliMUONTrackHit(); // Destructor
27   AliMUONTrackHit (const AliMUONTrackHit& AliMUONTrackHit); // copy constructor
28   AliMUONTrackHit& operator=(const AliMUONTrackHit& AliMUONTrackHit); // assignment operator
29   AliMUONTrackHit(AliMUONHitForRec* Hit); // Constructor from one HitForRec
30
31   // Inline functions for Get and Set
32   AliMUONHitForRec* GetHitForRecPtr(void) const {return fHitForRecPtr;}
33   AliMUONTrackParam* GetTrackParam(void) {return &(fTrackParam);}
34   void SetTrackParam(AliMUONTrackParam* TrackParam) {fTrackParam = *TrackParam;}
35
36   // What is necessary for sorting TClonesArray's; sufficient too ????
37   Bool_t IsSortable () const {
38     // necessary for sorting TClonesArray of TrackHit's
39     return kTRUE; }
40   Int_t Compare(const TObject* TrackHit) const; // "Compare" function for sorting
41
42
43  private:
44   void SetNextTrackHitWithSameHitForRec(AliMUONTrackHit *Next) {fNextTrackHitWithSameHitForRec = Next;}
45   void SetPrevTrackHitWithSameHitForRec(AliMUONTrackHit *Prev) {fPrevTrackHitWithSameHitForRec = Prev;}
46
47   AliMUONTrackParam fTrackParam; ///< Track parameters
48   AliMUONHitForRec *fHitForRecPtr; ///< Pointer to HitForRec
49   AliMUONTrackHit *fNextTrackHitWithSameHitForRec; ///< Pointer to next track hit with same HitForRec
50   AliMUONTrackHit *fPrevTrackHitWithSameHitForRec; ///< Pointer to previous track hit with same HitForRec
51
52   ClassDef(AliMUONTrackHit, 1) // Reconstructed track hit in ALICE dimuon spectrometer
53     };
54         
55 #endif