| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // G4GDMLRead << 26 //
>> 27 // $Id: G4GDMLRead.hh,v 1.33 2010-11-17 10:47:02 gcosmo Exp $
>> 28 // GEANT4 tag $Name: not supported by cvs2svn $
>> 29 //
>> 30 // class G4GDMLRead
27 // 31 //
28 // Class description: 32 // Class description:
29 // 33 //
30 // GDML reader. 34 // GDML reader.
31 35
32 // Author: Zoltan Torzsok, November 2007 << 36 // History:
33 // ------------------------------------------- << 37 // - Created. Zoltan Torzsok, November 2007
34 #ifndef G4GDMLBASE_HH << 38 // -------------------------------------------------------------------------
35 #define G4GDMLBASE_HH 1 << 39
>> 40 #ifndef _G4GDMLBASE_INCLUDED_
>> 41 #define _G4GDMLBASE_INCLUDED_
36 42
37 #include <xercesc/parsers/XercesDOMParser.hpp> 43 #include <xercesc/parsers/XercesDOMParser.hpp>
38 #include <xercesc/util/PlatformUtils.hpp> 44 #include <xercesc/util/PlatformUtils.hpp>
39 #include <xercesc/sax/HandlerBase.hpp> 45 #include <xercesc/sax/HandlerBase.hpp>
40 #include <xercesc/util/XMLUni.hpp> 46 #include <xercesc/util/XMLUni.hpp>
41 #include <xercesc/dom/DOM.hpp> 47 #include <xercesc/dom/DOM.hpp>
42 48
43 #include "G4Types.hh" 49 #include "G4Types.hh"
44 50
45 #include "G4GDMLEvaluator.hh" 51 #include "G4GDMLEvaluator.hh"
46 #include "G4GDMLAuxStructType.hh" <<
47 52
48 class G4LogicalVolume; 53 class G4LogicalVolume;
49 class G4VPhysicalVolume; 54 class G4VPhysicalVolume;
50 55
51 class G4GDMLErrorHandler : public xercesc::Err 56 class G4GDMLErrorHandler : public xercesc::ErrorHandler
52 { 57 {
53 public: << 58 G4bool Suppress;
>> 59
>> 60 public:
54 61
55 G4GDMLErrorHandler(const G4bool set) { Sup << 62 G4GDMLErrorHandler(const G4bool set) { Suppress = set; }
56 63
57 void warning(const xercesc::SAXParseExcept << 64 void warning(const xercesc::SAXParseException& exception)
58 { << 65 {
59 if(Suppress) << 66 if (Suppress) { return; }
60 { <<
61 return; <<
62 } <<
63 char* message = xercesc::XMLString::tran 67 char* message = xercesc::XMLString::transcode(exception.getMessage());
64 G4cout << "G4GDML: VALIDATION WARNING! " 68 G4cout << "G4GDML: VALIDATION WARNING! " << message
65 << " at line: " << exception.getL 69 << " at line: " << exception.getLineNumber() << G4endl;
66 xercesc::XMLString::release(&message); 70 xercesc::XMLString::release(&message);
67 } << 71 }
68 72
69 void error(const xercesc::SAXParseExceptio << 73 void error(const xercesc::SAXParseException& exception)
70 { << 74 {
71 if(Suppress) << 75 if (Suppress) { return; }
72 { <<
73 return; <<
74 } <<
75 char* message = xercesc::XMLString::tran 76 char* message = xercesc::XMLString::transcode(exception.getMessage());
76 G4cout << "G4GDML: VALIDATION ERROR! " < 77 G4cout << "G4GDML: VALIDATION ERROR! " << message
77 << " at line: " << exception.getL 78 << " at line: " << exception.getLineNumber() << G4endl;
78 xercesc::XMLString::release(&message); 79 xercesc::XMLString::release(&message);
79 } << 80 }
80 81
81 void fatalError(const xercesc::SAXParseExc << 82 void fatalError(const xercesc::SAXParseException& exception)
82 { << 83 {
83 error(exception); 84 error(exception);
84 } << 85 }
85 void resetErrors() {} << 86 void resetErrors() {}
86 <<
87 private: <<
88 <<
89 G4bool Suppress = false; <<
90 }; 87 };
91 88
92 class G4GDMLRead 89 class G4GDMLRead
93 { 90 {
94 public: <<
95 91
96 virtual void DefineRead(const xercesc::DOM << 92 public: // with description
97 virtual void MaterialsRead(const xercesc:: << 93
98 virtual void SetupRead(const xercesc::DOME << 94 virtual void DefineRead(const xercesc::DOMElement* const)=0;
99 virtual void SolidsRead(const xercesc::DOM << 95 virtual void MaterialsRead(const xercesc::DOMElement* const)=0;
100 virtual void Paramvol_contentRead(const xe << 96 virtual void SetupRead(const xercesc::DOMElement* const)=0;
101 virtual void Volume_contentRead(const xerc << 97 virtual void SolidsRead(const xercesc::DOMElement* const)=0;
102 virtual void StructureRead(const xercesc:: << 98 virtual void Paramvol_contentRead(const xercesc::DOMElement* const)=0;
103 // << 99 virtual void Volume_contentRead(const xercesc::DOMElement* const)=0;
104 // Pure virtual methods implemented in con << 100 virtual void StructureRead(const xercesc::DOMElement* const)=0;
105 << 101 //
106 virtual void ExtensionRead(const xercesc:: << 102 // Pure virtual methods implemented in concrete reader plugin's classes
107 // << 103
108 // To be implemented in the client code fo << 104 virtual void ExtensionRead(const xercesc::DOMElement* const);
109 // to the GDML schema, identified with the << 105 //
110 // The implementation should be placed ins << 106 // To be implemented in the client code for handling extensions
111 // inheriting from G4GDMLReadStructure and << 107 // to the GDML schema, identified with the tag "extension".
112 // as argument to G4GDMLParser. << 108 // The implementation should be placed inside a user-class
113 << 109 // inheriting from G4GDMLReadStructure and being registered
114 virtual void UserinfoRead(const xercesc::D << 110 // as argument to G4GDMLParser.
115 // << 111
116 // Customisable by user to handle "userinf << 112 virtual G4LogicalVolume* GetVolume(const G4String&) const=0;
117 // GDML schema, identified by the tag "use << 113 virtual G4String GetSetup(const G4String&)=0;
118 << 114 //
119 virtual G4LogicalVolume* GetVolume(const G << 115 // More pure virtual methods implemented in the reader plugin.
120 virtual G4String GetSetup(const G4String&) << 116
121 // << 117 void Read(const G4String&, G4bool validation,
122 // More pure virtual methods implemented i << 118 G4bool isModule, G4bool strip=true);
123 << 119 //
124 void Read(const G4String&, G4bool validati << 120 // Main method for reading GDML files.
125 G4bool strip = true); << 121
126 // << 122 void StripNames() const;
127 // Main method for reading GDML files. << 123 //
128 << 124 // Strip off pointers from entity IDs.
129 void StripNames() const; << 125
130 void StripName(G4String&) const; << 126 void OverlapCheck(G4bool);
131 // << 127 //
132 // Strip off pointers from entity IDs. << 128 // Activate/de-activate surface check for overlaps (default is off)
133 << 129
134 const G4String& GetSchemaFile() const; << 130 protected:
135 void SetSchemaFile(const G4String& schemaF << 131
136 // << 132 G4GDMLRead();
137 // Set/Get alternative XML schema path/fil << 133 virtual ~G4GDMLRead();
138 << 134
139 void OverlapCheck(G4bool); << 135 G4String Transcode(const XMLCh* const);
140 // << 136 G4String GenerateName(const G4String& name, G4bool strip=false);
141 // Activate/de-activate surface check for << 137 G4String Strip(const G4String&) const;
142 << 138 void StripName(G4String&) const;
143 const G4GDMLAuxListType* GetAuxList() cons << 139 void GeneratePhysvolName(const G4String&,G4VPhysicalVolume*);
144 << 140 void LoopRead(const xercesc::DOMElement* const,
145 protected: << 141 void(G4GDMLRead::*)(const xercesc::DOMElement* const));
146 << 142
147 G4GDMLRead(); << 143 protected:
148 virtual ~G4GDMLRead(); << 144
149 << 145 G4GDMLEvaluator eval;
150 G4String Transcode(const XMLCh* const); << 146 G4bool validate;
151 G4String GenerateName(const G4String& name << 147 G4bool check;
152 G4String Strip(const G4String&) const; << 148
153 void GeneratePhysvolName(const G4String&, << 149 private:
154 void LoopRead(const xercesc::DOMElement* c <<
155 void (G4GDMLRead::*)(const x <<
156 <<
157 G4GDMLAuxStructType AuxiliaryRead(const xe <<
158 <<
159 protected: <<
160 <<
161 G4GDMLEvaluator eval; <<
162 G4bool validate = true; <<
163 G4bool check = false; <<
164 G4bool dostrip = true; <<
165 G4String schema = ""; <<
166 150
167 private: << 151 G4int inLoop, loopCount;
168 152
169 G4int inLoop = 0, loopCount = 0; <<
170 G4GDMLAuxListType auxGlobalList; <<
171 }; 153 };
172 154
173 #endif 155 #endif
174 156