Geometry volume record loaded into a GSystem. More...

#include <gvolume.h>

Public Member Functions
	GVolume (const std::shared_ptr< GLogger > &log, const std::string &system, std::vector< std::string > pars, std::optional< std::string > importPath=std::nullopt)
	Construct a volume from a serialized parameter vector.
	GVolume (const std::string &rootVolumeDefinition, const std::shared_ptr< GLogger > &log)
	Construct the special ROOT/world volume.
virtual std::unique_ptr< GVolume >	clone () const
	Polymorphic deep-copy.
virtual	~GVolume ()=default
	Virtual destructor (safe deletion through base pointers).
std::vector< double >	getDetectorDimensions () const
	Returns the native-solid dimensions parsed from the `parameters` string.
const std::optional< std::string > &	getImportedFile () const
	Return the import filename (path) for imported volumes.
void	assignG4Names (const std::string &g4n, const std::string &g4m)
	Assign Geant4 names after all volumes are loaded.
Identity and naming
std::string	getSystem () const
std::string	getName () const
std::string	getMotherName () const
const std::string &	getG4Name () const
const std::string &	getG4MotherName () const
Solid definition
std::string	getType () const
const std::optional< std::string > &	getParameters () const
Logical attributes
std::string	getMaterial () const
const std::optional< std::string > &	getEMField () const
Visualization attributes
int	getPCopyNo () const
std::string_view	getColor () const
double	getOpacity () const
bool	isVisible () const
int	getStyle () const
Placement attributes and post-load modifiers
bool	getExistence () const
std::string	getPos () const
std::string	getRot () const
std::string	getG4PlacementType () const
const std::optional< std::string > &	getShift () const
const std::optional< std::string > &	getTilt () const
Digitization and identity metadata
const std::optional< std::string > &	getDigitization () const
const std::optional< std::string > &	getGIdentity () const
Special cases / advanced features
const std::optional< std::string > &	getCopyOf () const
const std::optional< std::string > &	getSolidsOpr () const
const std::optional< std::string > &	getMirror () const
std::string	getDescription () const
Modifier application (performed by GWorld)
void	applyShift (std::optional< std::string > s)
	Apply an additional translation to this volume.
void	applyTilt (std::optional< std::string > t)
	Apply an additional rotation to this volume.
void	modifyExistence (bool e)
	Enable or disable this volume in the final assembled world.
void	resetMotherName (std::string m)
	Override the mother name (placement parent) after loading.
void	setColor (std::string c)
	Override the color after loading.
void	setMaterial (std::string m)
	Override the material name after loading.
void	setDigitization (std::optional< std::string > d)
	Override the digitization label after loading.
void	setGIdentity (std::optional< std::string > g)
	Override the identity string after loading.
Public Member Functions inherited from GBase< GVolume >
	GBase (const std::shared_ptr< GOptions > &gopt, std::string logger_name="")
virtual	~GBase ()
GBase &	operator= (const GBase &)=default

Friends
std::ostream &	operator<< (std::ostream &stream, const GVolume &gVol)
	Stream operator used for logging volume summaries.

Additional Inherited Members
Protected Attributes inherited from GBase< GVolume >
std::shared_ptr< GLogger >	log

Detailed Description

A GVolume represents a single placed detector volume as loaded from a geometry source (sqlite DB, ASCII text files, CAD import, GDML import, etc.).

The constructor takes a serialized parameter vector whose positional layout matches the geometry database row layout (gsystem::GVOLUMENUMBEROFPARS). The class stores:

solid definition (type + parameters);
visualization attributes (visibility/style/color/opacity);
placement attributes (mother/pos/rot);
Geant4 placement constructor convention;
logical attributes (material, EM field);
digitization/identity metadata;
optional import filename for CAD/GDML sourced volumes;
post-load modifiers (shift/tilt/existence) applied by GWorld;
final Geant4 naming assigned during GWorld bookkeeping.

Definition at line 35 of file gvolume.h.

Constructor & Destructor Documentation

◆ GVolume() [1/2]

GVolume::GVolume	(	const std::shared_ptr< GLogger > &	log,
		const std::string &	system,
		std::vector< std::string >	pars,
		std::optional< std::string >	importPath = std::nullopt )

Parameters

log	Logger used for diagnostics and error reporting.
system	Name of the system that owns this volume.
pars	Serialized parameter list (must match gsystem::GVOLUMENUMBEROFPARS).
importPath	Optional import path used by file-based factories (CAD/GDML).

The parameter vector is positional; the implementation parses it in order. If the vector size is incorrect, the constructor logs an error.

The positional semantics are stable across DB and ASCII sources, and include:

identity (name, mother, description);
solid (type, parameters);
placement (pos, rot);
Geant4 placement constructor convention;
rendering (visibility, style, color, opacity);
behavior (material, emfield, digitization, identifiers);
advanced features (copyOf, solidsOpr, mirror);
existence flag;
provenance (variation, run).

