Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
TGDMLWrite Class Reference

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 ...>
TGeoTessellated -> <tessellated ...>
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
if(name) objname
Composite shapes are Boolean combinations of two or more shape components.
A paraboloid is defined by the revolution surface generated by a parabola and is bounded by two plane...
A shape scaled by a TGeoScale transformation.
Tessellated solid class.
A TGeoXtru shape is represented by the extrusion of an arbitrary polygon with fixed outline between s...
Definition TGeoXtru.h:22
void box(Int_t pat, Double_t x1, Double_t y1, Double_t x2, Double_t y2)
Definition fillpatterns.C:1

Materials:

TGeoIsotope -> <isotope ...>
TGeoElement -> <element ...>
TGeoMaterial -> <material ...>
TGeoMixture -> <material ...>
Base class for chemical elements.
Definition TGeoElement.h:31
an isotope defined by the atomic number, number of nucleons and atomic weight (g/mole)
Definition TGeoElement.h:92
Base class describing materials.
Mixtures of elements.

Structure

TGeoVolume -> <volume ...> or
- -> <assembly ...>
TGeoNode -> <physvol ...>
TGeoPatternFinder -> <divisionvol ...>
A node represent a volume positioned inside another.They store links to both volumes and to the TGeoM...
Definition TGeoNode.h:39
base finder class for patterns. A pattern is specifying a division type
TGeoVolume, TGeoVolumeMulti, TGeoVolumeAssembly are the volume classes.
Definition TGeoVolume.h:43

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 ...)
#define f(i)
Definition RSha256.hxx:104
#define g(i)
Definition RSha256.hxx:105
#define a(i)
Definition RSha256.hxx:99
externTGeoManager * gGeoManager
STL class.
const Int_t n
Definition legend1.C:16

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 56 of file TGDMLWrite.h.

Classes

struct  NameLst
struct  StructLst
struct  Xyz

Public Types

enum  { kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) }
enum  ENamingType { kelegantButSlow = 0 , kwithoutSufixNotUniq = 1 , kfastButUglySufix = 2 }
enum  EStatusBits {
  kCanDelete = (1ULL << (0)) , kMustCleanup = (1ULL << (3)) , kIsReferenced = (1ULL << (4)) , kHasUUID = (1ULL << (5)) ,
  kCannotPick = (1ULL << (6)) , kNoContextMenu = (1ULL << (8)) , kInvalidObject = (1ULL << (13))
}

Public Member Functions

 TGDMLWrite ()
 Default constructor.
 ~TGDMLWrite () override
 Destructor.
void AbstractMethod (const char *method) const
 Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
virtual void Clear (Option_t *="")
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
virtual void Copy (TObject &object) const
 Copy this to obj.
virtual void Delete (Option_t *option="")
 Delete this object.
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
virtual void Dump () const
 Dump contents of object on stdout.
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
virtual const char * GetIconName () const
 Returns mime type name of object.
virtual const char * GetName () const
 Returns name of object.
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
virtual Option_tGetOption () const
virtual const char * GetTitle () const
 Returns title of object.
virtual UInt_t GetUniqueID () const
 Return the unique object id.
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
virtual ULong_t Hash () const
 Return hash value for this object.
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.
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
void InvertBit (UInt_t f)
TClassIsA () const override
Bool_t IsDestructed () const
 IsDestructed.
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Bool_t IsOnHeap () const
virtual Bool_t IsSortable () const
Bool_t IsZombie () const
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
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).
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
void operator delete (void *, size_t)
 Operator delete for sized deallocation.
void operator delete (void *ptr)
 Operator delete.
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
void operator delete[] (void *, size_t)
 Operator delete [] for sized deallocation.
void operator delete[] (void *ptr)
 Operator delete [].
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
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)
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
void ResetBit (UInt_t f)
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
void SetBit (UInt_t f)
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
void SetG4Compatibility (Bool_t G4Compatible)
void SetIgnoreDummyMaterial (bool value)
 Ignore dummy material instance, which causes trouble reading GDML in Geant4.
void SetNamingSpeed (ENamingType naming)
 Set convention of naming solids and volumes.
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
void Streamer (TBuffer &) override
 Stream an object of class TObject.
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
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.
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
void WriteGDMLfile (TGeoManager *geomanager, const char *filename="test.gdml", TString option="")
void WriteGDMLfile (TGeoManager *geomanager, TGeoNode *top_node, const char *filename="test.gdml", TString option="")
void WriteGDMLfile (TGeoManager *geomanager, TGeoVolume *top_vol, const char *filename="test.gdml", TString option="")

Static Public Member Functions

static TClassClass ()
static const char * Class_Name ()
static constexpr Version_t Class_Version ()
static const char * DeclFileName ()
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
static Bool_t GetObjectStat ()
 Get status of object stat flag.
static void SetDtorOnly (void *obj)
 Set destructor only flag.
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
static void StartGDMLWriting (TGeoManager *geomanager, const char *filename, TString option)

Protected Types

enum  { kOnlyPrepStep = (1ULL << (3)) }

Protected Member Functions

virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
void MakeZombie ()

Static Protected Member Functions

static void SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
 Save object constructor in the output stream "out".
static void SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
 Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
 Save array in the output stream "out" as vector.

Private Types

typedef std::map< TString, Bool_tNameList
typedef std::map< TString, Float_tNameListF
typedef std::map< TString, Int_tNameListI
typedef std::map< TString, TStringNameListS
typedef std::set< const TGeoNode * > NodeList
typedef std::set< const TGeoOpticalSurface * > SurfaceList
typedef std::set< const TGeoVolume * > VolList

Private Member Functions

Bool_t CanProcess (TObject *pointer)
 Method which tests whether solids can be processed.
XMLNodePointer_t ChooseObject (TGeoShape *geoShape)
 Chooses the object and method that should be used for processing object.
XMLNodePointer_t CreateArb8N (TGeoArb8 *geoShape)
 Creates "arb8" node for GDML.
