Correcting MUONGenerateGeometryData.C macro description
[u/mrichter/AliRoot.git] / MUON / AliMUONGeometrySVMap.cxx
index 6761d53..545d4ff 100644 (file)
 
 ClassImp(AliMUONGeometrySVMap)
 
-//
-// Class AliMUONStringIntMap
-//
-
-//______________________________________________________________________________
-AliMUONStringIntMap::AliMUONStringIntMap()
- : TObject(),
-   fNofItems(0),
-   fFirstArray(100),
-   fSecondArray(100)
-{
-// Standard constructor
-
-  fFirstArray.SetOwner(true);
-}
-
-//______________________________________________________________________________
-AliMUONStringIntMap::AliMUONStringIntMap(const AliMUONStringIntMap& rhs)
-  : TObject(rhs)
-{
-  AliFatal("Copy constructor is not implemented.");
-}
-
-//______________________________________________________________________________
-AliMUONStringIntMap& 
-AliMUONStringIntMap::operator = (const AliMUONStringIntMap& rhs) 
-{
-  // check assignement to self
-  if (this == &rhs) return *this;
-
-  AliFatal("Assignment operator is not implemented.");
-    
-  return *this;  
-}
-
-//______________________________________________________________________________
-AliMUONStringIntMap::~AliMUONStringIntMap()
-{
-// Destructor
-
-  fFirstArray.Delete();
-}
-
-
-//______________________________________________________________________________
-Bool_t  AliMUONStringIntMap::Add(const TString& first, Int_t second)
-{
-// Add map element if first not yet present
-// ---
-
-  Int_t second2 = Get(first);
-  if ( second2 > 0 ) {
-    AliError(Form("%s is already present in the map", first.Data()));
-    return false;
-  }
-  
-  // Resize TArrayI if needed
-  if (fSecondArray.GetSize() == fNofItems) fSecondArray.Set(2*fNofItems);
-  
-  fFirstArray.Add(new TObjString(first)); 
-  fSecondArray.AddAt(second, fNofItems);
-  fNofItems++;
-   
-  return true;
-}  
-
-//______________________________________________________________________________
-Int_t  AliMUONStringIntMap::Get(const TString& first) const
-{
-// Find the element with specified key (first)
-// ---
-  
-  for (Int_t i=0; i<fNofItems; i++) {
-    if ( ((TObjString*)fFirstArray.At(i))->GetString() == first )
-      return fSecondArray.At(i);
-  }
-  
-  return 0;
-}      
-
-//______________________________________________________________________________
-Int_t  AliMUONStringIntMap::GetNofItems() const
-{
-// Returns the number of elements
-// ---
-
-  return fNofItems;
-}  
-
-//______________________________________________________________________________
-void  AliMUONStringIntMap::Clear()
-{
-// Deletes the elements
-// ---
-
-  cout << "######### clearing map " << endl;
-
-  fNofItems = 0;
-  fFirstArray.Delete();
-  fSecondArray.Reset();
-
-  cout << "######### clearing map done " << endl;
-}  
-    
-//______________________________________________________________________________
-void AliMUONStringIntMap::Print(const char* /*option*/) const
-{
-// Prints the map elements
-
-  for (Int_t i=0; i<fNofItems; i++) {
-    cout << setw(4)
-         << i << "  "
-         << ((TObjString*)fFirstArray.At(i))->GetString()
-        << "  "
-        << setw(5)
-        << fSecondArray.At(i)
-        << endl;
-  }
-}       
-
-//______________________________________________________________________________
-void AliMUONStringIntMap::Print(const TString& key, ofstream& out) const
-{
-// Prints the map elements
-
-  for (Int_t i=0; i<fNofItems; i++) {
-    out  << key << "  "
-         << ((TObjString*)fFirstArray.At(i))->GetString()
-        << "  "
-        << setw(5)
-        << fSecondArray.At(i)
-        << endl;
-  }
-}       
-
-
-//
-// Class AliMUONGeometrySVMap
-//
-
 //______________________________________________________________________________
 AliMUONGeometrySVMap::AliMUONGeometrySVMap(Int_t initSize)
  : TObject(),
    fSVMap(),
    fSVPositions(initSize)
 { 
-// Standard constructor
+/// Standard constructor
   
   fSVPositions.SetOwner(true);
 }
@@ -196,19 +56,23 @@ AliMUONGeometrySVMap::AliMUONGeometrySVMap()
    fSVMap(),
    fSVPositions()
 {
-// Default constructor
+/// Default constructor
 }
 
 //______________________________________________________________________________
 AliMUONGeometrySVMap::AliMUONGeometrySVMap(const AliMUONGeometrySVMap& rhs)
   : TObject(rhs)
 {
+/// Protected copy constructor
+
   AliFatal("Copy constructor is not implemented.");
 }
 
 //______________________________________________________________________________
