DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Protected Attributes | List of all members
dd4hep::detail::DD4hepUI Class Reference

ROOT interactive UI for dd4hep applications. More...

#include <DD4hepUI.h>

Public Member Functions

 DD4hepUI (Detector &instance)
 Default constructor. More...
 
virtual ~DD4hepUI ()
 Default destructor. More...
 
Detectorinstance () const
 Access to the Detector instance. More...
 
DetectordetectorDescription () const
 Access to the Detector instance. More...
 
PrintLevel setPrintLevel (PrintLevel level) const
 Set the printout level from the interactive prompt. More...
 
int setVisLevel (int level)
 Set the visualization level when invoking the display. More...
 
Handle< NamedObjectconditionsMgr () const
 Install the dd4hep conditions manager object. More...
 
long loadConditions (const std::string &fname) const
 Load conditions from file. More...
 
long saveROOT (const char *file_name) const
 Dump the entire detector description object to a root file. More...
 
long importROOT (const char *file_name) const
 Import the entire detector description object from a root file. More...
 
Handle< NamedObjectalignmentMgr () const
 Install the dd4hep alignment manager object. More...
 
long createInterpreter (int argc, char **argv)
 Create ROOT interpreter instance. More...
 
long runInterpreter () const
 Execute ROOT interpreter instance. More...
 
virtual long apply (const char *factory, int argc, char **argv) const
 Detector interface: Manipulate geometry using factory converter. More...
 
virtual void fromXML (const std::string &fname, DetectorBuildType type=BUILD_DEFAULT) const
 Detector interface: Read any geometry description or alignment file. More...
 
virtual void draw () const
 Detector interface: Draw the scene on a OpenGL pane. More...
 
virtual void redraw () const
 Detector interface: Re-draw the entire scene. More...
 
virtual void drawSubtree (const char *path) const
 Detector interface: Draw detector sub-tree the scene on a OpenGL pane. More...
 
virtual void redrawSubtree (const char *path) const
 Detector interface: Re-draw the entire sub-tree scene. More...
 
virtual long dumpVols (int argc=0, char **argv=0) const
 Dump the volume tree. More...
 
virtual long dumpDet (const char *path=0) const
 Dump the DetElement tree with placement volumes. More...
 
virtual long dumpDetMaterials (const char *path=0) const
 Dump the DetElement tree with volume materials. More...
 
virtual long dumpStructure (const char *path=0) const
 Dump the raw DetElement tree. More...
 

Protected Attributes

Detectorm_detDesc
 Reference to the Detector instance object. More...
 
Handle< NamedObjectm_condMgr
 
Handle< NamedObjectm_alignMgr
 
int visLevel = 4
 Default visualiztion level. More...
 

Detailed Description

ROOT interactive UI for dd4hep applications.

Author
M.Frank
Version
1.0

Definition at line 33 of file DD4hepUI.h.

Constructor & Destructor Documentation

◆ DD4hepUI()

detail::DD4hepUI::DD4hepUI ( Detector instance)

Default constructor.

Definition at line 30 of file DD4hepUI.cpp.

◆ ~DD4hepUI()

detail::DD4hepUI::~DD4hepUI ( )
virtual

Default destructor.

Definition at line 34 of file DD4hepUI.cpp.

Member Function Documentation

◆ alignmentMgr()

Handle< NamedObject > detail::DD4hepUI::alignmentMgr ( ) const

Install the dd4hep alignment manager object.

Definition at line 84 of file DD4hepUI.cpp.

◆ apply()

long detail::DD4hepUI::apply ( const char *  factory,
int  argc,
char **  argv 
) const
virtual

Detector interface: Manipulate geometry using factory converter.

Detector interface: Manipulate geometry using facroy converter.

Definition at line 98 of file DD4hepUI.cpp.

◆ conditionsMgr()

Handle< NamedObject > detail::DD4hepUI::conditionsMgr ( ) const

Install the dd4hep conditions manager object.

Definition at line 60 of file DD4hepUI.cpp.

◆ createInterpreter()

long detail::DD4hepUI::createInterpreter ( int  argc,
char **  argv 
)

Create ROOT interpreter instance.

Definition at line 179 of file DD4hepUI.cpp.

◆ detectorDescription()

Detector * detail::DD4hepUI::detectorDescription ( ) const

