Updated/added comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpFiles.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: AliMpFiles.h,v 1.10 2006/05/24 13:58:07 ivana Exp $
6
7 /// \ingroup basic
8 /// \class AliMpFiles
9 /// \brief Class for generating file names and paths.
10 ///
11 /// The input files:
12 /// - zones.dat, zones_special.dat - sector description
13 /// - motif*.dat   - motif description (generated from Exceed)
14 /// - padPos*.dat  - pad positions in motif
15 ///
16 /// \author David Guez, Ivana Hrivnacova; IPN Orsay
17
18 #ifndef ALI_MP_FILES_H
19 #define ALI_MP_FILES_H
20
21 #include <TObject.h>
22
23 #include "AliMpStationType.h"
24 #include "AliMpPlaneType.h"
25
26 #include <TString.h>
27
28 class AliMpFiles : public TObject
29 {
30   public:
31     // --> protected
32     //AliMpFiles();
33     //AliMpFiles(const AliMpFiles& right);
34     virtual ~AliMpFiles();
35   
36     //
37     // methods
38     //
39     
40     // bus patch
41     //
42     static TString BusPatchFilePath(); 
43
44     // de names
45     //
46     static TString DENamesFilePath(AliMp::StationType stationType);
47
48     // trigger
49     //
50     static TString LocalTriggerBoardMapping();
51   
52     // slats
53     //
54     static TString SlatFilePath(AliMp::StationType stationType, 
55                                 const char* slatType, AliMp::PlaneType plane);
56     static TString SlatPCBFilePath(AliMp::StationType stationType, 
57                                 const char* pcbType);
58     // sectors
59     //
60     static TString SectorFilePath(AliMp::StationType station, 
61                                   AliMp::PlaneType plane);
62     static TString SectorSpecialFilePath(AliMp::StationType station, 
63                                   AliMp::PlaneType plane);
64     static TString SectorSpecialFilePath2(AliMp::StationType station, 
65                                   AliMp::PlaneType plane);
66     // motifs
67     //
68     static TString MotifFilePath(AliMp::StationType station, 
69                                  AliMp::PlaneType plane, 
70                                  const TString& motifTypeID);
71     static TString MotifFileName(const TString& motifTypeID);
72     static TString MotifSpecialFilePath(AliMp::StationType station,
73                                  AliMp::PlaneType plane, const TString& motifID);
74     static TString MotifSpecialFileName(const TString& motifID);
75     static TString PadPosFilePath(AliMp::StationType station, 
76                                  AliMp::PlaneType plane, const TString& motifTypeID);
77     static TString PadPosFileName(const TString& motifTypeID);
78
79     static TString BergToGCFilePath(AliMp::StationType station);
80
81     static TString ManuToSerialPath(const TString& deName, AliMp::StationType station);
82
83   
84     // set methods
85     static void SetTopPath(const TString& topPath);
86   
87   private: 
88     /// Not implemented
89     AliMpFiles();
90     /// Not implemented
91     AliMpFiles(const AliMpFiles& right);
92     /// Not implemented
93     AliMpFiles& operator=(const AliMpFiles& right);    
94
95     // methods
96     static TString GetTop();
97     static TString PlaneDataDir(AliMp::StationType station, AliMp::PlaneType plane); 
98     static TString StationDataDir(AliMp::StationType station); 
99   
100     // static data members  
101     static const TString fgkDataDir;       ///< data directory
102     static const TString fgkStationDir;    ///< station directory
103     static const TString fgkBendingDir;    ///< bending plane directory
104     static const TString fgkNonBendingDir; ///< non-bending plane directory
105     static const TString fgkDENames;       ///< DE names data file name
106     static const TString fgkSector;        ///< sector data file name
107     static const TString fgkSectorSpecial; ///< sector special data file name
108     static const TString fgkSectorSpecial2;///< sector special data file name
109     static const TString fgkMotifPrefix;   ///< motif data file name
110     static const TString fgkMotifSpecialPrefix; ///< special motif data file name 
111     static const TString fgkManuToSerialDir;///< manu to serial file directory
112     static const TString fgkManuToSerial;  ///< manu to serial file name suffix
113     static const TString fgkPadPosPrefix;  ///< pad position data file name
114     static const TString fgkDataExt;       ///< file extension
115     static const TString fgkBergToGCFileName;  ///< BergToGC mapping file name
116     static const TString fgkTriggerLocalBoards;///<  local board name to id mapping
117     static const TString fgkBusPatchFileName;  ///< DetElemIdToBusPatch file name
118
119   ClassDef(AliMpFiles, 0) //File names and paths 
120 };  
121
122 #endif //ALI_MP_FILES_H