| Geant4 Cross Reference |
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 1
39
40 #include "G4PVReplica.hh"
41
42 class G4PVParameterised : public G4PVReplica
43 {
44 public:
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 G4PVParameterised(const G4String& pName,
59 G4LogicalVolume* pLogical,
60 G4VPhysicalVolume* pMother,
61 const EAxis pAxis,
62 const G4int nReplicas,
63 G4VPVParameterisation* pParam,
64 G4bool pSurfChk = false);
65 // Almost exactly similar to first constructor, changing only mother
66 // pointer's type to PhysicalVolume.
67
68 G4PVParameterised(__void__&);
69 // Fake default constructor for usage restricted to direct object
70 // persistency for clients requiring preallocation of memory for
71 // persistifiable objects.
72
73 ~G4PVParameterised() override;
74 // Virtual empty destructor.
75
76 G4bool IsParameterised() const override;
77 // Returns true to identify it is a parameterised physical volume.
78
79 EVolume VolumeType() const final;
80
81 G4VPVParameterisation* GetParameterisation() const override;
82 // Returns the current pointer to the parameterisation.
83
84 void GetReplicationData(EAxis& axis,
85 G4int& nReplicas,
86 G4double& width,
87 G4double& offset,
88 G4bool& consuming) const override;
89 // Fills arguments with the attributes from the base replica.
90
91 void SetRegularStructureId( G4int code ) override;
92 // Method sets code and can prepare for special type of regular volumes.
93
94 G4bool CheckOverlaps(G4int res = 1000, G4double tol = 0.,
95 G4bool verbose = true, G4int maxErr = 1) override;
96 // Verifies if each instance of the parameterised volume is overlapping
97 // with other instances or with the mother volume. Provides default
98 // resolution for the number of points to be generated and verified.
99 // A tolerance for the precision of the overlap check can be specified,
100 // by default it is set to maximum precision.
101 // Reports a maximum of overlaps errors according to parameter in input.
102 // Returns true if an overlap occurs.
103
104 private:
105
106 G4VPVParameterisation* fparam = nullptr;
107 };
108
109 #endif
110