A class holding any information pertaining to a particular physical volume in a BDSIM geant4 model.
More...

#include <BDSPhysicalVolumeInfo.hh>

Collaboration diagram for BDSPhysicalVolumeInfo:

Public Member Functions
	BDSPhysicalVolumeInfo (G4double SPosAtMiddleOfElement)

	BDSPhysicalVolumeInfo (G4String nameIn, G4String placementNameIn, G4double sPosIn, G4int beamlineIndexIn=-1, BDSBeamline *beamlineIn=nullptr)

G4String	GetName () const
	Get the name of the logical volume.

void	SetName (G4String NameIn)
	Set the name of the logical volume.

G4String	GetPlacementName () const
	Get the name of the logical volume.

void	SetPlacementName (G4String placementNameIn)
	Set the name of the logical volume.

G4double	GetSPos () const
	Get the s position coordinate of the logical volume.

void	SetSPos (G4double SPosIn)
	Set the s position coordinate of the logical volume.


G4int	GetBeamlineIndex () const
	Accessor.

BDSBeamline *	GetBeamline () const
	Accessor.

BDSBeamline *	GetBeamlineMassWorld () const
	Accessor.

G4int	GetBeamlineMassWorldIndex () const
	Accessor.

Private Attributes
G4String	name

G4String	placementName

G4double	spos

G4int	beamlineIndex

BDSBeamline *	beamline

BDSBeamline *	beamlineMassWorld
	Corresponding mass world beam line - this may in fact be the same as the beam line.

G4int	beamlineMassWorldIndex
	Corresponding mass world beam line index - also may be the same as beamlineIndex.

Friends
std::ostream &	operator<< (std::ostream &out, BDSPhysicalVolumeInfo const &info)
	output stream

Detailed Description

A class holding any information pertaining to a particular physical volume in a BDSIM geant4 model.

Currently, this is used for the name and s position coordinate, but can be extended to store any other pertinent information.

Author: Laurie Nevay

Definition at line 38 of file BDSPhysicalVolumeInfo.hh.

Constructor & Destructor Documentation

◆ BDSPhysicalVolumeInfo() [1/2]

BDSPhysicalVolumeInfo::BDSPhysicalVolumeInfo ( G4double SPosAtMiddleOfElement )

explicit

Definition at line 26 of file BDSPhysicalVolumeInfo.cc.

◆ BDSPhysicalVolumeInfo() [2/2]

BDSPhysicalVolumeInfo::BDSPhysicalVolumeInfo	(	G4String	nameIn,
		G4String	placementNameIn,
		G4double	sPosIn,
		G4int	beamlineIndexIn = `-1`,
		BDSBeamline *	beamlineIn = `nullptr`
	)

Definition at line 36 of file BDSPhysicalVolumeInfo.cc.

◆ ~BDSPhysicalVolumeInfo()

BDSPhysicalVolumeInfo::~BDSPhysicalVolumeInfo ( )

Definition at line 53 of file BDSPhysicalVolumeInfo.cc.

Member Function Documentation

◆ GetBeamline()

BDSBeamline * BDSPhysicalVolumeInfo::GetBeamline ( ) const

inline

Accessor.

Definition at line 73 of file BDSPhysicalVolumeInfo.hh.

Referenced by BDSSDCollimator::ProcessHitsOrdered().

Here is the caller graph for this function:

◆ GetBeamlineIndex()

G4int BDSPhysicalVolumeInfo::GetBeamlineIndex ( ) const

inline

Accessor.

Definition at line 72 of file BDSPhysicalVolumeInfo.hh.

Referenced by BDSOutputROOTEventTrajectory::FillIndividualTrajectory(), and BDSSDCollimator::ProcessHitsOrdered().

Here is the caller graph for this function:

◆ GetBeamlineMassWorld()

BDSBeamline * BDSPhysicalVolumeInfo::GetBeamlineMassWorld ( ) const

inline

Accessor.

Definition at line 74 of file BDSPhysicalVolumeInfo.hh.

References beamlineMassWorld.

Referenced by BDSTrajectoryPoint::BDSTrajectoryPoint(), and BDSTrajectoryPoint::BDSTrajectoryPoint().

Here is the caller graph for this function:

◆ GetBeamlineMassWorldIndex()

G4int BDSPhysicalVolumeInfo::GetBeamlineMassWorldIndex ( ) const

inline

Accessor.

Definition at line 75 of file BDSPhysicalVolumeInfo.hh.

References beamlineMassWorldIndex.