XMLNodePointer_t CreateAtomN (Double_t atom, const char *unit="g/mole")
 Creates "atom" node for GDML.
XMLNodePointer_t CreateBorderSurfaceN (TGeoBorderSurface *geoSurf)
 Creates "bordersurface" node for GDML.
XMLNodePointer_t CreateBoxN (TGeoBBox *geoShape)
 Creates "box" node for GDML.
XMLNodePointer_t CreateCommonBoolN (TGeoCompositeShape *geoShape)
 Creates common part of union intersection and subtraction nodes.
XMLNodePointer_t CreateConeN (TGeoCone *geoShape)
 Creates "cone" node for GDML from TGeoCone object.
XMLNodePointer_t CreateConeN (TGeoConeSeg *geoShape)
 Creates "cone" node for GDML from TGeoConeSeg object.
XMLNodePointer_t CreateConstantN (const char *name, Double_t value)
 Creates "constant" kind of node for GDML.
XMLNodePointer_t CreateCutTubeN (TGeoCtub *geoShape)
 Creates "cutTube" node for GDML.
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.
XMLNodePointer_t CreateDN (Double_t density, const char *unit="g/cm3")
 Creates "D" density node for GDML.
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.
XMLNodePointer_t CreateElementN (TGeoElement *element, XMLNodePointer_t materials, const char *name)
 Creates "element" node for GDML element node and attribute.
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.
XMLNodePointer_t CreateEltubeN (TGeoEltu *geoShape)
 Creates "eltube" node for GDML.
TGeoCompositeShapeCreateFakeCtub (TGeoCtub *geoShape)
 Method creating cutTube as an intersection of tube and two boxes.
XMLNodePointer_t CreateFractionN (Double_t percentage, const char *refName)
 Creates "fraction" node for GDML.
XMLNodePointer_t CreateHypeN (TGeoHype *geoShape)
 Creates "hype" node for GDML.
XMLNodePointer_t CreateIsotopN (TGeoIsotope *isotope, const char *name)
 Creates "isotope" node for GDML.
XMLNodePointer_t CreateMaterialN (TGeoMaterial *material, TString mname)
 Creates "material" node for GDML.
XMLNodePointer_t CreateMatrixN (TGDMLMatrix const *matrix)
 Creates "matrix" kind of node for GDML.
XMLNodePointer_t CreateMixtureN (TGeoMixture *mixture, XMLNodePointer_t materials, TString mname)
 Creates "material" node for GDML with references to other sub elements.
XMLNodePointer_t CreateOpticalSurfaceN (TGeoOpticalSurface *geoSurf)
 Creates "opticalsurface" node for GDML.
XMLNodePointer_t CreateParaboloidN (TGeoParaboloid *geoShape)
 Creates "paraboloid" node for GDML.
XMLNodePointer_t CreateParaN (TGeoPara *geoShape)
 Creates "para" node for GDML.
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.
XMLNodePointer_t CreatePolyconeN (TGeoPcon *geoShape)
 Creates "polycone" node for GDML.
XMLNodePointer_t CreatePolyhedraN (TGeoPgon *geoShape)
 Creates "polyhedra" node for GDML.
XMLNodePointer_t CreatePositionN (const char *name, Xyz position, const char *type, const char *unit)
 Creates "position" kind of node for GDML.
XMLNodePointer_t CreatePropertyN (TNamed const &property)
 Creates "property" node for GDML.
XMLNodePointer_t CreateRotationN (const char *name, Xyz rotation, const char *type="rotation", const char *unit="deg")
 Creates "rotation" kind of node for GDML.
XMLNodePointer_t CreateScaledN (TGeoScaledShape *geoShape)
 Creates a scaled node for GDML.
XMLNodePointer_t CreateSetupN (const char *topVolName, const char *name="default", const char *version="1.0")
 Creates "setup" node for GDML.
XMLNodePointer_t CreateSkinSurfaceN (TGeoSkinSurface *geoSurf)
 Creates "skinsurface" node for GDML.
XMLNodePointer_t CreateSphereN (TGeoSphere *geoShape)
 Creates "sphere" node for GDML.
XMLNodePointer_t CreateTessellatedN (TGeoTessellated *geoShape)
 Creates "tessellated" (tessellated shape) node for GDML.
XMLNodePointer_t CreateTorusN (TGeoTorus *geoShape)
 Creates "torus" node for GDML.
XMLNodePointer_t CreateTrapN (TGeoTrap *geoShape)
 Creates "trap" node for GDML.
XMLNodePointer_t CreateTrdN (TGeoTrd1 *geoShape)
 Creates "trd" node for GDML from object TGeoTrd1.
XMLNodePointer_t CreateTrdN (TGeoTrd2 *geoShape)
 Creates "trd" node for GDML from object TGeoTrd2.
XMLNodePointer_t CreateTubeN (TGeoTube *geoShape)
 Creates "tube" node for GDML from object TGeoTube.
XMLNodePointer_t CreateTubeN (TGeoTubeSeg *geoShape)
 Creates "tube" node for GDML from object TGeoTubeSeg.
XMLNodePointer_t CreateTwistedTrapN (TGeoGtra *geoShape)
 Creates "twistedtrap" node for GDML.
XMLNodePointer_t CreateXtrusionN (TGeoXtru *geoShape)
 Creates "xtru" node for GDML.
XMLNodePointer_t CreateZplaneN (Double_t z, Double_t rmin, Double_t rmax)
 Creates "zplane" node for GDML.
void ExtractBorderSurfaces (TObjArray *surfaces)
 Method exporting border surfaces.
void ExtractConstants (TGeoManager *geom)
 Method exporting GDML matrices.
XMLNodePointer_t ExtractMaterials (TList *materialsLst)
 Method exporting materials.
void ExtractMatrices (TObjArray *matrices)
 Method exporting GDML matrices.
void ExtractOpticalSurfaces (TObjArray *surfaces)
 Method exporting optical surfaces.
