BDS Namespace Reference

Various utility functions that have no specific place - for example string manipulations, and checking. More...

Data Structures
struct	non_alpha
	Logical not for isalpha predictator as needed for string manipulations. More...
Functions
BDSBeamPipeType	DetermineBeamPipeType (G4String apertureType)
	function that gives corresponding enum value for string (case-insensitive)
void	CheckApertureInfo (BDSBeamPipeType beamPipeTypeIn, G4double &beamPipeRadius, G4double &aper1, G4double &aper2, G4double &aper3, G4double &aper4)
void	InfoOKForCircular (G4double &beamPipeRadius, G4double &aper1, G4double &aper2, G4double &aper3, G4double &aper4)
	aperture info check for circular aperture
void	InfoOKForElliptical (G4double &beamPipeRadius, G4double &aper1, G4double &aper2, G4double &aper3, G4double &aper4)
	aperture info check for elliptical aperture
void	InfoOKForRectangular (G4double &beamPipeRadius, G4double &aper1, G4double &aper2, G4double &aper3, G4double &aper4)
	aperture info check for rectangular aperture
void	InfoOKForLHC (G4double &beamPipeRadius, G4double &aper1, G4double &aper2, G4double &aper3, G4double &aper4)
	aperture info check for lhc aperture
void	InfoOKForLHCDetailed (G4double &beamPipeRadius, G4double &aper1, G4double &aper2, G4double &aper3, G4double &aper4)
	aperture info check for lhc detailed aperture
void	InfoOKForRectEllipse (G4double &beamPipeRadius, G4double &aper1, G4double &aper2, G4double &aper3, G4double &aper4)
	aperture info check for rectellipse aperture
BDSEnergyCounterHit *	LowestSPosPrimaryHit (BDSEnergyCounterHitsCollection *hc)
BDSEnergyCounterHit *	HighestSPosPrimaryHit (BDSEnergyCounterHitsCollection *hc)
BDSMagnetGeometryType	DetermineMagnetGeometryType (G4String geometryType)
	function to determine the enum type of the magnet geometry (case-insensitive)
G4LogicalVolume *	BuildReadOutVolume (G4String name, G4double chordLength, G4double angle)
void	CalculateAndSetTeleporterDelta (BDSBeamline *thebeamline)
G4String	PrepareSafeName (G4String name)
	Remove white space and special characters in the name.
G4int	CalculateOrientation (G4double angle)
std::string	GetBDSIMExecPath ()
G4String	GetFullPath (G4String fileName, bool excludePathFromFileName)
void	HandleAborts (int signal_number)
G4bool	IsFinite (const G4double &variable)
	Determine whether a parameter is finite.

---

Detailed Description

Various utility functions that have no specific place - for example string manipulations, and checking.

Functions are part of the BDS namespace

Author:

Laurie Nevay <Laurie.Nevay@rhul.ac.uk>

---

Function Documentation

void BDS::CheckApertureInfo	(	BDSBeamPipeType	beamPipeTypeIn,
		G4double &	beamPipeRadius,
		G4double &	aper1,
		G4double &	aper2,
		G4double &	aper3,
		G4double &	aper4
	)

function to check relevant aperture values are set. This is really a dispatch function for other aperture specific methods below

Definition at line 34 of file BDSBeamPipeType.cc.

References InfoOKForCircular(), InfoOKForElliptical(), InfoOKForLHC(), InfoOKForLHCDetailed(), InfoOKForRectangular(), and InfoOKForRectEllipse().

Referenced by BDSGlobalConstants::BDSGlobalConstants().

Here is the call graph for this function:

Here is the caller graph for this function:

G4int BDS::CalculateOrientation

(

G4double

angle

)

Calculate the +- 1 orientation multiplier for absolute angles seems trivial, but used in a lot of places so put in one place

Definition at line 32 of file BDSUtilities.cc.

Referenced by BDSSectorBend::BDSSectorBend(), BuildReadOutVolume(), BDSBeamPipeFactoryBase::CalculateFaces(), BDSRBend::CommonConstructor(), BDSMagnetOuterFactoryLHC::CreateSectorBend(), and BDSMagnetOuterFactoryCylindrical::CreateSectorBend().

Here is the caller graph for this function:

std::string BDS::GetBDSIMExecPath

(

)

Returns path from which BDSIM is executed supports linux/unix and mac OS

Definition at line 42 of file BDSUtilities.cc.

G4String BDS::GetFullPath	(	G4String	filename,
		bool	excludePathFromFileName = false
	)

get full absolute directory path where file can be found. returns absolute path

option to exclude the filename path, such that getFullPath(filename,true) + filename will return the absolute filename path

Definition at line 66 of file BDSUtilities.cc.

Referenced by BDSExecOptions::BDSExecOptions().

Here is the caller graph for this function:

void BDS::HandleAborts

(

int

signal_number

)

Try to catch abort signals. This is not guaranteed to work. Main goal is to close output stream / files.

Definition at line 96 of file BDSUtilities.cc.

References BDSRunManager::GetRunManager().

Here is the call graph for this function:

---