Updated/added comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpMotifReader.h
1 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
2  * See cxx source for full Copyright notice                               */
3
4 // $Id$
5 // $MpId: AliMpMotifReader.h,v 1.9 2006/05/24 13:58:18 ivana Exp $
6
7 /// \ingroup motif
8 /// \class AliMpMotifReader
9 /// \brief Class that takes care of reading the motifs data.
10 ///
11 /// \author David Guez, Ivana Hrivnacova; IPN Orsay
12
13 #ifndef ALI_MP_MOTIF_READER_H
14 #define ALI_MP_MOTIF_READER_H
15
16 #include <TObject.h>
17
18 #include "AliMpContainers.h"
19
20 #include "AliMpStationType.h"
21 #include "AliMpPlaneType.h"
22 #include "AliMpIntPair.h"
23 #include "AliMpContainers.h"
24
25 #ifdef WITH_ROOT
26 #include <TExMap.h>
27 #endif    
28 #include <TString.h>
29 #include <TVector2.h>
30 #include <Riostream.h>
31
32 #include <fstream>
33 #ifdef WITH_STL
34 #include <map>
35 #endif    
36
37 class AliMpMotifMap;
38 class AliMpVMotif;
39 class AliMpMotifSpecial;
40 class AliMpMotifType;
41
42 class AliMpMotifReader : public TObject
43 {
44   public:
45 #ifdef WITH_STL
46     /// Map of int pair to string
47     typedef std::map<std::string, std::pair<Int_t,Int_t> > PadMapType;
48     /// Map of int pair to string iterator
49     typedef PadMapType::iterator PadMapTypeIterator;
50 #endif    
51 #ifdef WITH_ROOT
52     /// Map of int pair to string
53     typedef TExMap PadMapType;
54 #endif    
55
56   public:
57     AliMpMotifReader(AliMp::StationType station, AliMp::PlaneType plane);
58     AliMpMotifReader();
59     virtual ~AliMpMotifReader();
60   
61     // methods   
62     AliMpMotifType*     BuildMotifType(const TString& motifTypeId);
63     AliMpMotifSpecial*  BuildMotifSpecial(const TString& motifID,
64                                           AliMpMotifType* motifType,
65                                           Double_t scale=1.0);
66     TString MotifSpecialName(const TString& motifID, Double_t scale);
67     
68   private:
69     /// Not implemented
70     AliMpMotifReader(const AliMpMotifReader& right);
71     /// Not implemented
72     AliMpMotifReader&  operator = (const AliMpMotifReader& right);
73
74     // data members  
75     AliMp::StationType  fStationType; ///< station type 
76     AliMp::PlaneType    fPlaneType;   ///< plane type 
77
78   ClassDef(AliMpMotifReader,1)  // Data reader
79 };
80
81 #endif //ALI_MP_MOTIF_READER_H