void ExtractSkinSurfaces (TObjArray *surfaces)
 Method exporting skin surfaces.
TString ExtractSolid (TGeoShape *volShape)
 Method creating solid to xml file and returning its name.
void ExtractVolumes (TGeoNode *topNode)
 Method extracting geometry structure recursively.
void ExtractVolumes (TGeoVolume *topVolume)
 Method extracting geometry structure recursively.
TString GenName (TString oldname)
 NCNAME basic restrictions Replace "$" character with empty character etc.
TString GenName (TString oldname, TString objPointer)
 Important function which is responsible for naming volumes, solids and materials.
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.
Xyz GetXYZangles (const Double_t *rotationMatrix)
 Retrieves X Y Z angles from rotation matrix.
Bool_t IsInList (NameList list, TString name2check)
 Checks whether name2check is in (NameList) list.
Bool_t IsNullParam (Double_t parValue, TString parName, TString objName)
 Check for null parameter to skip the NULL objects.
void SetFltPrecision (UInt_t prec)
XMLNodePointer_t StartAssemblyN (const char *name)
 Creates "assembly" node for GDML.
XMLNodePointer_t StartVolumeN (const char *name, const char *solid, const char *material)
 Creates "volume" node for GDML.
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.
void WriteGDMLfile (TGeoManager *geomanager, TGeoNode *top_node, 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.
void WriteGDMLfile (TGeoManager *geomanager, TGeoVolume *top_vol, 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.

Static Private Member Functions

static void AddToTObjectTable (TObject *)
 Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes

StructLstfAccPatt
UInt_t fActNameErr
UInt_t fBits
 bit field status word
TString fDefault_lunit
XMLNodePointer_t fDefineNode
StructLstfElementList
UInt_t fFltPrecision
 ! floating point precision when writing
TXMLEnginefGdmlE
XMLDocPointer_t fGdmlFile
Bool_t fgG4Compatibility
Int_t fgNamingSpeed
Int_t fIgnoreDummyMaterial
StructLstfIsotopeList
XMLNodePointer_t fMaterialsNode
NameLstfNameList
NodeList fNodeList
Int_t fPhysVolCnt
StructLstfRejShape
UInt_t fSolCnt
XMLNodePointer_t fSolidsNode
XMLNodePointer_t fStructureNode
SurfaceList fSurfaceList
TGeoVolumefTopVolume = nullptr
TString fTopVolumeName
UInt_t fUniqueID
 object unique identifier
Int_t fVolCnt
VolList fVolumeList

Static Private Attributes

static Longptr_t fgDtorOnly = 0
 object for which to call dtor only (i.e. no delete)
static TGDMLWritefgGDMLWrite = nullptr
static const UInt_t fgkMaxNameErr = 5
static const UInt_t fgkProcBit = (1ULL << (14))
static const UInt_t fgkProcBitVol = (1ULL << (19))
static Bool_t fgObjectStat = kTRUE
 if true keep track of objects in TObjectTable

#include <TGDMLWrite.h>

Inheritance diagram for TGDMLWrite:
TObject

Member Typedef Documentation

◆ NameList

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

Definition at line 96 of file TGDMLWrite.h.

◆ NameListF

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

Definition at line 99 of file TGDMLWrite.h.

◆ NameListI

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

Definition at line 98 of file TGDMLWrite.h.

◆ NameListS

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

Definition at line 97 of file TGDMLWrite.h.

◆ NodeList

typedef std::set<const TGeoNode *> TGDMLWrite::NodeList
private

Definition at line 95 of file TGDMLWrite.h.

◆ SurfaceList

typedef std::set<const TGeoOpticalSurface *> TGDMLWrite::SurfaceList
private

Definition at line 93 of file TGDMLWrite.h.

◆ VolList

typedef std::set<const TGeoVolume *> TGDMLWrite::VolList
private

Definition at line 94 of file TGDMLWrite.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
kOnlyPrepStep 

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kSingleKey 

write collection with single key

kOverwrite 

overwrite existing object with same name

kWriteDelete 

write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kIsOnHeap 

object is on heap

kNotDeleted 

object has not been deleted

kZombie 

object ctor failed

kInconsistent 

class overload Hash but does call RecursiveRemove in destructor

kBitMask 

Definition at line 89 of file TObject.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ ENamingType

Enumerator
kelegantButSlow 
kwithoutSufixNotUniq 
kfastButUglySufix 

Definition at line 80 of file TGDMLWrite.h.

◆ EStatusBits

enum TObject::EStatusBits
inherited
Enumerator
kCanDelete 

if object in a list can be deleted

kMustCleanup 

if object destructor must call RecursiveRemove()

kIsReferenced 

if object is referenced by a TRef or TRefArray

kHasUUID 

if object has a TUUID (its fUniqueID=UUIDNumber)

kCannotPick 

if object in a pad cannot be picked

kNoContextMenu 

if object does not want context menu

kInvalidObject 

if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

Constructor & Destructor Documentation

◆ TGDMLWrite()

TGDMLWrite::TGDMLWrite ( )

Default constructor.

Definition at line 206 of file TGDMLWrite.cxx.

◆ ~TGDMLWrite()

TGDMLWrite::~TGDMLWrite ( )
override

Destructor.

Definition at line 236 of file TGDMLWrite.cxx.

Member Function Documentation

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method) const
inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning
This interface is a legacy function that is no longer recommended to be used by new development code.
Note
The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op)
staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "")
virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ Browse()

◆ CanProcess()

Bool_t TGDMLWrite::CanProcess ( TObject * pointer)
private

Method which tests whether solids can be processed.

Definition at line 2484 of file TGDMLWrite.cxx.

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )
inlineinherited

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

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ ChooseObject()

XMLNodePointer_t TGDMLWrite::ChooseObject ( TGeoShape * geoShape)
private

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

Definition at line 2221 of file TGDMLWrite.cxx.

◆ Class()

TClass * TGDMLWrite::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

const char * TGDMLWrite::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

