// $Id$
// Revision of includes 07/05/2004
-//
-// Class AliMUONGeometryEnvelope
-// -----------------------------
-// Helper class for definititon an assembly of volumes.
-//
-// Author: Ivana Hrivnacova, IPN Orsay
+
+/// \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
const TObjArray* GetConstituents() const;
protected:
+ /// Not implemented
AliMUONGeometryEnvelope(const AliMUONGeometryEnvelope& rhs);
-
- // operators
+ /// 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; }