Definition at line 55 of file gvolume.cc.

◆ GVolume() [2/2]

GVolume::GVolume	(	const std::string &	rootVolumeDefinition,
		const std::shared_ptr< GLogger > &	log )

explicit

Parameters

rootVolumeDefinition	Definition string like: `"G4Box 15m 15m 15*m G4_AIR"`.
log	Logger used for diagnostics.

This constructor is used when the world volume is injected automatically. It creates a top-level volume whose mother is gsystem::MOTHEROFUSALL and whose position/rotation default to gsystem::DEFAULTPOSITION / gsystem::DEFAULTROTATION.

Definition at line 154 of file gvolume.cc.

◆ ~GVolume()

virtual GVolume::~GVolume ( )

virtualdefault

Member Function Documentation

◆ applyShift()

void GVolume::applyShift ( std::optional< std::string > s )

inline

Parameters

s	Shift expression string (units embedded), usually parsed later by placement logic.

This stores the modifier; it does not update pos directly. Downstream placement code is expected to interpret pos + shift.

Definition at line 235 of file gvolume.h.

◆ applyTilt()

void GVolume::applyTilt ( std::optional< std::string > t )

inline

Parameters

t	Tilt expression string (units embedded), usually parsed later by placement logic.

This stores the modifier; it does not update rot directly. Downstream placement code is expected to interpret rot + tilt.

Definition at line 245 of file gvolume.h.

◆ assignG4Names()

void GVolume::assignG4Names	(	const std::string &	g4n,
		const std::string &	g4m )

inline

Parameters

g4n	Fully-qualified volume name (`"<system>/<name>"`).
g4m	Fully-qualified mother name (`"<motherSystem>/<motherName>"`).

This is called by GWorld during the final bookkeeping step. The values are stored and used later when constructing the runtime geometry.

Definition at line 291 of file gvolume.h.

◆ clone()

virtual std::unique_ptr< GVolume > GVolume::clone ( ) const

inlinenodiscardvirtual

Returns: A heap-allocated clone of the current object.

The clone is a deep copy of this value object; it is safe to mutate independently of the original (subject to external invariants such as unique naming in maps).

Definition at line 85 of file gvolume.h.

◆ getColor()

std::string_view GVolume::getColor ( ) const

inlinenodiscard

Definition at line 195 of file gvolume.h.

◆ getCopyOf()

const std::optional< std::string > & GVolume::getCopyOf ( ) const

inlinenodiscard

Definition at line 219 of file gvolume.h.

◆ getDescription()

std::string GVolume::getDescription ( ) const

inlinenodiscard

Definition at line 222 of file gvolume.h.

◆ getDetectorDimensions()

std::vector< double > GVolume::getDetectorDimensions ( ) const

inlinenodiscard

Returns: Vector of numeric values in Geant4 internal units (e.g. mm, deg), one entry per dimension token in parameters. Empty when the volume has no native-solid dimensions to report (see the two cases below).

For a native Geant4 solid (G4Box, G4Tubs, ...) the parameters string holds the constructor dimensions, e.g. "1*cm, 2*cm, 3*cm". Parsing is delegated to gutilities::getG4NumbersFromString, which interprets the unit suffix on each token.

An empty vector is returned in two cases:

parameters is unset (std::nullopt);
the volume is CAD-imported (type equals gsystem::GSYSTEMCADTFACTORYLABEL). A mesh volume has no native solid: its parameters field instead carries the resolved mesh path, optionally followed by a numeric suffix (e.g. "stls/heart_NIH3D.stl, 130"). Parsing that string would inject a spurious dimension into the touchable/hit metadata that gdetectorConstruction forwards to digitization for sensitive volumes, so CAD volumes deliberately report no dimensions here.

Definition at line 175 of file gvolume.h.

◆ getDigitization()

const std::optional< std::string > & GVolume::getDigitization ( ) const

inlinenodiscard

Definition at line 213 of file gvolume.h.

◆ getEMField()

const std::optional< std::string > & GVolume::getEMField ( ) const

inlinenodiscard

Definition at line 189 of file gvolume.h.

◆ getExistence()

bool GVolume::getExistence ( ) const

inlinenodiscard

Definition at line 203 of file gvolume.h.

◆ getG4MotherName()

const std::string & GVolume::getG4MotherName ( ) const

nodiscard

Definition at line 45 of file gvolume.cc.

◆ getG4Name()

const std::string & GVolume::getG4Name ( ) const

nodiscard

Definition at line 38 of file gvolume.cc.

◆ getG4PlacementType()

std::string GVolume::getG4PlacementType ( ) const

inlinenodiscard

Definition at line 206 of file gvolume.h.

◆ getGIdentity()

const std::optional< std::string > & GVolume::getGIdentity ( ) const