constexpr Version_t TGDMLWrite::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 252 of file TGDMLWrite.h.

◆ ClassName()

const char * TObject::ClassName ( ) const
virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ Clear()

◆ Clone()

TObject * TObject::Clone ( const char * newname = "") const
virtualinherited

Make a clone of an object using the Streamer facility.

If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.

If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented in RooAbsArg, RooAbsBinning, RooAbsCollection, RooAbsStudy, RooCatType, RooCmdArg, RooDataHist, RooDataSet, RooFitResult, RooLinkedList, RooStats::HypoTestResult, RooStats::ModelConfig, RooStudyPackage, RooTemplateProxy< T >, RooTemplateProxy< const RooHistFunc >, RooTemplateProxy< RooAbsCategory >, RooTemplateProxy< RooAbsPdf >, RooTemplateProxy< RooAbsReal >, RooTemplateProxy< RooAbsRealLValue >, RooTemplateProxy< RooMultiCategory >, RooTemplateProxy< RooRealVar >, RooWorkspace, TASImage, TChainIndex, TClass, TCollection, TF1, TFunction, TFunctionTemplate, TH1, TImage, TMethod, TMethodCall, TMinuit, TMVA::MinuitWrapper, TNamed, TStreamerInfo, and TTreeIndex.

Definition at line 243 of file TObject.cxx.

◆ Compare()

Int_t TObject::Compare ( const TObject * obj) const
virtualinherited

Compare abstract method.

Must be overridden if a class wants to be able to compare itself with other objects. Must return -1 if this is smaller than obj, 0 if objects are equal and 1 if this is larger than obj.

Reimplemented in RooAbsArg, RooDouble, TCollection, TEnvRec, TFileInfo, TGeoBranchArray, TGeoOverlap, TGFSFrameElement, TGLBFrameElement, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TStructNode, TStructNodeProperty, and TUrl.

Definition at line 258 of file TObject.cxx.

◆ Copy()

◆ CreateArb8N()

XMLNodePointer_t TGDMLWrite::CreateArb8N ( TGeoArb8 * geoShape)
private

Creates "arb8" node for GDML.

Definition at line 1123 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 806 of file TGDMLWrite.cxx.

◆ CreateBorderSurfaceN()

XMLNodePointer_t TGDMLWrite::CreateBorderSurfaceN ( TGeoBorderSurface * geoSurf)
private

Creates "bordersurface" node for GDML.

Definition at line 2016 of file TGDMLWrite.cxx.

◆ CreateBoxN()

XMLNodePointer_t TGDMLWrite::CreateBoxN ( TGeoBBox * geoShape)
private

Creates "box" node for GDML.

Definition at line 1055 of file TGDMLWrite.cxx.

◆ CreateCommonBoolN()

XMLNodePointer_t TGDMLWrite::CreateCommonBoolN ( TGeoCompositeShape * geoShape)
private

Creates common part of union intersection and subtraction nodes.

Definition at line 1844 of file TGDMLWrite.cxx.

◆ CreateConeN() [1/2]

XMLNodePointer_t TGDMLWrite::CreateConeN ( TGeoCone * geoShape)
private

Creates "cone" node for GDML from TGeoCone object.

Definition at line 1185 of file TGDMLWrite.cxx.

◆ CreateConeN() [2/2]

XMLNodePointer_t TGDMLWrite::CreateConeN ( TGeoConeSeg * geoShape)
private

Creates "cone" node for GDML from TGeoConeSeg object.

Definition at line 1158 of file TGDMLWrite.cxx.

◆ CreateConstantN()

XMLNodePointer_t TGDMLWrite::CreateConstantN ( const char * name,
Double_t value )
private

Creates "constant" kind of node for GDML.

Definition at line 2096 of file TGDMLWrite.cxx.

◆ CreateCutTubeN()

XMLNodePointer_t TGDMLWrite::CreateCutTubeN ( TGeoCtub * geoShape)
private

Creates "cutTube" node for GDML.

Definition at line 1410 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 2186 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 818 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 1727 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 867 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 1690 of file TGDMLWrite.cxx.

◆ CreateEltubeN()

XMLNodePointer_t TGDMLWrite::CreateEltubeN ( TGeoEltu * geoShape)
private

Creates "eltube" node for GDML.

Definition at line 1599 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 2329 of file TGDMLWrite.cxx.

◆ CreateFractionN()

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

Creates "fraction" node for GDML.

Definition at line 830 of file TGDMLWrite.cxx.

◆ CreateHypeN()

XMLNodePointer_t TGDMLWrite::CreateHypeN ( TGeoHype * geoShape)
private

Creates "hype" node for GDML.

Definition at line 1622 of file TGDMLWrite.cxx.

◆ CreateIsotopN()

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

Creates "isotope" node for GDML.

Definition at line 853 of file TGDMLWrite.cxx.

◆ CreateMaterialN()

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

Creates "material" node for GDML.

Definition at line 1003 of file TGDMLWrite.cxx.

◆ CreateMatrixN()

XMLNodePointer_t TGDMLWrite::CreateMatrixN ( TGDMLMatrix const * matrix)
private

Creates "matrix" kind of node for GDML.

Definition at line 2071 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 932 of file TGDMLWrite.cxx.

◆ CreateOpticalSurfaceN()

XMLNodePointer_t TGDMLWrite::CreateOpticalSurfaceN ( TGeoOpticalSurface * geoSurf)
private

Creates "opticalsurface" node for GDML.

Definition at line 1963 of file TGDMLWrite.cxx.

◆ CreateParaboloidN()

XMLNodePointer_t TGDMLWrite::CreateParaboloidN ( TGeoParaboloid * geoShape)
private

Creates "paraboloid" node for GDML.

Definition at line 1076 of file TGDMLWrite.cxx.

◆ CreateParaN()

XMLNodePointer_t TGDMLWrite::CreateParaN ( TGeoPara * geoShape)
private

Creates "para" node for GDML.

