Comments for Doxygen (mostly added comments for inline functions)
[u/mrichter/AliRoot.git] / MUON / AliMUONStringIntMap.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
6 /// \ingroup geometry
7 /// \class AliMUONStringIntMap
8 /// \brief Substitutes map <string, int> which ALICE does not allow to use 
9 ///
10 /// \author Ivana Hrivnacova, IPN Orsay
11
12 #ifndef ALI_MUON_STRING_INT_MAP_H
13 #define ALI_MUON_STRING_INT_MAP_H
14
15 #include <TObject.h>
16 #include <TObjArray.h>
17 #include <TArrayI.h>
18
19 class AliMUONStringIntMap : public TObject
20 {
21   public:
22     AliMUONStringIntMap();
23     virtual ~AliMUONStringIntMap();
24     
25     // methods
26     Bool_t  Add(const TString& first, Int_t second);
27     Bool_t  Set(const TString& first, Int_t second);
28     Int_t Contains(const TString& first) const;
29     
30     Int_t   Get(const TString& first) const;
31     Int_t   GetNofItems() const;
32     virtual void Clear(Option_t* /*option*/ ="");
33     virtual void Print(const char* /*option*/ = "") const;
34     void Print(const TString& key, ofstream& out) const;
35     
36   protected:
37     /// Not implemented
38     AliMUONStringIntMap(const AliMUONStringIntMap& rhs);
39     /// Not implemented
40     AliMUONStringIntMap& operator = (const AliMUONStringIntMap& rhs);
41  
42   private:
43     // data members
44     Int_t      fNofItems;    ///< number of items
45     TObjArray  fFirstArray;  ///< first item array
46     TArrayI    fSecondArray; ///< second item array
47  
48   ClassDef(AliMUONStringIntMap,1)  // motif map
49 };    
50
51 #endif //ALI_MUON_STRING_INT_MAP_H