simcore::geo::GDMLParser Class Reference

Parse GDML files, build the geometry in memory and load it into Geant4. More...

#include <GDMLParser.h>

Public Member Functions
	GDMLParser (framework::config::Parameters &parameters, simcore::ConditionsInterface &ci)
	Default constructor.
virtual	~GDMLParser ()=default
	Default destructor.
G4VPhysicalVolume *	GetWorldVolume () override
	Retrieve the G4VPhysicalVolume associated with the most top-level (world) volume.
std::string	getDetectorName () override
	Get the name of the parsed detector.
void	read () override
	Parse the detector geometry and read it into memory.

Static Public Member Functions
static Parser *	create (framework::config::Parameters &parameters, simcore::ConditionsInterface &ci)
	Create an instance of this parser.

Private Attributes
std::unique_ptr< G4GDMLParser >	parser_
	The GDML parser.
std::unique_ptr< simcore::geo::AuxInfoReader >	info_
	The auxiliary info reader.
std::string	detector_
	path to the detector GDML
bool	validate_
	should we take the time to validate
std::string	detector_name_ {""}
	The name of the parsed detector.

Detailed Description

Parse GDML files, build the geometry in memory and load it into Geant4.

This class extends the interface Parser which allows creation of the parser at runtime via a factory.

Definition at line 26 of file GDMLParser.h.

Constructor & Destructor Documentation

GDMLParser()

simcore::geo::GDMLParser::GDMLParser	(	framework::config::Parameters &	parameters,
		simcore::ConditionsInterface &	ci
	)

Default constructor.

Parameters

parameters	The parameters used to configure this parser.
ci	Interface that allows access to the conditions.

Definition at line 6 of file GDMLParser.cxx.

                                                       {
  detector_ = parameters.getParameter<std::string>("detector");
  validate_ = parameters.getParameter<bool>("validate_detector");
  parser_ = std::make_unique<G4GDMLParser>();
  parser_->SetOverlapCheck(validate_);
  info_ =
      std::make_unique<simcore::geo::AuxInfoReader>(parser_.get(), parameters);
}

References detector_, framework::config::Parameters::getParameter(), info_, parser_, and validate_.

Member Function Documentation

create()

static Parser * simcore::geo::GDMLParser::create ( framework::config::Parameters &  parameters, simcore::ConditionsInterface &  ci  )

inlinestatic

Create an instance of this parser.

Definition at line 66 of file GDMLParser.h.

                                                        {
    return new GDMLParser(parameters, ci);
  }

Referenced by simcore::geo::ParserFactory::ParserFactory().

getDetectorName()

std::string simcore::geo::GDMLParser::getDetectorName ( )

inlineoverridevirtual

Get the name of the parsed detector.

This name is typically extracted from the file containing the detector description.

Returns

The name of the detector.

Implements simcore::geo::Parser.

Definition at line 56 of file GDMLParser.h.

{ return detector_name_; }

References detector_name_.

GetWorldVolume()

G4VPhysicalVolume * simcore::geo::GDMLParser::GetWorldVolume ( )

overridevirtual

Retrieve the G4VPhysicalVolume associated with the most top-level (world) volume.

Returns

The world volume.

Implements simcore::geo::Parser.

Definition at line 16 of file GDMLParser.cxx.

                                              {
  return parser_->GetWorldVolume();
}

References parser_.

read()

void simcore::geo::GDMLParser::read ( )

overridevirtual

Parse the detector geometry and read it into memory.

Implements simcore::geo::Parser.

Definition at line 20 of file GDMLParser.cxx.

                      {
  parser_->Read(detector_, validate_);
  info_->readGlobalAuxInfo();
  info_->assignAuxInfoToVolumes();
  detector_name_ = info_->getDetectorHeader()->getName();
}

References detector_, detector_name_, info_, parser_, and validate_.

Member Data Documentation

detector_

std::string simcore::geo::GDMLParser::detector_

private

path to the detector GDML

Definition at line 79 of file GDMLParser.h.

Referenced by GDMLParser(), and read().

detector_name_

std::string simcore::geo::GDMLParser::detector_name_ {""}

private

The name of the parsed detector.

Definition at line 85 of file GDMLParser.h.

{""};

Referenced by getDetectorName(), and read().

info_

std::unique_ptr<simcore::geo::AuxInfoReader> simcore::geo::GDMLParser::info_

private

The auxiliary info reader.

Definition at line 76 of file GDMLParser.h.

Referenced by GDMLParser(), and read().

parser_

std::unique_ptr<G4GDMLParser> simcore::geo::GDMLParser::parser_

private

The GDML parser.

Definition at line 73 of file GDMLParser.h.

Referenced by GDMLParser(), GetWorldVolume(), and read().

validate_

bool simcore::geo::GDMLParser::validate_

private

should we take the time to validate

Definition at line 82 of file GDMLParser.h.

Referenced by GDMLParser(), and read().

---

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

• SimCore/include/SimCore/Geo/GDMLParser.h
• SimCore/src/SimCore/Geo/GDMLParser.cxx