Referenced by BDSTrajectoryPoint::BDSTrajectoryPoint(), and BDSTrajectoryPoint::BDSTrajectoryPoint().

Here is the caller graph for this function:

◆ GetName()

G4String BDSPhysicalVolumeInfo::GetName ( ) const

inline

Get the name of the logical volume.

Definition at line 53 of file BDSPhysicalVolumeInfo.hh.

Referenced by BDSPhysicalVolumeInfoRegistry::RegisterInfo().

Here is the caller graph for this function:

◆ GetPlacementName()

G4String BDSPhysicalVolumeInfo::GetPlacementName ( ) const

inline

Get the name of the logical volume.

Definition at line 59 of file BDSPhysicalVolumeInfo.hh.

◆ GetSPos()

G4double BDSPhysicalVolumeInfo::GetSPos ( ) const

inline

Get the s position coordinate of the logical volume.

Definition at line 66 of file BDSPhysicalVolumeInfo.hh.

Referenced by BDSTrajectoryPoint::BDSTrajectoryPoint(), BDSTrajectoryPoint::BDSTrajectoryPoint(), BDSSDApertureImpacts::ProcessHits(), BDSSDEnergyDeposition::ProcessHits(), and BDSSDEnergyDeposition::ProcessHitsTrack().

Here is the caller graph for this function:

◆ SetName()

void BDSPhysicalVolumeInfo::SetName ( G4String NameIn )

inline

Set the name of the logical volume.

Definition at line 56 of file BDSPhysicalVolumeInfo.hh.

◆ SetPlacementName()

void BDSPhysicalVolumeInfo::SetPlacementName ( G4String placementNameIn )

inline

Set the name of the logical volume.

Definition at line 62 of file BDSPhysicalVolumeInfo.hh.

◆ SetSPos()

void BDSPhysicalVolumeInfo::SetSPos ( G4double SPosIn )

inline

Set the s position coordinate of the logical volume.

Definition at line 69 of file BDSPhysicalVolumeInfo.hh.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	out,
		BDSPhysicalVolumeInfo const &	info
	)

friend

output stream

Definition at line 56 of file BDSPhysicalVolumeInfo.cc.

Field Documentation

◆ beamline

BDSBeamline* BDSPhysicalVolumeInfo::beamline

private

Definition at line 85 of file BDSPhysicalVolumeInfo.hh.

◆ beamlineIndex

G4int BDSPhysicalVolumeInfo::beamlineIndex

private

Definition at line 84 of file BDSPhysicalVolumeInfo.hh.

◆ beamlineMassWorld

BDSBeamline* BDSPhysicalVolumeInfo::beamlineMassWorld

private

Corresponding mass world beam line - this may in fact be the same as the beam line.

Definition at line 88 of file BDSPhysicalVolumeInfo.hh.

Referenced by GetBeamlineMassWorld().

◆ beamlineMassWorldIndex

G4int BDSPhysicalVolumeInfo::beamlineMassWorldIndex

private

Corresponding mass world beam line index - also may be the same as beamlineIndex.

Definition at line 90 of file BDSPhysicalVolumeInfo.hh.

Referenced by GetBeamlineMassWorldIndex().

◆ name

G4String BDSPhysicalVolumeInfo::name

private

Definition at line 81 of file BDSPhysicalVolumeInfo.hh.

◆ placementName

G4String BDSPhysicalVolumeInfo::placementName

private

Definition at line 82 of file BDSPhysicalVolumeInfo.hh.

◆ spos

G4double BDSPhysicalVolumeInfo::spos

private

Definition at line 83 of file BDSPhysicalVolumeInfo.hh.

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

/__w/bdsim/bdsim/include/BDSPhysicalVolumeInfo.hh
/__w/bdsim/bdsim/src/BDSPhysicalVolumeInfo.cc

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BDSPhysicalVolumeInfo() [1/2]

◆ BDSPhysicalVolumeInfo() [2/2]

◆ ~BDSPhysicalVolumeInfo()

Member Function Documentation

◆ GetBeamline()

◆ GetBeamlineIndex()

◆ GetBeamlineMassWorld()

◆ GetBeamlineMassWorldIndex()

◆ GetName()

◆ GetPlacementName()

◆ GetSPos()

◆ SetName()

◆ SetPlacementName()

◆ SetSPos()

Friends And Related Symbol Documentation

◆ operator<<

Field Documentation

◆ beamline

◆ beamlineIndex

◆ beamlineMassWorld

◆ beamlineMassWorldIndex

◆ name

◆ placementName

◆ spos