Definition at line 1211 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 2153 of file TGDMLWrite.cxx.

◆ CreatePolyconeN()

XMLNodePointer_t TGDMLWrite::CreatePolyconeN ( TGeoPcon * geoShape)
private

Creates "polycone" node for GDML.

Definition at line 1494 of file TGDMLWrite.cxx.

◆ CreatePolyhedraN()

XMLNodePointer_t TGDMLWrite::CreatePolyhedraN ( TGeoPgon * geoShape)
private

Creates "polyhedra" node for GDML.

Definition at line 1577 of file TGDMLWrite.cxx.

◆ CreatePositionN()

XMLNodePointer_t TGDMLWrite::CreatePositionN ( const char * name,
Xyz position,
const char * type,
const char * unit )
private

Creates "position" kind of node for GDML.

Definition at line 2041 of file TGDMLWrite.cxx.

◆ CreatePropertyN()

XMLNodePointer_t TGDMLWrite::CreatePropertyN ( TNamed const & property)
private

Creates "property" node for GDML.

Definition at line 842 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 2056 of file TGDMLWrite.cxx.

◆ CreateScaledN()

XMLNodePointer_t TGDMLWrite::CreateScaledN ( TGeoScaledShape * geoShape)
private

Creates a scaled node for GDML.

Definition at line 1793 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 2109 of file TGDMLWrite.cxx.

◆ CreateSkinSurfaceN()

XMLNodePointer_t TGDMLWrite::CreateSkinSurfaceN ( TGeoSkinSurface * geoSurf)
private

Creates "skinsurface" node for GDML.

Definition at line 1996 of file TGDMLWrite.cxx.

◆ CreateSphereN()

XMLNodePointer_t TGDMLWrite::CreateSphereN ( TGeoSphere * geoShape)
private

Creates "sphere" node for GDML.

Definition at line 1096 of file TGDMLWrite.cxx.

◆ CreateTessellatedN()

XMLNodePointer_t TGDMLWrite::CreateTessellatedN ( TGeoTessellated * geoShape)
private

Creates "tessellated" (tessellated shape) node for GDML.

Definition at line 1754 of file TGDMLWrite.cxx.

◆ CreateTorusN()

XMLNodePointer_t TGDMLWrite::CreateTorusN ( TGeoTorus * geoShape)
private

Creates "torus" node for GDML.

Definition at line 1552 of file TGDMLWrite.cxx.

◆ CreateTrapN()

XMLNodePointer_t TGDMLWrite::CreateTrapN ( TGeoTrap * geoShape)
private

Creates "trap" node for GDML.

Definition at line 1232 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 1339 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 1362 of file TGDMLWrite.cxx.

◆ CreateTubeN() [1/2]

XMLNodePointer_t TGDMLWrite::CreateTubeN ( TGeoTube * geoShape)
private

Creates "tube" node for GDML from object TGeoTube.

Definition at line 1455 of file TGDMLWrite.cxx.

◆ CreateTubeN() [2/2]

XMLNodePointer_t TGDMLWrite::CreateTubeN ( TGeoTubeSeg * geoShape)
private

Creates "tube" node for GDML from object TGeoTubeSeg.

Definition at line 1385 of file TGDMLWrite.cxx.

◆ CreateTwistedTrapN()

XMLNodePointer_t TGDMLWrite::CreateTwistedTrapN ( TGeoGtra * geoShape)
private

Creates "twistedtrap" node for GDML.

Definition at line 1278 of file TGDMLWrite.cxx.

◆ CreateXtrusionN()

XMLNodePointer_t TGDMLWrite::CreateXtrusionN ( TGeoXtru * geoShape)
private

Creates "xtru" node for GDML.

Definition at line 1647 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 1479 of file TGDMLWrite.cxx.

◆ DeclFileName()

const char * TGDMLWrite::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 252 of file TGDMLWrite.h.

◆ Delete()

void TObject::Delete ( Option_t * option = "")
virtualinherited

◆ DistancetoPrimitive()

◆ DoError()

void TObject::DoError ( int level,
const char * location,
const char * fmt,
va_list va ) const
protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ Draw()

◆ DrawClass()

void TObject::DrawClass ( ) const
virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "") const
virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note
For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

◆ Dump()

void TObject::Dump ( ) const
virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle 0 Arrow opening angle (degrees)
fArrowSize 0.2 Arrow Size
fOption.*fData
fX1 0.1 X of 1st point
fY1 0.15 Y of 1st point
fX2 0.67 X of 2nd point
fY2 0.83 Y of 2nd point
fUniqueID 0 object unique identifier
fBits 50331648 bit field status word
fLineColor 1 line color
fLineStyle 1 line style
fLineWidth 1 line width
fFillColor 19 fill area color
fFillStyle 1001 fill area style
#define X(type, name)
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line
TCanvas * style()
Definition style.C:1

Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.

Definition at line 367 of file TObject.cxx.

◆ Error()

void TObject::Error ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Execute() [1/2]

