- Revised comments and adapted them for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUONGeometryEnvelope.h
CommitLineData
30178c30 1/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
2 * See cxx source for full Copyright notice */
3
d1cd2474 4// $Id$
30178c30 5// Revision of includes 07/05/2004
692de412 6
7/// \ingroup geometry
8/// \class AliMUONGeometryEnvelope
9/// \brief Geometry envelope helper class
10///
11/// Helper class for definititon of an assembly of volumes.
12///
a9aad96e 13/// \author Ivana Hrivnacova, IPN Orsay
d1cd2474 14
15#ifndef ALI_MUON_GEOMETRY_ENVELOPE_H
16#define ALI_MUON_GEOMETRY_ENVELOPE_H
17
18#include <TNamed.h>
19
20class TGeoTranslation;
21class TGeoRotation;
22class TGeoCombiTrans;
23class TObjArray;
24
25class AliMUONGeometryEnvelope : public TNamed
26{
27 public:
c0b51181 28 AliMUONGeometryEnvelope(const TString& name, Int_t id,
29 Bool_t isVirtual, const char* only);
30 AliMUONGeometryEnvelope(const TString& name, Int_t id,
31 Int_t copyNo, const char* only);
d1cd2474 32 AliMUONGeometryEnvelope();
d1cd2474 33 virtual ~AliMUONGeometryEnvelope();
d1cd2474 34
35 // methods
36 void AddConstituent(const TString& name, Int_t copyNo);
37 void AddConstituent(const TString& name, Int_t copyNo,
38 const TGeoTranslation& translation);
39 void AddConstituent(const TString& name, Int_t copyNo,
40 const TGeoTranslation& translation,
41 const TGeoRotation& rotation);
c0b51181 42 void AddConstituent(const TString& name, Int_t copyNo,
43 const TGeoCombiTrans& transform);
d1cd2474 44
45 void AddConstituentParam(const TString& name, Int_t copyNo,
46 Int_t npar, Double_t* param);
47 void AddConstituentParam(const TString& name, Int_t copyNo,
48 const TGeoTranslation& translation,
49 Int_t npar, Double_t* param);
50 void AddConstituentParam(const TString& name, Int_t copyNo,
51 const TGeoTranslation& translation,
52 const TGeoRotation& rotation,
53 Int_t npar, Double_t* param);
c0b51181 54 void AddConstituentParam(const TString& name, Int_t copyNo,
55 const TGeoCombiTrans& transform,
56 Int_t npar, Double_t* param);
d1cd2474 57
58 void SetTranslation(const TGeoTranslation& translation);
59 void SetRotation(const TGeoRotation& rotation);
c0b51181 60 void SetTransform(const TGeoCombiTrans& transform);
d1cd2474 61
62 // get methods
63 Bool_t IsVirtual() const;
6b82c1f0 64 Bool_t IsMANY() const;
d1cd2474 65 Int_t GetCopyNo() const;
66 const TGeoCombiTrans* GetTransformation() const;
67 const TObjArray* GetConstituents() const;
68
30178c30 69 protected:
70 AliMUONGeometryEnvelope(const AliMUONGeometryEnvelope& rhs);
30178c30 71 AliMUONGeometryEnvelope& operator = (const AliMUONGeometryEnvelope& rhs);
72
d1cd2474 73 private:
829425a5 74 Bool_t fIsVirtual; ///< \brief true if envelope is not represented
75 /// by a real volume
76 Bool_t fIsMANY; ///< \brief true if envelope is placed with
77 /// MANY option
78 Int_t fCopyNo; ///< \brief copy number
79 /// (only non virtual envelope can have
80 /// more than one copy)
81 TGeoCombiTrans* fTransformation;///< \brief the envelope transformation wrt to the
82 /// mother frame (the chamber position)
83 TObjArray* fConstituents; ///< \brief the constituents names and transformations
84 /// wrt to the envelope position
d1cd2474 85
86 ClassDef(AliMUONGeometryEnvelope,1) // MUON chamber geometry base class
87};
88
89// inline functions
90
a9aad96e 91/// Return true if envelope is virtual
d1cd2474 92inline Bool_t AliMUONGeometryEnvelope::IsVirtual() const
93{ return fIsVirtual; }
94
a9aad96e 95/// Return true if envelope is placed with MANY option
6b82c1f0 96inline Bool_t AliMUONGeometryEnvelope::IsMANY() const
97{ return fIsMANY; }
98
a9aad96e 99/// Return copy number
d1cd2474 100inline Int_t AliMUONGeometryEnvelope::GetCopyNo() const
101{ return fCopyNo; }
102
a9aad96e 103/// Return the envelope transformation wrt to the mother frame
104/// (the chamber position)
d1cd2474 105inline const TGeoCombiTrans* AliMUONGeometryEnvelope::GetTransformation() const
106{ return fTransformation; }
107
a9aad96e 108/// Return the array of constituents names and transformations
109/// wrt to the envelope position
d1cd2474 110inline const TObjArray* AliMUONGeometryEnvelope::GetConstituents() const
111{ return fConstituents; }
112
113#endif //ALI_MUON_GEOMETRY_ENVELOPE_H