-AliMUONGeometrySVMap::~AliMUONGeometrySVMap() {
-//
+AliMUONGeometrySVMap::~AliMUONGeometrySVMap() 
+{
+/// Destructor
+
   fSVPositions.Delete();
 }
 
@@ -216,6 +80,8 @@ AliMUONGeometrySVMap::~AliMUONGeometrySVMap() {
 AliMUONGeometrySVMap& 
 AliMUONGeometrySVMap::operator = (const AliMUONGeometrySVMap& rhs) 
 {
+/// Protected assignement operator
+
   // check assignement to self
   if (this == &rhs) return *this;
 
@@ -232,8 +98,7 @@ AliMUONGeometrySVMap::operator = (const AliMUONGeometrySVMap& rhs)
 const TGeoCombiTrans* 
 AliMUONGeometrySVMap::FindByName(const TString& name) const
 {
-// Finds TGeoCombiTrans in the array of positions by name 
-// ---
+/// Find TGeoCombiTrans in the array of positions by name 
 
   for (Int_t i=0; i<fSVPositions.GetEntriesFast(); i++) { 
      TGeoCombiTrans* transform = (TGeoCombiTrans*) fSVPositions.At(i);
@@ -253,9 +118,8 @@ AliMUONGeometrySVMap::FindByName(const TString& name) const
 void AliMUONGeometrySVMap::Add(const TString& volumePath, 
                                Int_t detElemId)
 {
-// Add the specified sensitive volume path and the detElemId 
-// to the map
-// ---
+/// Add the specified sensitive volume path and the detElemId 
+/// to the map
  
   fSVMap.Add(volumePath, detElemId);
 }                        
@@ -264,9 +128,8 @@ void AliMUONGeometrySVMap::Add(const TString& volumePath,
 void AliMUONGeometrySVMap::AddPosition(const TString& volumePath, 
                               const TGeoTranslation& globalPosition)
 {
-// Add global position for the sensitive volume specified by volumePath  
-// in the array of transformations if this volumePath is not yet present. 
-// ---
+/// Add global position for the sensitive volume specified by volumePath  
+/// in the array of transformations if this volumePath is not yet present. 
  
   TGeoTranslation* newTransform = new TGeoTranslation(globalPosition);
   Int_t detElemId = fSVMap.Get(volumePath);
@@ -290,7 +153,7 @@ void AliMUONGeometrySVMap::AddPosition(const TString& volumePath,
 }                    
     
 //______________________________________________________________________________
-void AliMUONGeometrySVMap::Clear()
+void AliMUONGeometrySVMap::Clear(Option_t* /*option*/)
 {
 // Clears the sensitive volumes map
 
@@ -300,7 +163,7 @@ void AliMUONGeometrySVMap::Clear()
 //______________________________________________________________________________
 void AliMUONGeometrySVMap::ClearPositions()
 {
-// Clears the array of transformations
+/// Clear the array of transformations
 
   fSVPositions.Delete();
 }  
@@ -308,8 +171,7 @@ void AliMUONGeometrySVMap::ClearPositions()
 //______________________________________________________________________________
 void AliMUONGeometrySVMap::SortPositions()
 {
-// Sort the array of positions by names.
-// ---
+/// Sort the array of positions by names.
 
   fSVPositions.Sort(fSVPositions.GetEntriesFast());
 }
@@ -317,8 +179,7 @@ void AliMUONGeometrySVMap::SortPositions()
 //______________________________________________________________________________
 void  AliMUONGeometrySVMap::Print(const char* option) const
 {    
-// Prints the map of sensitive volumes and detector elements 
-// ---
+/// Print the map of sensitive volumes and detector elements 
 
   fSVMap.Print(option);
 }  
@@ -326,8 +187,7 @@ void  AliMUONGeometrySVMap::Print(const char* option) const
 //______________________________________________________________________________
 void  AliMUONGeometrySVMap::PrintPositions() const
 {
-// Prints the sensitive volumes global positions
-// ---
+/// Print the sensitive volumes global positions
 
   for (Int_t i=0; i<fSVPositions.GetEntriesFast(); i++) {
     
@@ -354,9 +214,8 @@ void  AliMUONGeometrySVMap::PrintPositions() const
 //______________________________________________________________________________
 void  AliMUONGeometrySVMap::WriteMap(ofstream& out) const
 {    
-// Prints the map of sensitive volumes and detector elements 
-// into specified stream
-// ---
+/// Print the map of sensitive volumes and detector elements 
+/// into specified stream
 
   fSVMap.Print("SV", out);
 }  
@@ -364,8 +223,7 @@ void  AliMUONGeometrySVMap::WriteMap(ofstream& out) const
 //______________________________________________________________________________
 Int_t  AliMUONGeometrySVMap::GetDetElemId(const TString& volumePath) const
 {
-// Returns detection element Id for the sensitive volume specified by path
-// ---
+/// Return detection element Id for the sensitive volume specified by path
 
   return fSVMap.Get(volumePath);
 }