ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4PVParameterised.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4PVParameterised.hh
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // G4PVParameterised
27 //
28 // Class description:
29 //
30 // Represents many touchable detector elements differing in their
31 // positioning and dimensions. Both are calculated by means
32 // of a G4VParameterisation object. The positioning is assumed to
33 // be dominant along a cartesian axis (specified).
34 
35 // 29.07.95, P.Kent - first non-stub version
36 // ----------------------------------------------------------------------
37 #ifndef G4PVPARAMETERISED_HH
38 #define G4PVPARAMETERISED_HH
39 
40 #include "G4PVReplica.hh"
41 
43 {
44  public: // with description
45 
46  G4PVParameterised(const G4String& pName,
47  G4LogicalVolume* pLogical,
48  G4LogicalVolume* pMotherLogical,
49  const EAxis pAxis,
50  const G4int nReplicas,
51  G4VPVParameterisation* pParam,
52  G4bool pSurfChk = false);
53  // Replicate the volume nReplicas Times using the paramaterisation pParam,
54  // within the mother volume pMotherLogical.
55  // The positioning of the replicas is dominant along the specified axis.
56  // pSurfChk if true activates check for overlaps with existing volumes.
57 
58  public: // without description
59 
60  G4PVParameterised(const G4String& pName,
61  G4LogicalVolume* pLogical,
62  G4VPhysicalVolume* pMother,
63  const EAxis pAxis,
64  const G4int nReplicas,
65  G4VPVParameterisation* pParam,
66  G4bool pSurfChk = false);
67  // Almost exactly similar to first constructor, changing only mother
68  // pointer's type to PhysicalVolume.
69 
70  G4PVParameterised(__void__&);
71  // Fake default constructor for usage restricted to direct object
72  // persistency for clients requiring preallocation of memory for
73  // persistifiable objects.
74 
75  public: // with description
76 
77  virtual ~G4PVParameterised();
78  // Virtual empty destructor.
79 
80  G4bool IsParameterised() const;
81  // Returns true to identify it is a parameterised physical volume.
82 
83  EVolume VolumeType() const final;
84 
86  // Returns the current pointer to the parameterisation.
87 
88  void GetReplicationData(EAxis& axis,
89  G4int& nReplicas,
90  G4double& width,
92  G4bool& consuming) const;
93  // Fills arguments with the attributes from the base replica.
94 
95  virtual void SetRegularStructureId( G4int code );
96  // Method sets code and can prepare for special type of regular volumes.
97 
98  G4bool CheckOverlaps(G4int res = 1000, G4double tol = 0.,
99  G4bool verbose = true, G4int maxErr = 1);
100  // Verifies if each instance of the parameterised volume is overlapping
101  // with other instances or with the mother volume. Provides default
102  // resolution for the number of points to be generated and verified.
103  // A tolerance for the precision of the overlap check can be specified,
104  // by default it is set to maximum precision.
105  // Reports a maximum of overlaps errors according to parameter in input.
106  // Returns true if an overlap occurs.
107 
108  private:
109 
111 };
112 
113 #endif