| 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 //
27 //
28 //
29 // John Allison 5th September 2018
30 // Originally G4PhysicalVolumeSearchScene, 10th August 1998, which only
31 // found the first occurrence of a volume.
32 // This class (note the extra 's' in the name) produces a vector of all
33 // occurrences. It can match a physical volume name with the required
34 // match. The latter can be of the form "/regexp/", where regexp is a
35 // regular expression (see C++ regex), or a plain string, in which case
36 // there must be an exact match.
37
38 #ifndef G4PHYSICALVOLUMESSEARCHSCENE_HH
39 #define G4PHYSICALVOLUMESSEARCHSCENE_HH
40
41 #include "G4PseudoScene.hh"
42
43 #include "G4VPhysicalVolume.hh"
44 #include "G4PhysicalVolumeModel.hh"
45
46 class G4PhysicalVolumesSearchScene: public G4PseudoScene
47 {
48 public:
49
50 G4PhysicalVolumesSearchScene
51 (G4PhysicalVolumeModel* pSearchVolumeModel, // usually a world
52 const G4String& requiredPhysicalVolumeName,
53 G4int requiredCopyNo = -1); // -1 means any copy no
54
55 virtual ~G4PhysicalVolumesSearchScene () {}
56
57 struct Findings
58 {
59 Findings
60 (G4VPhysicalVolume* pSearchPV,
61 G4VPhysicalVolume* pFoundPV,
62 G4int foundPVCopyNo = 0,
63 G4int foundDepth = 0,
64 const std::vector<G4PhysicalVolumeModel::G4PhysicalVolumeNodeID>&
65 foundBasePVPath = std::vector<G4PhysicalVolumeModel::G4PhysicalVolumeNodeID>(),
66 const std::vector<G4PhysicalVolumeModel::G4PhysicalVolumeNodeID>&
67 foundFullPVPath = std::vector<G4PhysicalVolumeModel::G4PhysicalVolumeNodeID>(),
68 const G4Transform3D& foundObjectTransformation = G4Transform3D())
69 : fpSearchPV(pSearchPV)
70 , fpFoundPV(pFoundPV)
71 , fFoundPVCopyNo(foundPVCopyNo)
72 , fFoundDepth(foundDepth)
73 , fFoundBasePVPath(foundBasePVPath)
74 , fFoundFullPVPath(foundFullPVPath)
75 , fFoundObjectTransformation(foundObjectTransformation) {}
76 Findings(const G4PhysicalVolumeModel::TouchableProperties& tp)
77 : fpSearchPV(nullptr)
78 , fpFoundPV(tp.fpTouchablePV)
79 , fFoundPVCopyNo(tp.fCopyNo)
80 , fFoundDepth(0)
81 , fFoundBasePVPath(tp.fTouchableBaseFullPVPath)
82 , fFoundFullPVPath(tp.fTouchableFullPVPath)
83 , fFoundObjectTransformation(tp.fTouchableGlobalTransform) {}
84 G4VPhysicalVolume* fpSearchPV; // Searched physical volume.
85 G4VPhysicalVolume* fpFoundPV; // Found physical volume.
86 G4int fFoundPVCopyNo; // Found Copy number.
87 G4int fFoundDepth; // Found depth.
88 std::vector<G4PhysicalVolumeModel::G4PhysicalVolumeNodeID>
89 fFoundBasePVPath; // Base path (e.g., empty for world volume)
90 std::vector<G4PhysicalVolumeModel::G4PhysicalVolumeNodeID>
91 fFoundFullPVPath; // Full path of found volume
92 G4Transform3D fFoundObjectTransformation; // Found transformation.
93 };
94
95 const std::vector<Findings>& GetFindings() const
96 {return fFindings;}
97
98 private:
99
100 class Matcher {
101 public:
102 Matcher(const G4String& requiredMatch);
103 G4bool Match(const G4String&);
104 // Match the string with the required match. The latter can be of the form
105 // "/regexp/", where regexp is a regular expression (see C++ regex),
106 // or a plain string, in which case there must be an exact match.
107 private:
108 G4bool fRegexFlag; // True if fRequiredMatch is of the form "/.../".
109 G4String fRequiredMatch;
110 };
111
112 void ProcessVolume(const G4VSolid&);
113
114 const G4PhysicalVolumeModel* fpSearchVolumesModel;
115 Matcher fMatcher;
116 G4int fRequiredCopyNo;
117 std::vector<Findings> fFindings;
118 };
119
120 #endif
121