Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/persistency/gdml/include/G4GDMLRead.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /persistency/gdml/include/G4GDMLRead.hh (Version 11.3.0) and /persistency/gdml/include/G4GDMLRead.hh (Version 11.2)


  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 // G4GDMLRead
 27 //                                                 27 //
 28 // Class description:                              28 // Class description:
 29 //                                                 29 //
 30 // GDML reader.                                    30 // GDML reader.
 31                                                    31 
 32 // Author: Zoltan Torzsok, November 2007           32 // Author: Zoltan Torzsok, November 2007
 33 // -------------------------------------------     33 // --------------------------------------------------------------------
 34 #ifndef G4GDMLBASE_HH                              34 #ifndef G4GDMLBASE_HH
 35 #define G4GDMLBASE_HH 1                            35 #define G4GDMLBASE_HH 1
 36                                                    36 
 37 #include <xercesc/parsers/XercesDOMParser.hpp>     37 #include <xercesc/parsers/XercesDOMParser.hpp>
 38 #include <xercesc/util/PlatformUtils.hpp>          38 #include <xercesc/util/PlatformUtils.hpp>
 39 #include <xercesc/sax/HandlerBase.hpp>             39 #include <xercesc/sax/HandlerBase.hpp>
 40 #include <xercesc/util/XMLUni.hpp>                 40 #include <xercesc/util/XMLUni.hpp>
 41 #include <xercesc/dom/DOM.hpp>                     41 #include <xercesc/dom/DOM.hpp>
 42                                                    42 
 43 #include "G4Types.hh"                              43 #include "G4Types.hh"
 44                                                    44 
 45 #include "G4GDMLEvaluator.hh"                      45 #include "G4GDMLEvaluator.hh"
 46 #include "G4GDMLAuxStructType.hh"                  46 #include "G4GDMLAuxStructType.hh"
 47                                                    47 
 48 class G4LogicalVolume;                             48 class G4LogicalVolume;
 49 class G4VPhysicalVolume;                           49 class G4VPhysicalVolume;
 50                                                    50 
 51 class G4GDMLErrorHandler : public xercesc::Err     51 class G4GDMLErrorHandler : public xercesc::ErrorHandler
 52 {                                                  52 {
 53   public:                                          53   public:
 54                                                    54 
 55     G4GDMLErrorHandler(const G4bool set) { Sup     55     G4GDMLErrorHandler(const G4bool set) { Suppress = set; }
 56                                                    56 
 57     void warning(const xercesc::SAXParseExcept     57     void warning(const xercesc::SAXParseException& exception)
 58     {                                              58     {
 59       if(Suppress)                                 59       if(Suppress)
 60       {                                            60       {
 61         return;                                    61         return;
 62       }                                            62       }
 63       char* message = xercesc::XMLString::tran     63       char* message = xercesc::XMLString::transcode(exception.getMessage());
 64       G4cout << "G4GDML: VALIDATION WARNING! "     64       G4cout << "G4GDML: VALIDATION WARNING! " << message
 65              << " at line: " << exception.getL     65              << " at line: " << exception.getLineNumber() << G4endl;
 66       xercesc::XMLString::release(&message);       66       xercesc::XMLString::release(&message);
 67     }                                              67     }
 68                                                    68 
 69     void error(const xercesc::SAXParseExceptio     69     void error(const xercesc::SAXParseException& exception)
 70     {                                              70     {
 71       if(Suppress)                                 71       if(Suppress)
 72       {                                            72       {
 73         return;                                    73         return;
 74       }                                            74       }
 75       char* message = xercesc::XMLString::tran     75       char* message = xercesc::XMLString::transcode(exception.getMessage());
 76       G4cout << "G4GDML: VALIDATION ERROR! " <     76       G4cout << "G4GDML: VALIDATION ERROR! " << message
 77              << " at line: " << exception.getL     77              << " at line: " << exception.getLineNumber() << G4endl;
 78       xercesc::XMLString::release(&message);       78       xercesc::XMLString::release(&message);
 79     }                                              79     }
 80                                                    80 
 81     void fatalError(const xercesc::SAXParseExc     81     void fatalError(const xercesc::SAXParseException& exception)
 82     {                                              82     {
 83       error(exception);                            83       error(exception);
 84     }                                              84     }
 85     void resetErrors() {}                          85     void resetErrors() {}
 86                                                    86 
 87   private:                                         87   private:
 88                                                    88 
 89     G4bool Suppress = false;                       89     G4bool Suppress = false;
 90 };                                                 90 };
 91                                                    91 
 92 class G4GDMLRead                                   92 class G4GDMLRead
 93 {                                                  93 {
 94   public:                                          94   public:
 95                                                    95 
 96     virtual void DefineRead(const xercesc::DOM     96     virtual void DefineRead(const xercesc::DOMElement* const)           = 0;
 97     virtual void MaterialsRead(const xercesc::     97     virtual void MaterialsRead(const xercesc::DOMElement* const)        = 0;
 98     virtual void SetupRead(const xercesc::DOME     98     virtual void SetupRead(const xercesc::DOMElement* const)            = 0;
 99     virtual void SolidsRead(const xercesc::DOM     99     virtual void SolidsRead(const xercesc::DOMElement* const)           = 0;
100     virtual void Paramvol_contentRead(const xe    100     virtual void Paramvol_contentRead(const xercesc::DOMElement* const) = 0;
101     virtual void Volume_contentRead(const xerc    101     virtual void Volume_contentRead(const xercesc::DOMElement* const)   = 0;
102     virtual void StructureRead(const xercesc::    102     virtual void StructureRead(const xercesc::DOMElement* const)        = 0;
103     //                                            103     //
104     // Pure virtual methods implemented in con    104     // Pure virtual methods implemented in concrete reader plugin's classes
105                                                   105 
106     virtual void ExtensionRead(const xercesc::    106     virtual void ExtensionRead(const xercesc::DOMElement* const);
107     //                                            107     //
108     // To be implemented in the client code fo    108     // To be implemented in the client code for handling extensions
109     // to the GDML schema, identified with the    109     // to the GDML schema, identified with the tag "extension".
110     // The implementation should be placed ins    110     // The implementation should be placed inside a user-class
111     // inheriting from G4GDMLReadStructure and    111     // inheriting from G4GDMLReadStructure and being registered
112     // as argument to G4GDMLParser.               112     // as argument to G4GDMLParser.
113                                                   113 
114     virtual void UserinfoRead(const xercesc::D    114     virtual void UserinfoRead(const xercesc::DOMElement* const);
115     //                                            115     //
116     // Customisable by user to handle "userinf    116     // Customisable by user to handle "userinfo" extensions to the
117     // GDML schema, identified by the tag "use    117     // GDML schema, identified by the tag "userinfo".
118                                                   118 
119     virtual G4LogicalVolume* GetVolume(const G    119     virtual G4LogicalVolume* GetVolume(const G4String&) const = 0;
120     virtual G4String GetSetup(const G4String&)    120     virtual G4String GetSetup(const G4String&)                = 0;
121     //                                            121     //
122     // More pure virtual methods implemented i    122     // More pure virtual methods implemented in the reader plugin.
123                                                   123 
124     void Read(const G4String&, G4bool validati    124     void Read(const G4String&, G4bool validation, G4bool isModule,
125               G4bool strip = true);               125               G4bool strip = true);
126     //                                            126     //
127     // Main method for reading GDML files.        127     // Main method for reading GDML files.
128                                                   128 
129     void StripNames() const;                      129     void StripNames() const;
130     void StripName(G4String&) const;              130     void StripName(G4String&) const;
131     //                                            131     //
132     // Strip off pointers from entity IDs.        132     // Strip off pointers from entity IDs.
133                                                   133 
134     const G4String& GetSchemaFile() const;        134     const G4String& GetSchemaFile() const;
135     void SetSchemaFile(const G4String& schemaF    135     void SetSchemaFile(const G4String& schemaFile);
136     //                                            136     //
137     // Set/Get alternative XML schema path/fil    137     // Set/Get alternative XML schema path/file for parsing validation.
138                                                   138 
139     void OverlapCheck(G4bool);                    139     void OverlapCheck(G4bool);
140     //                                            140     //
141     // Activate/de-activate surface check for     141     // Activate/de-activate surface check for overlaps (default is off).
142                                                   142 
143     const G4GDMLAuxListType* GetAuxList() cons    143     const G4GDMLAuxListType* GetAuxList() const;
144                                                   144 
145   protected:                                      145   protected:
146                                                   146 
147     G4GDMLRead();                                 147     G4GDMLRead();
148     virtual ~G4GDMLRead();                        148     virtual ~G4GDMLRead();
149                                                   149 
150     G4String Transcode(const XMLCh* const);       150     G4String Transcode(const XMLCh* const);
151     G4String GenerateName(const G4String& name    151     G4String GenerateName(const G4String& name, G4bool strip = false);
152     G4String Strip(const G4String&) const;        152     G4String Strip(const G4String&) const;
153     void GeneratePhysvolName(const G4String&,     153     void GeneratePhysvolName(const G4String&, G4VPhysicalVolume*);
154     void LoopRead(const xercesc::DOMElement* c    154     void LoopRead(const xercesc::DOMElement* const,
155                   void (G4GDMLRead::*)(const x    155                   void (G4GDMLRead::*)(const xercesc::DOMElement* const));
156                                                   156 
157     G4GDMLAuxStructType AuxiliaryRead(const xe    157     G4GDMLAuxStructType AuxiliaryRead(const xercesc::DOMElement* const auxElem);
158                                                   158 
159   protected:                                      159   protected:
160                                                   160 
161     G4GDMLEvaluator eval;                         161     G4GDMLEvaluator eval;
162     G4bool validate = true;                       162     G4bool validate = true;
163     G4bool check = false;                         163     G4bool check = false;
164     G4bool dostrip = true;                        164     G4bool dostrip = true;
165     G4String schema = "";                         165     G4String schema = "";
166                                                   166 
167   private:                                        167   private:
168                                                   168 
169     G4int inLoop = 0, loopCount = 0;              169     G4int inLoop = 0, loopCount = 0;
170     G4GDMLAuxListType auxGlobalList;              170     G4GDMLAuxListType auxGlobalList;
171 };                                                171 };
172                                                   172 
173 #endif                                            173 #endif
174                                                   174