Access to the Detector instance.

Definition at line 43 of file DD4hepUI.cpp.

◆ draw()

void detail::DD4hepUI::draw ( ) const
virtual

Detector interface: Draw the scene on a OpenGL pane.

Definition at line 108 of file DD4hepUI.cpp.

◆ drawSubtree()

void detail::DD4hepUI::drawSubtree ( const char *  path) const
virtual

Detector interface: Draw detector sub-tree the scene on a OpenGL pane.

Definition at line 118 of file DD4hepUI.cpp.

◆ dumpDet()

long detail::DD4hepUI::dumpDet ( const char *  path = 0) const
virtual

Dump the DetElement tree with placement volumes.

Dump the DetElement tree with placements.

Definition at line 141 of file DD4hepUI.cpp.

◆ dumpDetMaterials()

long detail::DD4hepUI::dumpDetMaterials ( const char *  path = 0) const
virtual

Dump the DetElement tree with volume materials.

Dump the DetElement tree with placements.

Definition at line 147 of file DD4hepUI.cpp.

◆ dumpStructure()

long detail::DD4hepUI::dumpStructure ( const char *  path = 0) const
virtual

Dump the raw DetElement tree.

Dump the DetElement tree with placements.

Definition at line 153 of file DD4hepUI.cpp.

◆ dumpVols()

long detail::DD4hepUI::dumpVols ( int  argc = 0,
char **  argv = 0 
) const
virtual

Dump the volume tree.

Definition at line 132 of file DD4hepUI.cpp.

◆ fromXML()

void detail::DD4hepUI::fromXML ( const std::string &  fname,
DetectorBuildType  type = BUILD_DEFAULT 
) const
virtual

Detector interface: Read any geometry description or alignment file.

Definition at line 103 of file DD4hepUI.cpp.

◆ importROOT()

long detail::DD4hepUI::importROOT ( const char *  file_name) const

Import the entire detector description object from a root file.

Definition at line 169 of file DD4hepUI.cpp.

◆ instance()

Detector * detail::DD4hepUI::instance ( ) const

Access to the Detector instance.

Definition at line 38 of file DD4hepUI.cpp.

◆ loadConditions()

long detail::DD4hepUI::loadConditions ( const std::string &  fname) const

Load conditions from file.

Definition at line 74 of file DD4hepUI.cpp.

◆ redraw()

void detail::DD4hepUI::redraw ( ) const
virtual

Detector interface: Re-draw the entire scene.

Definition at line 113 of file DD4hepUI.cpp.

◆ redrawSubtree()

void detail::DD4hepUI::redrawSubtree ( const char *  path) const
virtual

Detector interface: Re-draw the entire sub-tree scene.

Definition at line 125 of file DD4hepUI.cpp.

◆ runInterpreter()

long detail::DD4hepUI::runInterpreter ( ) const

Execute ROOT interpreter instance.

Definition at line 192 of file DD4hepUI.cpp.

◆ saveROOT()

long detail::DD4hepUI::saveROOT ( const char *  file_name) const

Dump the entire detector description object to a root file.

Definition at line 159 of file DD4hepUI.cpp.

◆ setPrintLevel()

PrintLevel detail::DD4hepUI::setPrintLevel ( PrintLevel  level) const

Set the printout level from the interactive prompt.

Definition at line 48 of file DD4hepUI.cpp.

◆ setVisLevel()

int detail::DD4hepUI::setVisLevel ( int  level)

Set the visualization level when invoking the display.

Definition at line 53 of file DD4hepUI.cpp.

Member Data Documentation

◆ m_alignMgr

Handle<NamedObject> dd4hep::detail::DD4hepUI::m_alignMgr
protected

Definition at line 38 of file DD4hepUI.h.

◆ m_condMgr

Handle<NamedObject> dd4hep::detail::DD4hepUI::m_condMgr
protected

Definition at line 37 of file DD4hepUI.h.

◆ m_detDesc

Detector& dd4hep::detail::DD4hepUI::m_detDesc
protected

Reference to the Detector instance object.

Definition at line 36 of file DD4hepUI.h.

◆ visLevel

int dd4hep::detail::DD4hepUI::visLevel = 4
protected

Default visualiztion level.

Definition at line 40 of file DD4hepUI.h.


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