This class contains implementation of converting ROOT's gGeoManager geometry to GDML file.

gGeoManager is the instance of TGeoManager class containing tree of geometries creating resulting geometry. GDML is xml based format of file mirroring the tree of geometries according to GDML schema rules. For more information about GDML see http://gdml.web.cern.ch. Each object in ROOT is represented by xml tag (=xml node/element) in GDML.

This class is not needed to be instanciated. It should always be called by gGeoManager->Export("xyz.gdml") method. Export is driven by extenstion that is why ".gdml" is important in resulting name.

Whenever a new ROOT geometry object is implemented or there is a change in GDML schema this class is needed to be updated to ensure proper mapping between ROOT objects and GDML elements.

Current status of mapping ROOT -> GDML is implemented in method called TGDMLWrite::ChooseObject and it contains following "map":

Solids:

TGeoBBox               ->           <box ... >
TGeoParaboloid         ->           <paraboloid ...>
TGeoSphere             ->           <sphere ...>
TGeoArb8               ->           <arb8 ...>
TGeoConeSeg            ->           <cone ...>
TGeoCone               ->           <cone ...>
TGeoPara               ->           <para ...>
TGeoTrap               ->           <trap ...>   or
-                      ->           <arb8 ...>
TGeoGtra               ->           <twistedtrap ...>   or
-                      ->           <trap ...>          or
-                      ->           <arb8 ...>
TGeoTrd1               ->           <trd ...>
TGeoTrd2               ->           <trd ...>
TGeoTubeSeg            ->           <tube ...>
TGeoCtub               ->           <cutTube ...>
TGeoTube               ->           <tube ...>
TGeoPcon               ->           <polycone ...>
TGeoTorus              ->           <torus ...>
TGeoPgon               ->           <polyhedra ...>
TGeoEltu               ->           <eltube ...>
TGeoHype               ->           <hype ...>
TGeoXtru               ->           <xtru ...>
TGeoCompositeShape     ->           <union ...>            or
-                      ->           <subtraction ...>      or
-                      ->           <intersection ...>
Special cases of solids:
TGeoScaledShape        ->           <elcone ...>  if scaled TGeoCone or
-                      ->           element without scale
TGeoCompositeShape     ->           <ellipsoid ...>
-                                   intersection of:
-                                   scaled TGeoSphere and TGeoBBox

Materials:

TGeoIsotope            ->           <isotope ...>
TGeoElement            ->           <element ...>
TGeoMaterial           ->           <material ...>
TGeoMixture            ->           <material ...>

Structure

TGeoVolume             ->           <volume ...>   or
-                      ->           <assembly ...>
TGeoNode               ->           <physvol ...>
TGeoPatternFinder      ->           <divisionvol ...>

There are options that can be set to change resulting document

Options:

g - is set by default in gGeoManager, this option ensures compatibility
-   with Geant4. It means:
-   -> atomic number of material will be changed if <1 to 1
-   -> if polycone is set badly it will try to export it correctly
-   -> if widht * ndiv + offset is more then width of object being divided
-      (in divisions) then it will be rounded so it will not exceed or
-      if kPhi divsion then it will keep range of offset in -360 -> 0
f - if this option is set then names of volumes and solids will have
-   pointer as a suffix to ensure uniqness of names
n - if this option is set then names will not have suffix, but uniqness is
-   of names is not secured
- - if none of this two options (f,n) is set then default behaviour is so
-   that incremental suffix is added to the names.
-   (eg. TGeoBBox_0x1, TGeoBBox_0x2 ...)

USAGE:

gGeoManager->Export("output.gdml");
gGeoManager->Export("output.gdml","","vg"); //the same as previous just
                                            //options are set explicitly
gGeoManager->Export("output.gdml","","vgf");
gGeoManager->Export("output.gdml","","gn");
gGeoManager->Export("output.gdml","","f");
...

Note:

Options discussed above are used only for TGDMLWrite class. There are other options in the TGeoManager::Export(...) method that can be used. See that function for details.

Definition at line 50 of file TGDMLWrite.h.

Classes
struct	NameLst

struct	StructLst

struct	Xyz

Public Types
enum	ENamingType { kelegantButSlow = 0, kwithoutSufixNotUniq = 1, kfastButUglySufix = 2 }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000, kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }

Public Member Functions
	TGDMLWrite ()
	Default constructor. More...

virtual	~TGDMLWrite ()
	Destructor. More...

void	SetG4Compatibility (Bool_t G4Compatible)

void	SetNamingSpeed (ENamingType naming)
	Set convention of naming solids and volumes. More...

void	WriteGDMLfile (TGeoManager geomanager, const char filename="test.gdml", TString option="")

void	WriteGDMLfile (TGeoManager geomanager, TGeoVolume volume, const char *filename="test.gdml", TString option="")

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor. More...

	TObject (const TObject &object)
	TObject copy ctor. More...