inlinenodiscard

Definition at line 214 of file gvolume.h.

◆ getImportedFile()

const std::optional< std::string > & GVolume::getImportedFile ( ) const

inlinenodiscard

Returns: The original import filename stored by the factory, or std::nullopt.

This is meaningful only for CAD/GDML imports.

Definition at line 280 of file gvolume.h.

◆ getMaterial()

std::string GVolume::getMaterial ( ) const

inlinenodiscard

Definition at line 188 of file gvolume.h.

◆ getMirror()

const std::optional< std::string > & GVolume::getMirror ( ) const

inlinenodiscard

Definition at line 221 of file gvolume.h.

◆ getMotherName()

std::string GVolume::getMotherName ( ) const

inlinenodiscard

Definition at line 150 of file gvolume.h.

◆ getName()

std::string GVolume::getName ( ) const

inlinenodiscard

Definition at line 149 of file gvolume.h.

◆ getOpacity()

double GVolume::getOpacity ( ) const

inlinenodiscard

Definition at line 196 of file gvolume.h.

◆ getParameters()

const std::optional< std::string > & GVolume::getParameters ( ) const

inlinenodiscard

Definition at line 183 of file gvolume.h.

◆ getPCopyNo()

int GVolume::getPCopyNo ( ) const

inlinenodiscard

Definition at line 194 of file gvolume.h.

◆ getPos()

std::string GVolume::getPos ( ) const

inlinenodiscard

Definition at line 204 of file gvolume.h.

◆ getRot()

std::string GVolume::getRot ( ) const

inlinenodiscard

Definition at line 205 of file gvolume.h.

◆ getShift()

const std::optional< std::string > & GVolume::getShift ( ) const

inlinenodiscard

Definition at line 207 of file gvolume.h.

◆ getSolidsOpr()

const std::optional< std::string > & GVolume::getSolidsOpr ( ) const

inlinenodiscard

Definition at line 220 of file gvolume.h.

◆ getStyle()

int GVolume::getStyle ( ) const

inlinenodiscard

Definition at line 198 of file gvolume.h.

◆ getSystem()

std::string GVolume::getSystem ( ) const

inlinenodiscard

Definition at line 148 of file gvolume.h.

◆ getTilt()

const std::optional< std::string > & GVolume::getTilt ( ) const

inlinenodiscard

Definition at line 208 of file gvolume.h.

◆ getType()

std::string GVolume::getType ( ) const

inlinenodiscard

Definition at line 182 of file gvolume.h.

◆ isVisible()

bool GVolume::isVisible ( ) const

inlinenodiscard

Definition at line 197 of file gvolume.h.

◆ modifyExistence()

void GVolume::modifyExistence ( bool e )

inline

Parameters

e	Existence flag.

When set to false, the volume should be treated as removed from the world. The mechanics of "removal" are handled by downstream geometry construction.

Definition at line 255 of file gvolume.h.

◆ resetMotherName()

void GVolume::resetMotherName ( std::string m )

inline

Definition at line 258 of file gvolume.h.

◆ setColor()

void GVolume::setColor ( std::string c )

inline

Definition at line 261 of file gvolume.h.

◆ setDigitization()

void GVolume::setDigitization ( std::optional< std::string > d )

Definition at line 184 of file gvolume.cc.

◆ setGIdentity()

void GVolume::setGIdentity ( std::optional< std::string > g )

Definition at line 188 of file gvolume.cc.

◆ setMaterial()

void GVolume::setMaterial ( std::string m )

inline

Definition at line 264 of file gvolume.h.

◆ operator<<

std::ostream & operator<<	(	std::ostream &	stream,
		const GVolume &	gVol )

friend

Definition at line 120 of file gvolume.cc.

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GVolume() [1/2]

◆ GVolume() [2/2]

◆ ~GVolume()

Member Function Documentation

◆ applyShift()

◆ applyTilt()

◆ assignG4Names()

◆ clone()

◆ getColor()

◆ getCopyOf()

◆ getDescription()

◆ getDetectorDimensions()

◆ getDigitization()

◆ getEMField()

◆ getExistence()

◆ getG4MotherName()

◆ getG4Name()

◆ getG4PlacementType()

◆ getGIdentity()

◆ getImportedFile()

◆ getMaterial()

◆ getMirror()

◆ getMotherName()

◆ getName()

◆ getOpacity()

◆ getParameters()

◆ getPCopyNo()

◆ getPos()

◆ getRot()

◆ getShift()

◆ getSolidsOpr()

◆ getStyle()

◆ getSystem()

◆ getTilt()

◆ getType()

◆ isVisible()

◆ modifyExistence()

◆ resetMotherName()

◆ setColor()

◆ setDigitization()

◆ setGIdentity()

◆ setMaterial()

Friends And Related Symbol Documentation

◆ operator<<