void TObject::Execute ( const char * method,
const char * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute ( TMethod * method,
TObjArray * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters
Collectable string class.
Definition TObjString.h:28

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

◆ ExtractBorderSurfaces()

void TGDMLWrite::ExtractBorderSurfaces ( TObjArray * surfaces)
private

Method exporting border surfaces.

Definition at line 512 of file TGDMLWrite.cxx.

◆ ExtractConstants()

void TGDMLWrite::ExtractConstants ( TGeoManager * geom)
private

Method exporting GDML matrices.

Definition at line 456 of file TGDMLWrite.cxx.

◆ ExtractMaterials()

XMLNodePointer_t TGDMLWrite::ExtractMaterials ( TList * materialsLst)
private

Method exporting materials.

Definition at line 547 of file TGDMLWrite.cxx.

◆ ExtractMatrices()

void TGDMLWrite::ExtractMatrices ( TObjArray * matrices)
private

Method exporting GDML matrices.

Definition at line 440 of file TGDMLWrite.cxx.

◆ ExtractOpticalSurfaces()

void TGDMLWrite::ExtractOpticalSurfaces ( TObjArray * surfaces)
private

Method exporting optical surfaces.

Definition at line 473 of file TGDMLWrite.cxx.

◆ ExtractSkinSurfaces()

void TGDMLWrite::ExtractSkinSurfaces ( TObjArray * surfaces)
private

Method exporting skin surfaces.

Definition at line 492 of file TGDMLWrite.cxx.

◆ ExtractSolid()

TString TGDMLWrite::ExtractSolid ( TGeoShape * volShape)
private

Method creating solid to xml file and returning its name.

Definition at line 588 of file TGDMLWrite.cxx.

◆ ExtractVolumes() [1/2]

void TGDMLWrite::ExtractVolumes ( TGeoNode * topNode)
private

Method extracting geometry structure recursively.

Definition at line 606 of file TGDMLWrite.cxx.

◆ ExtractVolumes() [2/2]

void TGDMLWrite::ExtractVolumes ( TGeoVolume * topVolume)
private

Method extracting geometry structure recursively.

Definition at line 2708 of file TGDMLWrite.cxx.

◆ Fatal()

void TObject::Fatal ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

◆ FindObject() [1/2]

TObject * TObject::FindObject ( const char * name) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 425 of file TObject.cxx.

◆ FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 435 of file TObject.cxx.

◆ GenName() [1/2]

TString TGDMLWrite::GenName ( TString oldname)
private

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

Definition at line 2414 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 2444 of file TGDMLWrite.cxx.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const
virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )
staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetFltPrecision()

UInt_t TGDMLWrite::GetFltPrecision ( ) const
inlineprivate

Definition at line 232 of file TGDMLWrite.h.

◆ GetIconName()

const char * TObject::GetIconName ( ) const
virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

◆ GetName()

◆ GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px,
Int_t py ) const
virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ 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 2495 of file TGDMLWrite.cxx.

◆ GetTitle()

const char * TObject::GetTitle ( ) const
virtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented in Axis2, TASImage, TAxis, TBaseClass, TClassMenuItem, TEveGeoNode, TEvePointSet, TGaxis, TGGroupFrame, TGLabel, TGLVEntry, TGTextButton, TGTextEntry, TGTextLBEntry, TKey, TMapFile, TNamed, TPad, TPair, TParallelCoordSelect, TParticle, TPaveLabel, TPrimary, TQCommand, TRootIconList, and TVirtualPad.

Definition at line 507 of file TObject.cxx.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetXYZangles()

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

Retrieves X Y Z angles from rotation matrix.

Definition at line 2303 of file TGDMLWrite.cxx.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer)
virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TObject::Hash ( ) const
virtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:406

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1098
TObject()
TObject constructor.
Definition TObject.h:259
virtual ULong_t Hash() const
Return hash value for this object.
Definition TObject.cxx:539
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented in RooLinkedList, TASImagePlugin, TASPluginGS, TCollection, TEnvRec, TGObject, TGPicture, TIconBoxThumb, TImagePlugin, TNamed, TObjString, TPad, TPair, TParameter< AParamType >, TParameter< Long64_t >, TPave, and TStatistic.

Definition at line 539 of file TObject.cxx.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const
inlineinherited

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

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ Info()

void TObject::Info ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname) const
virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl) const
virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ Inspect()

void TObject::Inspect ( ) const
virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f)
inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

TClass * TGDMLWrite::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 252 of file TGDMLWrite.h.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const
inlineinherited

IsDestructed.

Note
This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).
Returns
true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj) const
virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

◆ IsInList()

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

Checks whether name2check is in (NameList) list.

Definition at line 2404 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 2528 of file TGDMLWrite.cxx.

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsSortable()

virtual Bool_t TObject::IsSortable ( ) const
inlinevirtualinherited

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ ls()

◆ MakeZombie()

void TObject::MakeZombie ( )
inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ MayNotUse()

void TObject::MayNotUse ( const char * method) const
inherited

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).

Definition at line 1160 of file TObject.cxx.

◆ Notify()

Bool_t TObject::Notify ( )
virtualinherited

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.

Definition at line 618 of file TObject.cxx.

◆ Obsolete()

void TObject::Obsolete ( const char * method,
const char * asOfVers,
const char * removedFromVers ) const
inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ operator delete() [1/3]

void TObject::operator delete ( void * ptr,
size_t size )
inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr)
inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete ( void * ptr,
void * vp )
inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr,
size_t size )
inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr)
inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr,
void * vp )
inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz)
inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

void * TObject::operator new ( size_t sz,
void * vp )
inlineinherited

Definition at line 191 of file TObject.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz)
inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

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

Definition at line 192 of file TObject.h.

◆ Paint()

void TObject::Paint ( Option_t * option = "")
virtualinherited

This method must be overridden if a class wants to paint itself.

The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.

Reimplemented in ROOT::Experimental::RTreeMapPainter, ROOT::RGeoPainter, TAnnotation, TArrow, TASImage, TASPaletteEditor::LimitLine, TASPaletteEditor::PaintPalette, TAxis3D, TBits, TBox, TButton, TCanvas, TClassTree, TCollection, TColorWheel, TCrown, TDiamond, TDirectory, TEfficiency, TEllipse, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoShape, TEveGeoTopNode, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TExec, TF1, TF2, TF3, TFile, TFileDrawMap, TFrame, TGaxis, TGenerator, TGeoBoolNode, TGeoIntersection, TGeoNode, TGeoOverlap, TGeoPainter, TGeoPhysicalNode, TGeoShape, TGeoSubtraction, TGeoTrack, TGeoUnion, TGeoVGShape, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2D, TGraph2DPainter, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGraphTime, TH1, THistPainter, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TNode, TNodeDiv, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TRatioPlot, TScatter2D, TScatter, TShape, TSpectrum2Painter, TSpider, TSpline, TSQLFile, TStyle, TText, TTreePerfStats, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TVirtualPad, TWbox, and TXMLFile.

