LDMX Software
Public Member Functions | List of all members
simcore::geo::Parser Class Referenceabstract

Interface for a parser used to load a geometry into Geant4. More...

#include <Parser.h>

Public Member Functions

virtual G4VPhysicalVolume * GetWorldVolume ()=0
 Pure virtual method used to retrieve the G4VPhysicalVolume associated with the most top-level (world) volume.
 
virtual std::string getDetectorName ()=0
 Get the name of the parsed detector.
 
virtual void read ()=0
 Parse the detector geometry and read it into memory.
 

Detailed Description

Interface for a parser used to load a geometry into Geant4.

This will be used by a parser factory class to spawn an instance of the desired parser.

Definition at line 25 of file Parser.h.

Member Function Documentation

◆ getDetectorName()

virtual std::string simcore::geo::Parser::getDetectorName ( )
pure virtual

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.

Implemented in simcore::geo::GDMLParser.

Referenced by simcore::DetectorConstruction::getDetectorName().

◆ GetWorldVolume()

virtual G4VPhysicalVolume * simcore::geo::Parser::GetWorldVolume ( )
pure virtual

Pure virtual method used to retrieve the G4VPhysicalVolume associated with the most top-level (world) volume.

Returns
The world volume.

Implemented in simcore::geo::GDMLParser.

Referenced by simcore::DetectorConstruction::Construct().

◆ read()

virtual void simcore::geo::Parser::read ( )
pure virtual

Parse the detector geometry and read it into memory.

Implemented in simcore::geo::GDMLParser.


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