Logo ROOT   6.21/01
Reference Guide
TGDMLParse.h
Go to the documentation of this file.
1 /* @(#)root/gdml:$Id$ */
2 // Authors: Ben Lloyd 09/11/06
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2006, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 
12 #ifndef ROOT_TGDMLParse
13 #define ROOT_TGDMLParse
14 
15 #include "TFormula.h"
16 #include "TXMLEngine.h"
17 #include "TGeoMatrix.h"
18 #include "TGeoVolume.h"
19 
20 #include <map>
21 #include <vector>
22 #include <iostream>
23 
24 class TGDMLMatrix;
25 
26 /*************************************************************************
27  * TGDMLRefl - helper class for the import of GDML to ROOT. *
28  *************************************************************************/
29 
30 class TGDMLRefl : public TObject {
31 public:
32 
34 
35  fNameS = "";
36  fSolid = "";
37  fMatrix = 0;
38  }
39 
40  virtual ~TGDMLRefl() {}
41 
42  TGDMLRefl(const char* name, const char* solid, TGeoMatrix* matrix);
44 
45 private:
46 
47  const char* fNameS; //!reflected solid name
48  const char* fSolid; //!solid name being reflected
49  TGeoMatrix *fMatrix; //!matrix of reflected solid
50 
51  ClassDef(TGDMLRefl, 0) //helper class used for the storage of reflected solids
52 };
53 
54 /*************************************************************************
55  * TGDMLParse - base class for the import of GDML to ROOT. *
56  *************************************************************************/
57 
58 class TGDMLBaseTGDMMapHelper : public std::map<std::string, const void *> {
59 };
60 
61 //map's [] operator returns reference.
62 //to avoid ugly UB casts like static_cast<SomeType * &>(voidPtrLValue)
63 //I have this helper class.
64 template<typename T>
65 
67 private:
68  TGDMLBaseTGDMMapHelper::iterator fPosInMap;
69 
70 public:
71  TGDMAssignmentHelper(TGDMLBaseTGDMMapHelper &baseMap, const std::string &key) {
72  baseMap[key];//if we do not have this key-value pair before, insert it now (with zero for pointer).
73  //find iterator for this key now :)
74  fPosInMap = baseMap.find(key);
75  }
76 
77  operator T * ()const {
78  return (T*)fPosInMap->second;//const_cast<T*>(static_cast<const T *>(fPosInMap->second));
79  }
80 
82  fPosInMap->second = ptr;
83  return *this;
84  }
85 };
86 
87 template<class T>
89 public:
90  TGDMAssignmentHelper<T> operator [](const std::string &key) {
91  return TGDMAssignmentHelper<T>(*this, key);
92  }
93 };
94 
95 class TGDMLParse : public TObject {
96 public:
97 
99  TGeoVolume* fWorld; //top volume of geometry
100  int fVolID; //volume ID, incremented as assigned.
101  int fFILENO; //Holds which level of file the parser is at
102  TXMLEngine* fFileEngine[20]; //array of dom object pointers
103  const char* fStartFile; //name of originating file
104  const char* fCurrentFile; //current file name being parsed
105  std::string fDefault_lunit = "mm";
106  std::string fDefault_aunit = "rad";
107 
108  TGDMLParse();
109  virtual ~TGDMLParse() {}
110 
111  static TGeoVolume* StartGDML(const char* filename) {
112  TGDMLParse* parser = new TGDMLParse;
113  TGeoVolume* world = parser->GDMLReadFile(filename);
114  return world;
115  }
116 
117  TGeoVolume* GDMLReadFile(const char* filename = "test.gdml");
118 
119 private:
120 
121  const char* ParseGDML(TXMLEngine* gdml, XMLNodePointer_t node) ;
122  TString GetScale(const char* unit);
123  double GetScaleVal(const char* unit);
124  double Evaluate(const char* evalline);
125  const char* NameShort(const char* name);
126  double Value(const char *svalue) const;
127  void DefineConstants();
128 
129  //'define' section
136 
137  //'materials' section
139  XMLNodePointer_t EleProcess(TXMLEngine* gdml, XMLNodePointer_t node, XMLNodePointer_t parentn, Bool_t hasIsotopes, Bool_t hasIsotopesExtended);
141 
142  //'solids' section
167 
168  //'structure' section
174  Int_t SetAxis(const char* axisString); //Set Axis for Division
175 
176  //'setup' section
178 
187 
194  typedef std::map<std::string, std::string> ReflectionsMap;
195  typedef std::map<std::string, std::string> ReflVolMap;
196  typedef std::map<std::string, double> FracMap;
197  typedef std::map<std::string, double> ConstMap;
198 
199  PosMap fposmap; //!Map containing position names and the TGeoTranslation for it
200  RotMap frotmap; //!Map containing rotation names and the TGeoRotation for it
201  SclMap fsclmap; //!Map containing scale names and the TGeoScale for it
202  IsoMap fisomap; //!Map containing isotope names and the TGeoIsotope for it
203  EleMap felemap; //!Map containing element names and the TGeoElement for it
204  MatMap fmatmap; //!Map containing material names and the TGeoMaterial for it
205  MedMap fmedmap; //!Map containing medium names and the TGeoMedium for it
206  MixMap fmixmap; //!Map containing mixture names and the TGeoMixture for it
207  SolMap fsolmap; //!Map containing solid names and the TGeoShape for it
208  VolMap fvolmap; //!Map containing volume names and the TGeoVolume for it
209  PvolMap fpvolmap; //!Map containing placed volume names and the TGeoNode for it
210  ReflectionsMap freflectmap; //!Map containing reflection names and the Solid name ir references to
211  ReflSolidMap freflsolidmap; //!Map containing reflection names and the TGDMLRefl for it - containing refl matrix
212  ReflVolMap freflvolmap; //!Map containing reflected volume names and the solid ref for it
213  FileMap ffilemap; //!Map containing files parsed during entire parsing, with their world volume name
214  ConstMap fconsts; //!Map containing values of constants declared in the file
215  MatrixMap fmatrices; //!Map containing matrices defined in the GDML file
216 
217  ClassDef(TGDMLParse, 0) //imports GDML using DOM and binds it to ROOT
218 };
219 
220 #endif
XMLNodePointer_t UsrProcess(TXMLEngine *gdml, XMLNodePointer_t node)
User data to be processed.
XMLNodePointer_t ConProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the define section of the GDML file, constants can be declared.
Definition: TGDMLParse.cxx:452
TGDMAssignmentHelper< T > operator[](const std::string &key)
Definition: TGDMLParse.h:90
TGDMMapHelper< TGDMLMatrix > MatrixMap
Definition: TGDMLParse.h:191
TGDMMapHelper< TGeoTranslation > PosMap
Definition: TGDMLParse.h:179
MatrixMap fmatrices
Map containing values of constants declared in the file.
Definition: TGDMLParse.h:215
XMLNodePointer_t TwistTrap(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a TwistTrap may be declared.
RotMap frotmap
Map containing position names and the TGeoTranslation for it.
Definition: TGDMLParse.h:200
TGDMMapHelper< TGeoMedium > MedMap
Definition: TGDMLParse.h:185
XMLNodePointer_t Trd(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Trd may be declared.
MatMap fmatmap
Map containing element names and the TGeoElement for it.
Definition: TGDMLParse.h:204
TGeoVolume * fWorld
Definition: TGDMLParse.h:99
std::map< std::string, double > ConstMap
Definition: TGDMLParse.h:197
TGDMAssignmentHelper(TGDMLBaseTGDMMapHelper &baseMap, const std::string &key)
Definition: TGDMLParse.h:71
Geometrical transformation package.
Definition: TGeoMatrix.h:40
XMLNodePointer_t Paraboloid(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Paraboloid may be declared.
double T(double x)
Definition: ChebyshevPol.h:34
XMLNodePointer_t Xtru(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, an Xtru may be declared.
TGDMMapHelper< TGeoNode > PvolMap
Definition: TGDMLParse.h:190
TGDMMapHelper< TGeoIsotope > IsoMap
Definition: TGDMLParse.h:183
XMLNodePointer_t Reflection(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Reflected Solid may be declared when the ReflectedSolid key...
EleMap felemap
Map containing isotope names and the TGeoIsotope for it.
Definition: TGDMLParse.h:203
PvolMap fpvolmap
Map containing volume names and the TGeoVolume for it.
Definition: TGDMLParse.h:209
TGeoVolume, TGeoVolumeMulti, TGeoVolumeAssembly are the volume classes.
Definition: TGeoVolume.h:42
XMLNodePointer_t Cone(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a cone may be declared.
TString GetScale(const char *unit)
Throughout the GDML file, a unit can de specified.
Definition: TGDMLParse.cxx:668
Basic string class.
Definition: TString.h:131
XMLNodePointer_t IsoProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLNodePointer_t parentn)
In the material section of the GDML file, an isotope may be declared.
Definition: TGDMLParse.cxx:989
XMLNodePointer_t Polycone(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Polycone may be declared.
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
TGDMMapHelper< const char > FileMap
Definition: TGDMLParse.h:193
XMLNodePointer_t MatrixProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the define section of the GDML file, matrices These are referenced by other GDML tags...
Definition: TGDMLParse.cxx:554
std::string fDefault_lunit
Definition: TGDMLParse.h:105
double GetScaleVal(const char *unit)
Throughout the GDML file, a unit can de specified.
Definition: TGDMLParse.cxx:713
TGDMMapHelper< TGeoShape > SolMap
Definition: TGDMLParse.h:188
ReflectionsMap freflectmap
Map containing placed volume names and the TGeoNode for it.
Definition: TGDMLParse.h:210
TGDMMapHelper< TGeoMaterial > MatMap
Definition: TGDMLParse.h:184
const char * fCurrentFile
Definition: TGDMLParse.h:104
XMLNodePointer_t SclProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the define section of the GDML file, rotations can be declared.
Definition: TGDMLParse.cxx:945
This class contains the implementation of the GDML parser associated to all the supported GDML elemen...
Definition: TGDMLParse.h:95
TGDMMapHelper< TGeoVolume > VolMap
Definition: TGDMLParse.h:189
TGeoMatrix * fMatrix
solid name being reflected
Definition: TGDMLParse.h:49
XMLNodePointer_t BooSolid(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr, int num)
In the solid section of the GDML file, boolean solids can be declared.
double Evaluate(const char *evalline)
Takes a string containing a mathematical expression and returns the value of the expression.
Definition: TGDMLParse.cxx:401
#define ClassDef(name, id)
Definition: Rtypes.h:326
TGeoMatrix * GetMatrix()
This accessor method returns the matrix.
TGeoVolume * GDMLReadFile(const char *filename="test.gdml")
Creates the new instance of the XMLEngine called &#39;gdml&#39;, using the filename >> then parses the file a...
Definition: TGDMLParse.cxx:159
TGDMMapHelper< TGeoElement > EleMap
Definition: TGDMLParse.h:182
This class is used in the process of reading and writing the GDML "matrix" tag.
Definition: TGDMLMatrix.h:34
virtual ~TGDMLParse()
Definition: TGDMLParse.h:109
void DefineConstants()
Define constant expressions used.
Definition: TGDMLParse.cxx:484
XMLNodePointer_t Arb8(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, an Arb8 may be declared.
double Value(const char *svalue) const
Convert number in string format to double value.
Definition: TGDMLParse.cxx:753
XMLNodePointer_t BorderSurfaceProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the structure section of the GDML file, border surfaces can be declared.
FileMap ffilemap
Map containing reflected volume names and the solid ref for it.
Definition: TGDMLParse.h:213
ConstMap fconsts
Map containing files parsed during entire parsing, with their world volume name.
Definition: TGDMLParse.h:214
XMLNodePointer_t Tessellated(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a tessellated shape may be declared.
This class is a helper class for TGDMLParse.
Definition: TGDMLParse.h:30
XMLNodePointer_t CutTube(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Cut Tube may be declared.
XMLNodePointer_t Sphere(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Sphere may be declared.
XMLNodePointer_t Orb(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, an Orb may be declared.
XMLNodePointer_t PosProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the define section of the GDML file, positions can be declared.
Definition: TGDMLParse.cxx:836
XMLNodePointer_t Torus(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Torus may be declared.
std::map< std::string, std::string > ReflectionsMap
Definition: TGDMLParse.h:194
TGDMLParse()
Constructor.
Definition: TGDMLParse.cxx:128
XMLNodePointer_t Box(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a box may be declared.
XMLNodePointer_t Ellipsoid(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, an ellipsoid may be declared.
std::map< std::string, double > FracMap
Definition: TGDMLParse.h:196
XMLNodePointer_t Para(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Para may be declared.
XMLNodePointer_t Trap(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Trap may be declared.
const char * fStartFile
Definition: TGDMLParse.h:103
const char * fSolid
reflected solid name
Definition: TGDMLParse.h:48
XMLNodePointer_t RotProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the define section of the GDML file, rotations can be declared.
Definition: TGDMLParse.cxx:888
TXMLEngine * fFileEngine[20]
Definition: TGDMLParse.h:102
XMLNodePointer_t Hype(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Hype may be declared.
void * XMLNodePointer_t
Definition: TXMLEngine.h:17
IsoMap fisomap
Map containing scale names and the TGeoScale for it.
Definition: TGDMLParse.h:202
XMLNodePointer_t TopProcess(TXMLEngine *gdml, XMLNodePointer_t node)
In the setup section of the GDML file, the top volume need to be declared.
XMLNodePointer_t OpticalSurfaceProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, optical surfaces can be defined.
Definition: TGDMLParse.cxx:603
const char * fNameS
Definition: TGDMLParse.h:47
void * XMLAttrPointer_t
Definition: TXMLEngine.h:19
XMLNodePointer_t Polyhedra(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Polyhedra may be declared.
MixMap fmixmap
Map containing medium names and the TGeoMedium for it.
Definition: TGDMLParse.h:206
std::string fDefault_aunit
Definition: TGDMLParse.h:106
XMLNodePointer_t QuantityProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the define section of the GDML file, quantities can be declared.
Definition: TGDMLParse.cxx:523
Int_t SetAxis(const char *axisString)
When using the &#39;divide&#39; process in the geometry this function sets the variable &#39;axis&#39; depending on w...
Definition: TGDMLParse.cxx:411
TGDMMapHelper< TGeoScale > SclMap
Definition: TGDMLParse.h:181
TGDMLBaseTGDMMapHelper::iterator fPosInMap
Definition: TGDMLParse.h:68
TGDMAssignmentHelper & operator=(const T *ptr)
Definition: TGDMLParse.h:81
const char * NameShort(const char *name)
This function looks thru a string for the chars &#39;0x&#39; next to each other, when it finds this...
Definition: TGDMLParse.cxx:436
MedMap fmedmap
Map containing material names and the TGeoMaterial for it.
Definition: TGDMLParse.h:205
Mother of all ROOT objects.
Definition: TObject.h:37
you should not use this method at all Int_t Int_t z
Definition: TRolke.cxx:630
TGDMMapHelper< TGeoRotation > RotMap
Definition: TGDMLParse.h:180
SclMap fsclmap
Map containing rotation names and the TGeoRotation for it.
Definition: TGDMLParse.h:201
TGDMMapHelper< TGeoMixture > MixMap
Definition: TGDMLParse.h:186
SolMap fsolmap
Map containing mixture names and the TGeoMixture for it.
Definition: TGDMLParse.h:207
const char * ParseGDML(TXMLEngine *gdml, XMLNodePointer_t node)
This function recursively moves thru the DOM tree of the GDML file.
Definition: TGDMLParse.cxx:194
ReflVolMap freflvolmap
Map containing reflection names and the TGDMLRefl for it - containing refl matrix.
Definition: TGDMLParse.h:212
XMLNodePointer_t SkinSurfaceProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the structure section of the GDML file, skin surfaces can be declared.
VolMap fvolmap
Map containing solid names and the TGeoShape for it.
Definition: TGDMLParse.h:208
XMLNodePointer_t ElTube(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a ElTube may be declared.
std::map< std::string, std::string > ReflVolMap
Definition: TGDMLParse.h:195
ReflSolidMap freflsolidmap
Map containing reflection names and the Solid name ir references to.
Definition: TGDMLParse.h:211
XMLNodePointer_t MatProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr, int z)
In the materials section of the GDML file, materials can be declared.
XMLNodePointer_t EleProcess(TXMLEngine *gdml, XMLNodePointer_t node, XMLNodePointer_t parentn, Bool_t hasIsotopes, Bool_t hasIsotopesExtended)
When the element keyword is found, this function is called, and the name and values of the element ar...
TGDMMapHelper< TGDMLRefl > ReflSolidMap
Definition: TGDMLParse.h:192
XMLNodePointer_t Tube(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, a Tube may be declared.
XMLNodePointer_t AssProcess(TXMLEngine *gdml, XMLNodePointer_t node)
In the structure section of the GDML file, assembly volumes can be declared.
XMLNodePointer_t VolProcess(TXMLEngine *gdml, XMLNodePointer_t node)
In the structure section of the GDML file, volumes can be declared.
virtual ~TGDMLRefl()
Definition: TGDMLParse.h:40
TString fWorldName
Definition: TGDMLParse.h:98
char name[80]
Definition: TGX11.cxx:109
XMLNodePointer_t ElCone(TXMLEngine *gdml, XMLNodePointer_t node, XMLAttrPointer_t attr)
In the solids section of the GDML file, an elliptical cone may be declared.
static TGeoVolume * StartGDML(const char *filename)
Definition: TGDMLParse.h:111
PosMap fposmap
Definition: TGDMLParse.h:199