virtual	~TObject ()
	TObject destructor. More...

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. More...

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action. More...

ULong_t	CheckedHash ()
	Checked and record whether for this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...

virtual const char *	ClassName () const
	Returns name of class to which the object belongs. More...

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method. More...

virtual void	Copy (TObject &object) const
	Copy this to obj. More...

virtual void	Delete (Option_t *option="")
	Delete this object. More...

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object. More...

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects. More...

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs. More...

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`. More...

virtual void	Dump () const
	Dump contents of object on stdout. More...

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. More...

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g. More...

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray. More...

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py). More...

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. More...

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...

virtual const char *	GetIconName () const
	Returns mime type name of object. More...

virtual const char *	GetName () const
	Returns name of object. More...

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object. More...

virtual UInt_t	GetUniqueID () const
	Return the unique object id. More...

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. More...

virtual ULong_t	Hash () const
	Return hash value for this object. More...

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. More...

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname". More...

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl. More...

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas. More...

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout. More...

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete. More...

void	operator delete (void *ptr)
	Operator delete. More...

void	operator delete[] (void *ptr)
	Operator delete []. More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself. More...

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list. More...

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself. More...

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list. More...

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename. More...

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out". More...

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f. More...

void	SetBit (UInt_t f)

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object. More...

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id. More...

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory. More...

Static Public Member Functions
static void	StartGDMLWriting (TGeoManager geomanager, const char filename, TString option)

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...

static Bool_t	GetObjectStat ()
	Get status of object stat flag. More...

static void	SetDtorOnly (void *obj)
	Set destructor only flag. More...

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable. More...

Private Types
typedef std::map< TString, Bool_t >	NameList

typedef std::map< TString, Float_t >	NameListF

typedef std::map< TString, Int_t >	NameListI

typedef std::map< TString, TString >	NameListS

Private Member Functions
Bool_t	CanProcess (TObject *pointer)
	Method which tests whether solids can be processed. More...

XMLNodePointer_t	ChooseObject (TGeoShape *geoShape)
	Chooses the object and method that should be used for processing object. More...

XMLNodePointer_t	CreateArb8N (TGeoArb8 *geoShape)
	Creates "arb8" node for GDML. More...

XMLNodePointer_t	CreateAtomN (Double_t atom, const char *unit="g/mole")
	Creates "atom" node for GDML. More...

XMLNodePointer_t	CreateBoxN (TGeoBBox *geoShape)
	Creates "box" node for GDML. More...

XMLNodePointer_t	CreateCommonBoolN (TGeoCompositeShape *geoShape)
	Creates common part of union intersection and subtraction nodes. More...

XMLNodePointer_t	CreateConeN (TGeoConeSeg *geoShape)
	Creates "cone" node for GDML from TGeoConeSeg object. More...

XMLNodePointer_t	CreateConeN (TGeoCone *geoShape)
	Creates "cone" node for GDML from TGeoCone object. More...

XMLNodePointer_t	CreateCutTubeN (TGeoCtub *geoShape)
	Creates "cutTube" node for GDML. More...

XMLNodePointer_t	CreateDivisionN (Double_t offset, Double_t width, Int_t number, const char axis, const char unit, const char *volref)
	Creates "divisionvol" node for GDML. More...

XMLNodePointer_t	CreateDN (Double_t density, const char *unit="g/cm3")
	Creates "D" density node for GDML. More...

XMLNodePointer_t	CreateElConeN (TGeoScaledShape *geoShape)
	Creates "elcone" (elliptical cone) node for GDML this is a special case, because elliptical cone is not defined in ROOT so when scaled cone is found, it is considered as a elliptical cone. More...

XMLNodePointer_t	CreateElementN (TGeoElement element, XMLNodePointer_t materials, const char name)
	Creates "element" node for GDML element node and attribute. More...

XMLNodePointer_t	CreateEllipsoidN (TGeoCompositeShape *geoShape, TString elName)
	Creates "ellipsoid" node for GDML this is a special case, because ellipsoid is not defined in ROOT so when intersection of scaled sphere and TGeoBBox is found, it is considered as an ellipsoid. More...

XMLNodePointer_t	CreateEltubeN (TGeoEltu *geoShape)
	Creates "eltube" node for GDML. More...

TGeoCompositeShape *	CreateFakeCtub (TGeoCtub *geoShape)
	Method creating cutTube as an intersection of tube and two boxes. More...

XMLNodePointer_t	CreateFractionN (Double_t percentage, const char *refName)
	Creates "fraction" node for GDML. More...

XMLNodePointer_t	CreateHypeN (TGeoHype *geoShape)
	Creates "hype" node for GDML. More...

XMLNodePointer_t	CreateIsotopN (TGeoIsotope isotope, const char name)
	Creates "isotope" node for GDML. More...

XMLNodePointer_t	CreateMaterialN (TGeoMaterial *material, TString mname)
	Creates "material" node for GDML. More...

XMLNodePointer_t	CreateMixtureN (TGeoMixture *mixture, XMLNodePointer_t materials, TString mname)
	Creates "material" node for GDML with references to other sub elements. More...

XMLNodePointer_t	CreateParaboloidN (TGeoParaboloid *geoShape)
	Creates "paraboloid" node for GDML. More...

XMLNodePointer_t	CreateParaN (TGeoPara *geoShape)
	Creates "para" node for GDML. More...

XMLNodePointer_t	CreatePhysVolN (const char name, Int_t copyno, const char volref, const char posref, const char rotref, XMLNodePointer_t scaleN)
	Creates "physvol" node for GDML. More...

XMLNodePointer_t	CreatePolyconeN (TGeoPcon *geoShape)
	Creates "polycone" node for GDML. More...

XMLNodePointer_t	CreatePolyhedraN (TGeoPgon *geoShape)
	Creates "polyhedra" node for GDML. More...

XMLNodePointer_t	CreatePositionN (const char name, Xyz position, const char type="position", const char *unit="cm")
	Creates "position" kind of node for GDML. More...

XMLNodePointer_t	CreateRotationN (const char name, Xyz rotation, const char type="rotation", const char *unit="deg")
	Creates "rotation" kind of node for GDML. More...

XMLNodePointer_t	CreateSetupN (const char topVolName, const char name="default", const char *version="1.0")
	Creates "setup" node for GDML. More...

XMLNodePointer_t	CreateSphereN (TGeoSphere *geoShape)
	Creates "sphere" node for GDML. More...

XMLNodePointer_t	CreateTorusN (TGeoTorus *geoShape)
	Creates "torus" node for GDML. More...

XMLNodePointer_t	CreateTrapN (TGeoTrap *geoShape)
	Creates "trap" node for GDML. More...

XMLNodePointer_t	CreateTrdN (TGeoTrd1 *geoShape)
	Creates "trd" node for GDML from object TGeoTrd1. More...

XMLNodePointer_t	CreateTrdN (TGeoTrd2 *geoShape)
	Creates "trd" node for GDML from object TGeoTrd2. More...

XMLNodePointer_t	CreateTubeN (TGeoTubeSeg *geoShape)
	Creates "tube" node for GDML from object TGeoTubeSeg. More...

XMLNodePointer_t	CreateTubeN (TGeoTube *geoShape)
	Creates "tube" node for GDML from object TGeoTube. More...

XMLNodePointer_t	CreateTwistedTrapN (TGeoGtra *geoShape)
	Creates "twistedtrap" node for GDML. More...

XMLNodePointer_t	CreateXtrusionN (TGeoXtru *geoShape)
	Creates "xtru" node for GDML. More...

XMLNodePointer_t	CreateZplaneN (Double_t z, Double_t rmin, Double_t rmax)
	Creates "zplane" node for GDML. More...

XMLNodePointer_t	ExtractMaterials (TList *materialsLst)
	Method exporting materials. More...

TString	ExtractSolid (TGeoShape *volShape)
	Method creating solid to xml file and returning its name. More...

void	ExtractVolumes (TGeoVolume *volume)
	Method extracting geometry structure recursively. More...

TString	GenName (TString oldname)
	NCNAME basic restrictions Replace "$" character with empty character etc. More...

TString	GenName (TString oldname, TString objPointer)
	Important function which is responsible for naming volumes, solids and materials. More...

UInt_t	GetFltPrecision () const

TString	GetPattAxis (Int_t divAxis, const char *pattName, TString &unit)
	Method that retrieves axis and unit along which object is divided. More...

Xyz	GetXYZangles (const Double_t *rotationMatrix)
	Retrieves X Y Z angles from rotation matrix. More...

Bool_t	IsInList (NameList list, TString name2check)
	Checks whether name2check is in (NameList) list. More...

Bool_t	IsNullParam (Double_t parValue, TString parName, TString objName)
	Check for null parameter to skip the NULL objects. More...

void	SetFltPrecision (UInt_t prec)

XMLNodePointer_t	StartAssemblyN (const char *name)
	Creates "assembly" node for GDML. More...

XMLNodePointer_t	StartVolumeN (const char name, const char solid, const char *material)
	Creates "volume" node for GDML. More...

void	UnsetTemporaryBits (TGeoManager *geoMng)
	Unsetting bits that were changed in gGeoManager during export so that export can be run more times with the same instance of gGeoManager. More...

void	WriteGDMLfile (TGeoManager geomanager, TGeoVolume volume, TList materialsLst, const char filename, TString option)
	Wrapper of all exporting methods Creates blank GDML file and fills it with gGeoManager structure converted to GDML structure of xml nodes. More...

Static Private Attributes
static TGDMLWrite *	fgGDMLWrite = 0

static const UInt_t	fgkMaxNameErr = 5

static const UInt_t	fgkProcBit = BIT(14)
	floating point precision when writing More...

static const UInt_t	fgkProcBitVol = BIT(19)

Additional Inherited Members
Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

void	MakeZombie ()

#include <TGDMLWrite.h>

Inheritance diagram for TGDMLWrite:

[legend]

Member Typedef Documentation

◆ NameList

typedef std::map<TString, Bool_t> TGDMLWrite::NameList

private

Definition at line 90 of file TGDMLWrite.h.

◆ NameListF

typedef std::map<TString, Float_t> TGDMLWrite::NameListF

private

Definition at line 93 of file TGDMLWrite.h.

◆ NameListI

typedef std::map<TString, Int_t> TGDMLWrite::NameListI

private

Definition at line 92 of file TGDMLWrite.h.

◆ NameListS

typedef std::map<TString, TString> TGDMLWrite::NameListS

private

Definition at line 91 of file TGDMLWrite.h.

Member Enumeration Documentation

◆ ENamingType

enum TGDMLWrite::ENamingType

Enumerator
kelegantButSlow
kwithoutSufixNotUniq
kfastButUglySufix

Definition at line 73 of file TGDMLWrite.h.

Constructor & Destructor Documentation

◆ TGDMLWrite()

TGDMLWrite::TGDMLWrite ( )

Default constructor.

Definition at line 183 of file TGDMLWrite.cxx.

◆ ~TGDMLWrite()

TGDMLWrite::~TGDMLWrite ( )

virtual

Destructor.

Definition at line 212 of file TGDMLWrite.cxx.

Member Function Documentation

◆ CanProcess()

Bool_t TGDMLWrite::CanProcess ( TObject * pointer )

private

Method which tests whether solids can be processed.

Definition at line 2040 of file TGDMLWrite.cxx.

◆ ChooseObject()

XMLNodePointer_t TGDMLWrite::ChooseObject ( TGeoShape * geoShape )

private

Chooses the object and method that should be used for processing object.

Definition at line 1761 of file TGDMLWrite.cxx.

◆ CreateArb8N()

XMLNodePointer_t TGDMLWrite::CreateArb8N ( TGeoArb8 * geoShape )

private

Creates "arb8" node for GDML.

Definition at line 864 of file TGDMLWrite.cxx.

◆ CreateAtomN()

XMLNodePointer_t TGDMLWrite::CreateAtomN	(	Double_t	atom,
		const char *	unit = `"g/mole"`
	)

private

Creates "atom" node for GDML.

Definition at line 599 of file TGDMLWrite.cxx.

◆ CreateBoxN()

XMLNodePointer_t TGDMLWrite::CreateBoxN ( TGeoBBox * geoShape )

private

Creates "box" node for GDML.

Definition at line 796 of file TGDMLWrite.cxx.

◆ CreateCommonBoolN()

XMLNodePointer_t TGDMLWrite::CreateCommonBoolN ( TGeoCompositeShape * geoShape )

private

Creates common part of union intersection and subtraction nodes.

Definition at line 1493 of file TGDMLWrite.cxx.

◆ CreateConeN() [1/2]

XMLNodePointer_t TGDMLWrite::CreateConeN ( TGeoConeSeg * geoShape )

private

Creates "cone" node for GDML from TGeoConeSeg object.

Definition at line 899 of file TGDMLWrite.cxx.

◆ CreateConeN() [2/2]

XMLNodePointer_t TGDMLWrite::CreateConeN ( TGeoCone * geoShape )

private

Creates "cone" node for GDML from TGeoCone object.

Definition at line 925 of file TGDMLWrite.cxx.

◆ CreateCutTubeN()

XMLNodePointer_t TGDMLWrite::CreateCutTubeN ( TGeoCtub * geoShape )

private

Creates "cutTube" node for GDML.

Definition at line 1149 of file TGDMLWrite.cxx.

◆ CreateDivisionN()

XMLNodePointer_t TGDMLWrite::CreateDivisionN	(	Double_t	offset,
		Double_t	width,
		Int_t	number,
		const char *	axis,
		const char *	unit,
		const char *	volref
	)

private

Creates "divisionvol" node for GDML.

Definition at line 1726 of file TGDMLWrite.cxx.

◆ CreateDN()

XMLNodePointer_t TGDMLWrite::CreateDN	(	Double_t	density,
		const char *	unit = `"g/cm3"`
	)

private

Creates "D" density node for GDML.

Definition at line 611 of file TGDMLWrite.cxx.

◆ CreateElConeN()

XMLNodePointer_t TGDMLWrite::CreateElConeN ( TGeoScaledShape * geoShape )

private

Creates "elcone" (elliptical cone) node for GDML this is a special case, because elliptical cone is not defined in ROOT so when scaled cone is found, it is considered as a elliptical cone.

Definition at line 1466 of file TGDMLWrite.cxx.

◆ CreateElementN()

XMLNodePointer_t TGDMLWrite::CreateElementN	(	TGeoElement *	element,
		XMLNodePointer_t	materials,
		const char *	name
	)

private

Creates "element" node for GDML element node and attribute.

Definition at line 649 of file TGDMLWrite.cxx.

◆ CreateEllipsoidN()

XMLNodePointer_t TGDMLWrite::CreateEllipsoidN	(	TGeoCompositeShape *	geoShape,
		TString	elName
	)

private

Creates "ellipsoid" node for GDML this is a special case, because ellipsoid is not defined in ROOT so when intersection of scaled sphere and TGeoBBox is found, it is considered as an ellipsoid.

Definition at line 1427 of file TGDMLWrite.cxx.

◆ CreateEltubeN()

XMLNodePointer_t TGDMLWrite::CreateEltubeN ( TGeoEltu * geoShape )

private

Creates "eltube" node for GDML.

Definition at line 1334 of file TGDMLWrite.cxx.

◆ CreateFakeCtub()

TGeoCompositeShape * TGDMLWrite::CreateFakeCtub ( TGeoCtub * geoShape )

private

Method creating cutTube as an intersection of tube and two boxes.

not used anymore because cutube is supported in Geant4 9.5

Definition at line 1879 of file TGDMLWrite.cxx.

◆ CreateFractionN()

XMLNodePointer_t TGDMLWrite::CreateFractionN	(	Double_t	percentage,
		const char *	refName
	)

private

Creates "fraction" node for GDML.

Definition at line 623 of file TGDMLWrite.cxx.

◆ CreateHypeN()

XMLNodePointer_t TGDMLWrite::CreateHypeN ( TGeoHype * geoShape )

private

Creates "hype" node for GDML.

Definition at line 1358 of file TGDMLWrite.cxx.

◆ CreateIsotopN()

XMLNodePointer_t TGDMLWrite::CreateIsotopN	(	TGeoIsotope *	isotope,
		const char *	name
	)

private

Creates "isotope" node for GDML.

Definition at line 635 of file TGDMLWrite.cxx.

◆ CreateMaterialN()

XMLNodePointer_t TGDMLWrite::CreateMaterialN	(	TGeoMaterial *	material,
		TString	mname
	)

private

Creates "material" node for GDML.

Definition at line 765 of file TGDMLWrite.cxx.

◆ CreateMixtureN()

XMLNodePointer_t TGDMLWrite::CreateMixtureN	(	TGeoMixture *	mixture,
		XMLNodePointer_t	materials,
		TString	mname
	)

private

Creates "material" node for GDML with references to other sub elements.

Definition at line 712 of file TGDMLWrite.cxx.

◆ CreateParaboloidN()

XMLNodePointer_t TGDMLWrite::CreateParaboloidN ( TGeoParaboloid * geoShape )

private

Creates "paraboloid" node for GDML.

Definition at line 818 of file TGDMLWrite.cxx.

◆ CreateParaN()

XMLNodePointer_t TGDMLWrite::CreateParaN ( TGeoPara * geoShape )

private

Creates "para" node for GDML.

Definition at line 951 of file TGDMLWrite.cxx.

◆ CreatePhysVolN()

XMLNodePointer_t TGDMLWrite::CreatePhysVolN	(	const char *	name,
		Int_t	copyno,
		const char *	volref,
		const char *	posref,
		const char *	rotref,
		XMLNodePointer_t	scaleN
	)

private

Creates "physvol" node for GDML.

Definition at line 1694 of file TGDMLWrite.cxx.

◆ CreatePolyconeN()

XMLNodePointer_t TGDMLWrite::CreatePolyconeN ( TGeoPcon * geoShape )

private

Creates "polycone" node for GDML.

Definition at line 1234 of file TGDMLWrite.cxx.

◆ CreatePolyhedraN()

XMLNodePointer_t TGDMLWrite::CreatePolyhedraN ( TGeoPgon * geoShape )

private

Creates "polyhedra" node for GDML.

Definition at line 1312 of file TGDMLWrite.cxx.

◆ CreatePositionN()

XMLNodePointer_t TGDMLWrite::CreatePositionN	(	const char *	name,
		Xyz	position,
		const char *	type = `"position"`,
		const char *	unit = `"cm"`
	)

private

Creates "position" kind of node for GDML.

Definition at line 1620 of file TGDMLWrite.cxx.

◆ CreateRotationN()

XMLNodePointer_t TGDMLWrite::CreateRotationN	(	const char *	name,
		Xyz	rotation,
		const char *	type = `"rotation"`,
		const char *	unit = `"deg"`
	)

private

Creates "rotation" kind of node for GDML.

Definition at line 1635 of file TGDMLWrite.cxx.

◆ CreateSetupN()

XMLNodePointer_t TGDMLWrite::CreateSetupN	(	const char *	topVolName,
		const char *	name = `"default"`,
		const char *	version = `"1.0"`
	)

private

Creates "setup" node for GDML.

Definition at line 1650 of file TGDMLWrite.cxx.

◆ CreateSphereN()

XMLNodePointer_t TGDMLWrite::CreateSphereN ( TGeoSphere * geoShape )

private

Creates "sphere" node for GDML.

Definition at line 839 of file TGDMLWrite.cxx.

◆ CreateTorusN()

XMLNodePointer_t TGDMLWrite::CreateTorusN ( TGeoTorus * geoShape )

private

Creates "torus" node for GDML.

Definition at line 1287 of file TGDMLWrite.cxx.

◆ CreateTrapN()

XMLNodePointer_t TGDMLWrite::CreateTrapN ( TGeoTrap * geoShape )

private

Creates "trap" node for GDML.

Definition at line 972 of file TGDMLWrite.cxx.

◆ CreateTrdN() [1/2]

XMLNodePointer_t TGDMLWrite::CreateTrdN ( TGeoTrd1 * geoShape )

private

Creates "trd" node for GDML from object TGeoTrd1.

Definition at line 1078 of file TGDMLWrite.cxx.

◆ CreateTrdN() [2/2]

XMLNodePointer_t TGDMLWrite::CreateTrdN ( TGeoTrd2 * geoShape )

private

Creates "trd" node for GDML from object TGeoTrd2.

Definition at line 1101 of file TGDMLWrite.cxx.

◆ CreateTubeN() [1/2]

XMLNodePointer_t TGDMLWrite::CreateTubeN ( TGeoTubeSeg * geoShape )

private

Creates "tube" node for GDML from object TGeoTubeSeg.

Definition at line 1124 of file TGDMLWrite.cxx.

◆ CreateTubeN() [2/2]

XMLNodePointer_t TGDMLWrite::CreateTubeN ( TGeoTube * geoShape )

private

Creates "tube" node for GDML from object TGeoTube.

Definition at line 1194 of file TGDMLWrite.cxx.

◆ CreateTwistedTrapN()

XMLNodePointer_t TGDMLWrite::CreateTwistedTrapN ( TGeoGtra * geoShape )

private

Creates "twistedtrap" node for GDML.

Definition at line 1018 of file TGDMLWrite.cxx.

◆ CreateXtrusionN()

XMLNodePointer_t TGDMLWrite::CreateXtrusionN ( TGeoXtru * geoShape )

private

Creates "xtru" node for GDML.

Definition at line 1384 of file TGDMLWrite.cxx.

◆ CreateZplaneN()

XMLNodePointer_t TGDMLWrite::CreateZplaneN	(	Double_t	z,
		Double_t	rmin,
		Double_t	rmax
	)

private

Creates "zplane" node for GDML.

Definition at line 1219 of file TGDMLWrite.cxx.

◆ ExtractMaterials()

XMLNodePointer_t TGDMLWrite::ExtractMaterials ( TList * materialsLst )

private

Method exporting materials.

Definition at line 388 of file TGDMLWrite.cxx.

◆ ExtractSolid()

TString TGDMLWrite::ExtractSolid ( TGeoShape * volShape )

private

Method creating solid to xml file and returning its name.

Definition at line 420 of file TGDMLWrite.cxx.

◆ ExtractVolumes()

void TGDMLWrite::ExtractVolumes ( TGeoVolume * volume )

private

Method extracting geometry structure recursively.

Definition at line 438 of file TGDMLWrite.cxx.

◆ GenName() [1/2]

TString TGDMLWrite::GenName ( TString oldname )

private

NCNAME basic restrictions Replace "$" character with empty character etc.

Definition at line 1967 of file TGDMLWrite.cxx.

◆ GenName() [2/2]

TString TGDMLWrite::GenName	(	TString	oldname,
		TString	objPointer
	)

private

Important function which is responsible for naming volumes, solids and materials.

Definition at line 1997 of file TGDMLWrite.cxx.

◆ GetFltPrecision()

UInt_t TGDMLWrite::GetFltPrecision ( ) const

inlineprivate

Definition at line 205 of file TGDMLWrite.h.

◆ GetPattAxis()

TString TGDMLWrite::GetPattAxis	(	Int_t	divAxis,
		const char *	pattName,
		TString &	unit
	)

private

Method that retrieves axis and unit along which object is divided.

Definition at line 2051 of file TGDMLWrite.cxx.

◆ GetXYZangles()

TGDMLWrite::Xyz TGDMLWrite::GetXYZangles ( const Double_t * rotationMatrix )

private

Retrieves X Y Z angles from rotation matrix.

Definition at line 1853 of file TGDMLWrite.cxx.

◆ IsInList()

Bool_t TGDMLWrite::IsInList	(	NameList	list,
		TString	name2check
	)

private

Checks whether name2check is in (NameList) list.

Definition at line 1957 of file TGDMLWrite.cxx.

◆ IsNullParam()

Bool_t TGDMLWrite::IsNullParam	(	Double_t	parValue,
		TString	parName,
		TString	objName
	)

private

Check for null parameter to skip the NULL objects.

Definition at line 2086 of file TGDMLWrite.cxx.

◆ SetFltPrecision()

void TGDMLWrite::SetFltPrecision ( UInt_t prec )

inlineprivate

Definition at line 206 of file TGDMLWrite.h.

◆ SetG4Compatibility()

void TGDMLWrite::SetG4Compatibility ( Bool_t G4Compatible )

inline

Definition at line 79 of file TGDMLWrite.h.

◆ SetNamingSpeed()

void TGDMLWrite::SetNamingSpeed ( ENamingType naming )

Set convention of naming solids and volumes.

Definition at line 226 of file TGDMLWrite.cxx.

◆ StartAssemblyN()

XMLNodePointer_t TGDMLWrite::StartAssemblyN ( const char * name )

private

Creates "assembly" node for GDML.

Definition at line 1683 of file TGDMLWrite.cxx.

◆ StartGDMLWriting()

static void TGDMLWrite::StartGDMLWriting	(	TGeoManager *	geomanager,
		const char *	filename,
		TString	option
	)

inlinestatic

Definition at line 55 of file TGDMLWrite.h.

◆ StartVolumeN()

XMLNodePointer_t TGDMLWrite::StartVolumeN	(	const char *	name,
		const char *	solid,
		const char *	material
	)

private

Creates "volume" node for GDML.

Definition at line 1663 of file TGDMLWrite.cxx.

◆ UnsetTemporaryBits()

void TGDMLWrite::UnsetTemporaryBits ( TGeoManager * geoMng )

private

Unsetting bits that were changed in gGeoManager during export so that export can be run more times with the same instance of gGeoManager.

Definition at line 2102 of file TGDMLWrite.cxx.

◆ WriteGDMLfile() [1/3]

void TGDMLWrite::WriteGDMLfile	(	TGeoManager *	geomanager,
		const char *	filename = `"test.gdml"`,
		TString	option = `""`
	)

Definition at line 233 of file TGDMLWrite.cxx.

◆ WriteGDMLfile() [2/3]

void TGDMLWrite::WriteGDMLfile	(	TGeoManager *	geomanager,
		TGeoVolume *	volume,
		const char *	filename = `"test.gdml"`,
		TString	option = `""`
	)

Definition at line 247 of file TGDMLWrite.cxx.

◆ WriteGDMLfile() [3/3]

void TGDMLWrite::WriteGDMLfile	(	TGeoManager *	geomanager,
		TGeoVolume *	volume,
		TList *	materialsLst,
		const char *	filename,
		TString	option
	)

private

Wrapper of all exporting methods Creates blank GDML file and fills it with gGeoManager structure converted to GDML structure of xml nodes.

Definition at line 268 of file TGDMLWrite.cxx.

Member Data Documentation

◆ fAccPatt

StructLst* TGDMLWrite::fAccPatt

private

Definition at line 105 of file TGDMLWrite.h.

◆ fActNameErr

UInt_t TGDMLWrite::fActNameErr

private

Definition at line 124 of file TGDMLWrite.h.

◆ fDefineNode

XMLNodePointer_t TGDMLWrite::fDefineNode

private

Definition at line 118 of file TGDMLWrite.h.

◆ fElementList

StructLst* TGDMLWrite::fElementList

private

Definition at line 104 of file TGDMLWrite.h.

◆ fFltPrecision

UInt_t TGDMLWrite::fFltPrecision

private

Definition at line 126 of file TGDMLWrite.h.

◆ fGdmlE

TXMLEngine* TGDMLWrite::fGdmlE

private

Definition at line 116 of file TGDMLWrite.h.

◆ fGdmlFile

XMLDocPointer_t TGDMLWrite::fGdmlFile

private

Definition at line 114 of file TGDMLWrite.h.

◆ fgG4Compatibility

Bool_t TGDMLWrite::fgG4Compatibility

private

Definition at line 113 of file TGDMLWrite.h.

◆ fgGDMLWrite

TGDMLWrite * TGDMLWrite::fgGDMLWrite = 0

staticprivate

Definition at line 111 of file TGDMLWrite.h.

◆ fgkMaxNameErr

const UInt_t TGDMLWrite::fgkMaxNameErr = 5

staticprivate

Definition at line 130 of file TGDMLWrite.h.

◆ fgkProcBit

const UInt_t TGDMLWrite::fgkProcBit = BIT(14)

staticprivate

floating point precision when writing

Definition at line 128 of file TGDMLWrite.h.

◆ fgkProcBitVol

const UInt_t TGDMLWrite::fgkProcBitVol = BIT(19)

staticprivate

Definition at line 129 of file TGDMLWrite.h.

◆ fgNamingSpeed

Int_t TGDMLWrite::fgNamingSpeed

private

Definition at line 112 of file TGDMLWrite.h.

◆ fIsotopeList

StructLst* TGDMLWrite::fIsotopeList

private

Definition at line 103 of file TGDMLWrite.h.

◆ fMaterialsNode

XMLNodePointer_t TGDMLWrite::fMaterialsNode

private

Definition at line 119 of file TGDMLWrite.h.

◆ fNameList

NameLst* TGDMLWrite::fNameList

private

Definition at line 108 of file TGDMLWrite.h.

◆ fPhysVolCnt

Int_t TGDMLWrite::fPhysVolCnt

private

Definition at line 123 of file TGDMLWrite.h.

◆ fRejShape

StructLst* TGDMLWrite::fRejShape

private

Definition at line 106 of file TGDMLWrite.h.

◆ fSolCnt

UInt_t TGDMLWrite::fSolCnt

private

Definition at line 125 of file TGDMLWrite.h.

◆ fSolidsNode

XMLNodePointer_t TGDMLWrite::fSolidsNode

private

Definition at line 120 of file TGDMLWrite.h.

◆ fStructureNode

XMLNodePointer_t TGDMLWrite::fStructureNode

private

Definition at line 121 of file TGDMLWrite.h.

◆ fTopVolumeName

TString TGDMLWrite::fTopVolumeName

private

Definition at line 115 of file TGDMLWrite.h.

◆ fVolCnt

Int_t TGDMLWrite::fVolCnt

private

Definition at line 122 of file TGDMLWrite.h.

Libraries for TGDMLWrite:

[legend]

Private Attributes
StructLst *	fAccPatt

UInt_t	fActNameErr

XMLNodePointer_t	fDefineNode

StructLst *	fElementList

UInt_t	fFltPrecision

TXMLEngine *	fGdmlE

XMLDocPointer_t	fGdmlFile

Bool_t	fgG4Compatibility

Int_t	fgNamingSpeed

StructLst *	fIsotopeList

XMLNodePointer_t	fMaterialsNode

NameLst *	fNameList

Int_t	fPhysVolCnt

StructLst *	fRejShape

UInt_t	fSolCnt

XMLNodePointer_t	fSolidsNode

XMLNodePointer_t	fStructureNode

TString	fTopVolumeName

Int_t	fVolCnt

Solids:

Materials:

Structure

Options:

USAGE:

Note:

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ NameList

◆ NameListF

◆ NameListI

◆ NameListS

Member Enumeration Documentation

◆ ENamingType

Constructor & Destructor Documentation

◆ TGDMLWrite()

◆ ~TGDMLWrite()

Member Function Documentation

◆ CanProcess()

◆ ChooseObject()

◆ CreateArb8N()

◆ CreateAtomN()

◆ CreateBoxN()

◆ CreateCommonBoolN()

◆ CreateConeN() [1/2]

◆ CreateConeN() [2/2]

◆ CreateCutTubeN()

◆ CreateDivisionN()

◆ CreateDN()

◆ CreateElConeN()

◆ CreateElementN()

◆ CreateEllipsoidN()

◆ CreateEltubeN()

◆ CreateFakeCtub()

◆ CreateFractionN()

◆ CreateHypeN()

◆ CreateIsotopN()

◆ CreateMaterialN()

◆ CreateMixtureN()

◆ CreateParaboloidN()

◆ CreateParaN()

◆ CreatePhysVolN()

◆ CreatePolyconeN()

◆ CreatePolyhedraN()

◆ CreatePositionN()

◆ CreateRotationN()

◆ CreateSetupN()

◆ CreateSphereN()

◆ CreateTorusN()

◆ CreateTrapN()

◆ CreateTrdN() [1/2]

◆ CreateTrdN() [2/2]

◆ CreateTubeN() [1/2]

◆ CreateTubeN() [2/2]

◆ CreateTwistedTrapN()

◆ CreateXtrusionN()

◆ CreateZplaneN()

◆ ExtractMaterials()

◆ ExtractSolid()

◆ ExtractVolumes()

◆ GenName() [1/2]

◆ GenName() [2/2]

◆ GetFltPrecision()

◆ GetPattAxis()

◆ GetXYZangles()

◆ IsInList()

◆ IsNullParam()

◆ SetFltPrecision()

◆ SetG4Compatibility()

◆ SetNamingSpeed()

◆ StartAssemblyN()

◆ StartGDMLWriting()