Removing leftover return

[u/mrichter/AliRoot.git] / MUON / AliMUONGeometryEnvelope.h

diff --git a/MUON/AliMUONGeometryEnvelope.h b/MUON/AliMUONGeometryEnvelope.h
index 9a2d843bd967c67e2817d02d9569bcc78477f24d..942705e2a21634fa92f24daf0e1cd79c7581269f 100644 (file)
--- a/MUON/AliMUONGeometryEnvelope.h
+++ b/MUON/AliMUONGeometryEnvelope.h
@@ -1,10 +1,16 @@
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice                               */
+
 // $Id$
-//
-// Class AliMUONGeometryEnvelope
-// -----------------------------
-// Helper class for definititon an assembly of volumes.
-//
-// Author: Ivana Hrivnacova, IPN Orsay
+// Revision of includes 07/05/2004
+
+/// \ingroup geometry
+/// \class AliMUONGeometryEnvelope
+/// \brief Geometry envelope helper class
+///
+/// Helper class for definititon of an assembly of volumes.
+///
+/// \author Ivana Hrivnacova, IPN Orsay
 
 #ifndef ALI_MUON_GEOMETRY_ENVELOPE_H
 #define ALI_MUON_GEOMETRY_ENVELOPE_H
@@ -19,16 +25,12 @@ class TObjArray;
 class AliMUONGeometryEnvelope : public TNamed
 {
   public:
-    AliMUONGeometryEnvelope(const TString& name, Bool_t isVirtual, 
-                            const char* only); 
-    AliMUONGeometryEnvelope(const TString& name, Int_t copyNo,
-                            const char* only); 
+    AliMUONGeometryEnvelope(const TString& name, Int_t id,  
+                            Bool_t isVirtual, const char* only); 
+    AliMUONGeometryEnvelope(const TString& name,  Int_t id,
+                            Int_t copyNo, const char* only); 
     AliMUONGeometryEnvelope();
-    AliMUONGeometryEnvelope(const AliMUONGeometryEnvelope& rhs);
     virtual ~AliMUONGeometryEnvelope();
-
-    // operators  
-    AliMUONGeometryEnvelope& operator = (const AliMUONGeometryEnvelope& rhs);
   
     // methods
     void  AddConstituent(const TString& name, Int_t copyNo); 
@@ -37,6 +39,8 @@ class AliMUONGeometryEnvelope : public TNamed
     void  AddConstituent(const TString& name, Int_t copyNo,
                          const TGeoTranslation& translation, 
                         const TGeoRotation& rotation);
+    void  AddConstituent(const TString& name, Int_t copyNo,
+                         const TGeoCombiTrans& transform); 
 
     void  AddConstituentParam(const TString& name, Int_t copyNo, 
                          Int_t npar, Double_t* param);
@@ -47,9 +51,13 @@ class AliMUONGeometryEnvelope : public TNamed
                          const TGeoTranslation& translation, 
                         const TGeoRotation& rotation,
                         Int_t npar, Double_t* param);
+    void  AddConstituentParam(const TString& name, Int_t copyNo, 
+                         const TGeoCombiTrans& transform,
+                        Int_t npar, Double_t* param);
 
     void  SetTranslation(const TGeoTranslation& translation);
     void  SetRotation(const TGeoRotation& rotation);
+    void  SetTransform(const TGeoCombiTrans& transform);
 
     // get methods
     Bool_t                 IsVirtual() const;  
@@ -58,36 +66,49 @@ class AliMUONGeometryEnvelope : public TNamed
     const TGeoCombiTrans*  GetTransformation() const;
     const TObjArray*       GetConstituents() const;
 
+  protected:
+    /// Not implemented
+    AliMUONGeometryEnvelope(const AliMUONGeometryEnvelope& rhs);
+    /// Not implemented
+    AliMUONGeometryEnvelope& operator = (const AliMUONGeometryEnvelope& rhs);
+
   private:
-    Bool_t           fIsVirtual;     // true if envelope is not represented
-                                     // by a real volume
-    Bool_t           fIsMANY;        // true if envelope is placed with
-                                     // MANY option
-    Int_t            fCopyNo;        // copy number 
-                                     // (only non virtual envelope can have 
-                                    //  more than one copy)
-    TGeoCombiTrans*  fTransformation;// the envelope transformation wrt to the
-                                     // mother frame (the chamber position)
-    TObjArray*       fConstituents;  // the constituents names and transformations
-                                    // wrt to the envelope position                                 
+    Bool_t           fIsVirtual;     ///< \brief true if envelope is not represented
+                                     /// by a real volume
+    Bool_t           fIsMANY;        ///< \brief true if envelope is placed with
+                                     /// MANY option
+    Int_t            fCopyNo;        ///< \brief copy number 
+                                     /// (only non virtual envelope can have 
+                                    ///  more than one copy)
+    TGeoCombiTrans*  fTransformation;///< \brief  the envelope transformation wrt to the
+                                     /// mother frame (the chamber position)
+    TObjArray*       fConstituents;  ///< \brief the constituents names and transformations
+                                    /// wrt to the envelope position                                 
  
   ClassDef(AliMUONGeometryEnvelope,1) // MUON chamber geometry base class
 };
 
 // inline functions
 
+/// Return true if envelope is virtual
 inline Bool_t AliMUONGeometryEnvelope::IsVirtual() const
 { return fIsVirtual; }  
 
+/// Return true if envelope is placed with MANY option
 inline Bool_t AliMUONGeometryEnvelope::IsMANY() const
 { return fIsMANY; }  
 
+/// Return copy number
 inline Int_t AliMUONGeometryEnvelope::GetCopyNo() const
 { return fCopyNo; }  
 
+/// Return the envelope transformation wrt to the mother frame 
+/// (the chamber position)
 inline const TGeoCombiTrans* AliMUONGeometryEnvelope::GetTransformation() const 
 { return fTransformation; }
 
+/// Return the array of constituents names and transformations 
+/// wrt to the envelope position
 inline const TObjArray* AliMUONGeometryEnvelope::GetConstituents() const
 { return fConstituents; }