Definition at line 631 of file TObject.cxx.

◆ Pop()

void TObject::Pop ( )
virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ Print()

void TObject::Print ( Option_t * option = "") const
virtualinherited

This method must be overridden when a class wants to print itself.

Reimplemented in Roo1DTable, RooAbsArg, RooAbsBinning, RooAbsCollection, RooAbsData, RooAbsDataStore, RooAbsGenContext, RooCatType, RooCmdArg, RooCurve, RooEllipse, RooFitResult, RooGenFitStudy, RooHist, RooLinkedList, RooMsgService, RooNumGenConfig, RooNumIntConfig, RooPlot, RooSharedProperties, RooStats::ModelConfig, ROOT::Experimental::REveTrans, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, ROOT::v5::TFormula, RooWorkspace, TAnnotation, TApplicationRemote, TAttParticle, TBenchmark, TBits, TBox, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchRef, TBranchSTL, TChain, TClassTable, TCling, TCollection, TColor, TDatabasePDG, TDecompBase, TDecompBK, TDecompChol, TDecompLU, TDecompQRH, TDecompSparse, TDecompSVD, TDirectory, TEllipse, TEnv, TEventList, TEveTrans, TF1, TFile, TFileCacheRead, TFileCacheWrite, TFileCollection, TFileInfo, TFileInfoMeta, TFitResult, TFoamCell, TFoamVect, TFormula, TFunction, TGCompositeFrame, TGDMLMatrix, TGeoBatemanSol, TGeoBorderSurface, TGeoBranchArray, TGeoDecayChannel, TGeoElement, TGeoElementRN, TGeoElementTable, TGeoIsotope, TGeoMatrix, TGeoOpticalSurface, TGeoOverlap, TGeoPhysicalNode, TGeoRegion, TGeoSkinSurface, TGeoTessellated, TGeoTrack, TGeoVolume, TGeoVoxelFinder, TGFont, TGFontPool, TGFrame, TGFrameElement, TGGC, TGGCPool, TGLayoutHints, TGMimeTypes, TGPicture, TGPicturePool, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphErrors, TGraphMultiErrors, TGTextEdit, TGWindow, TH1, THashTable, THbookTree, THelix, THnBase, THStack, TInetAddress, TKey, TLegend, TLegendEntry, TLine, TLorentzVector, TMacro, TMapFile, TMarker, TMatrixTBase< Element >, TMatrixTBase< Double_t >, TMatrixTBase< Float_t >, TMemFile, TMessageHandler, TMultiDimFit, TMultiGraph, TMVA::Event, TMVA::Option< T >, TMVA::Option< T * >, TMVA::OptionBase, TMVA::PDEFoamCell, TMVA::PDEFoamVect, TMVA::TNeuron, TNamed, TObjectTable, TObjString, TPad, TParallelCoordRange, TParallelCoordVar, TParameter< AParamType >, TParameter< Long64_t >, TParticle, TParticleClassPDG, TParticlePDG, TPave, TPaveText, TPluginHandler, TPluginManager, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TPrincipal, TQpDataDens, TQpDataSparse, TQpVar, TQSlot, TQuaternion, TRolke, TRootBrowserHistoryCursor, TScatter2D, TScatter, TSpectrum2, TSpectrum3, TSpectrum, TSQLColumnInfo, TSQLFile, TSQLStructure, TSQLTableInfo, TStatistic, TStopwatch, TStreamerInfoActions::TActionSequence, TText, TTree, TTreeCache, TTreeCacheUnzip, TTreeIndex, TTreePerfStats, TUri, TUrl, TVector2, TVector3, TVectorT< Element >, TVectorT< Double_t >, TVectorT< Float_t >, TVirtualPad, TXMLFile, TXTRU, TZIPFile, and TZIPMember.

Definition at line 661 of file TObject.cxx.

◆ Read()

Int_t TObject::Read ( const char * name)
virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

◆ RecursiveRemove()

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ SaveAs()

void TObject::SaveAs ( const char * filename = "",
Option_t * option = "" ) const
virtualinherited

Save this object in the file specified by filename.

  • if "filename" contains ".root" the object is saved in filename as root binary file.
  • if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
  • if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
  • otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

    The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

◆ SavePrimitive()

void TObject::SavePrimitive ( std::ostream & out,
Option_t * option = "" )
virtualinherited

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out,
TClass * cl,
const char * variable_name,
const char * constructor_agrs = "",
Bool_t empty_line = kTRUE )
staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out,
const char * variable_name,
Option_t * option = nullptr )
staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out,
const char * prefix,
Int_t len,
Double_t * arr,
Int_t flag = 0 )
staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f)
inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit ( UInt_t f,
Bool_t set )
inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "")
virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj)
staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetFltPrecision()

void TGDMLWrite::SetFltPrecision ( UInt_t prec)
inlineprivate

Definition at line 233 of file TGDMLWrite.h.

◆ SetG4Compatibility()

void TGDMLWrite::SetG4Compatibility ( Bool_t G4Compatible)
inline

Definition at line 84 of file TGDMLWrite.h.

◆ SetIgnoreDummyMaterial()

void TGDMLWrite::SetIgnoreDummyMaterial ( bool value)

Ignore dummy material instance, which causes trouble reading GDML in Geant4.

Definition at line 258 of file TGDMLWrite.cxx.

◆ SetNamingSpeed()

void TGDMLWrite::SetNamingSpeed ( ENamingType naming)

Set convention of naming solids and volumes.

Definition at line 250 of file TGDMLWrite.cxx.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat)
staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ StartAssemblyN()

XMLNodePointer_t TGDMLWrite::StartAssemblyN ( const char * name)
private

Creates "assembly" node for GDML.

Definition at line 2142 of file TGDMLWrite.cxx.

◆ StartGDMLWriting()

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

Definition at line 61 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 2122 of file TGDMLWrite.cxx.

◆ Streamer()

void TGDMLWrite::Streamer ( TBuffer & R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TGDMLWrite::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 252 of file TGDMLWrite.h.

◆ SysError()

void TObject::SysError ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ TestBit()

Bool_t TObject::TestBit ( UInt_t f) const
inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f) const
inlineinherited

Definition at line 205 of file TObject.h.

◆ 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 2542 of file TGDMLWrite.cxx.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )
virtualinherited

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

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

◆ Warning()

void TObject::Warning ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 )
virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 989 of file TObject.cxx.

◆ Write() [2/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 ) const
virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

  • Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
  • The TBuffer object is filled via the class::Streamer function.
  • If the file is compressed (default) a second buffer is created to hold the compressed buffer.
  • Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
  • The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 964 of file TObject.cxx.

◆ WriteGDMLfile() [1/5]

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

Definition at line 265 of file TGDMLWrite.cxx.

◆ WriteGDMLfile() [2/5]

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

Definition at line 280 of file TGDMLWrite.cxx.

◆ WriteGDMLfile() [3/5]

void TGDMLWrite::WriteGDMLfile ( TGeoManager * geomanager,
TGeoNode * top_node,
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 308 of file TGDMLWrite.cxx.

◆ WriteGDMLfile() [4/5]

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

Definition at line 2560 of file TGDMLWrite.cxx.

◆ WriteGDMLfile() [5/5]

void TGDMLWrite::WriteGDMLfile ( TGeoManager * geomanager,
TGeoVolume * top_vol,
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 2587 of file TGDMLWrite.cxx.

Member Data Documentation

◆ fAccPatt

StructLst* TGDMLWrite::fAccPatt
private

Definition at line 111 of file TGDMLWrite.h.

◆ fActNameErr

UInt_t TGDMLWrite::fActNameErr
private

Definition at line 136 of file TGDMLWrite.h.

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fDefault_lunit

TString TGDMLWrite::fDefault_lunit
private

Definition at line 125 of file TGDMLWrite.h.

◆ fDefineNode

XMLNodePointer_t TGDMLWrite::fDefineNode
private

Definition at line 130 of file TGDMLWrite.h.

◆ fElementList

StructLst* TGDMLWrite::fElementList
private

Definition at line 110 of file TGDMLWrite.h.

◆ fFltPrecision

UInt_t TGDMLWrite::fFltPrecision
private

! floating point precision when writing

Definition at line 138 of file TGDMLWrite.h.

◆ fGdmlE

TXMLEngine* TGDMLWrite::fGdmlE
private

Definition at line 128 of file TGDMLWrite.h.

◆ fGdmlFile

XMLDocPointer_t TGDMLWrite::fGdmlFile
private

Definition at line 124 of file TGDMLWrite.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0
staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

◆ fgG4Compatibility

Bool_t TGDMLWrite::fgG4Compatibility
private

Definition at line 123 of file TGDMLWrite.h.

◆ fgGDMLWrite

TGDMLWrite * TGDMLWrite::fgGDMLWrite = nullptr
staticprivate

Definition at line 120 of file TGDMLWrite.h.

◆ fgkMaxNameErr

const UInt_t TGDMLWrite::fgkMaxNameErr = 5
staticprivate

Definition at line 142 of file TGDMLWrite.h.

◆ fgkProcBit

const UInt_t TGDMLWrite::fgkProcBit = (1ULL << (14))
staticprivate

Definition at line 140 of file TGDMLWrite.h.

◆ fgkProcBitVol

const UInt_t TGDMLWrite::fgkProcBitVol = (1ULL << (19))
staticprivate

Definition at line 141 of file TGDMLWrite.h.

◆ fgNamingSpeed

Int_t TGDMLWrite::fgNamingSpeed
private

Definition at line 121 of file TGDMLWrite.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fIgnoreDummyMaterial

Int_t TGDMLWrite::fIgnoreDummyMaterial
private

Definition at line 122 of file TGDMLWrite.h.

◆ fIsotopeList

StructLst* TGDMLWrite::fIsotopeList
private

Definition at line 109 of file TGDMLWrite.h.

◆ fMaterialsNode

XMLNodePointer_t TGDMLWrite::fMaterialsNode
private

Definition at line 131 of file TGDMLWrite.h.

◆ fNameList

NameLst* TGDMLWrite::fNameList
private

Definition at line 117 of file TGDMLWrite.h.

◆ fNodeList

NodeList TGDMLWrite::fNodeList
private

Definition at line 115 of file TGDMLWrite.h.

◆ fPhysVolCnt

Int_t TGDMLWrite::fPhysVolCnt
private

Definition at line 135 of file TGDMLWrite.h.

◆ fRejShape

StructLst* TGDMLWrite::fRejShape
private

Definition at line 112 of file TGDMLWrite.h.

◆ fSolCnt

UInt_t TGDMLWrite::fSolCnt
private

Definition at line 137 of file TGDMLWrite.h.

◆ fSolidsNode

XMLNodePointer_t TGDMLWrite::fSolidsNode
private

Definition at line 132 of file TGDMLWrite.h.

◆ fStructureNode

XMLNodePointer_t TGDMLWrite::fStructureNode
private

Definition at line 133 of file TGDMLWrite.h.

◆ fSurfaceList

SurfaceList TGDMLWrite::fSurfaceList
private

Definition at line 113 of file TGDMLWrite.h.

◆ fTopVolume

TGeoVolume* TGDMLWrite::fTopVolume = nullptr
private

Definition at line 127 of file TGDMLWrite.h.

◆ fTopVolumeName

TString TGDMLWrite::fTopVolumeName
private

Definition at line 126 of file TGDMLWrite.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fVolCnt

Int_t TGDMLWrite::fVolCnt
private

Definition at line 134 of file TGDMLWrite.h.

◆ fVolumeList

VolList TGDMLWrite::fVolumeList
private

Definition at line 114 of file TGDMLWrite.h.


The documentation for this class was generated from the following files: