BDSTunnelInfo Class Reference

Holder struct of all information required to create a section of tunnel. More...

#include <BDSTunnelInfo.hh>

Collaboration diagram for BDSTunnelInfo:

Public Member Functions
	BDSTunnelInfo ()=delete
	Default constructor, not needed.
	BDSTunnelInfo (BDSTunnelType typeIn, G4double thicknessIn, G4double soilThicknessIn, G4Material *materialIn, G4Material *soilMaterialIn, G4bool buildFloorIn, G4double floorOffsetIn, G4double aper1In, G4double aper2In, G4bool sensitiveIn, G4bool visible=true)
	Extra constructor to assign all members at once. More...
	BDSTunnelInfo (G4String typeIn, G4double thicknessIn, G4double soilThicknessIn, G4String materialIn, G4String soilMaterialIn, G4bool buildFloorIn, G4double floorOffsetIn, G4double aper1In, G4double aper2In, G4bool sensitiveIn, G4bool visible=true)
BDSExtent	IndicativeExtent () const

Data Fields
BDSTunnelType	type
G4double	thickness
G4double	soilThickness
G4Material *	material
G4Material *	soilMaterial
G4bool	buildFloor
G4double	floorOffset
G4double	aper1
	Tunnel aperture / shape parameter 1. More...
G4double	aper2
	Tunnel aperture / shape parameter 2. More...
G4bool	sensitive
	Is the tunnel sensitive? More...
G4bool	visible
	Is the tunnel visible? More...

Detailed Description

Holder struct of all information required to create a section of tunnel.

This reduces the number of arguments to all constructors plus aggregates common tasks in the component factory.

Author

Laurie Nevay

Definition at line 39 of file BDSTunnelInfo.hh.

Constructor & Destructor Documentation

BDSTunnelInfo() [1/2]

BDSTunnelInfo::BDSTunnelInfo	(	BDSTunnelType	typeIn,
		G4double	thicknessIn,
		G4double	soilThicknessIn,
		G4Material *	materialIn,
		G4Material *	soilMaterialIn,
		G4bool	buildFloorIn,
		G4double	floorOffsetIn,
		G4double	aper1In,
		G4double	aper2In,
		G4bool	sensitiveIn,
		G4bool	visible = true
	)

Extra constructor to assign all members at once.

Definition at line 26 of file BDSTunnelInfo.cc.

BDSTunnelInfo() [2/2]

BDSTunnelInfo::BDSTunnelInfo	(	G4String	typeIn,
		G4double	thicknessIn,
		G4double	soilThicknessIn,
		G4String	materialIn,
		G4String	soilMaterialIn,
		G4bool	buildFloorIn,
		G4double	floorOffsetIn,
		G4double	aper1In,
		G4double	aper2In,
		G4bool	sensitiveIn,
		G4bool	visible = true
	)

Similar constructor, with the exception that the materials are provided in name form and looked up by this class to be converted into actual G4Material pointers. The type is also provided as a string and interpreted to a type.

Definition at line 44 of file BDSTunnelInfo.cc.

References BDS::DetermineTunnelType(), BDSMaterials::GetMaterial(), and BDSMaterials::Instance().

Here is the call graph for this function:

Member Function Documentation

IndicativeExtent()

BDSExtent BDSTunnelInfo::IndicativeExtent

(

)

const

Definition at line 65 of file BDSTunnelInfo.cc.

Field Documentation

aper1

G4double BDSTunnelInfo::aper1

Tunnel aperture / shape parameter 1.

Definition at line 85 of file BDSTunnelInfo.hh.

Referenced by BDSTunnelBuilder::BuildTunnelSections(), BDSTunnelFactoryRectAboveGround::TestInputParameters(), BDSTunnelFactoryCircular::TestInputParameters(), BDSTunnelFactorySquare::TestInputParameters(), BDSTunnelFactoryElliptical::TestInputParameters(), and BDSTunnelFactoryRectangular::TestInputParameters().

aper2

G4double BDSTunnelInfo::aper2

Tunnel aperture / shape parameter 2.

Definition at line 88 of file BDSTunnelInfo.hh.

Referenced by BDSTunnelBuilder::BuildTunnelSections(), BDSTunnelFactoryRectAboveGround::TestInputParameters(), BDSTunnelFactoryElliptical::TestInputParameters(), and BDSTunnelFactoryRectangular::TestInputParameters().

buildFloor

G4bool BDSTunnelInfo::buildFloor

Definition at line 81 of file BDSTunnelInfo.hh.

floorOffset

G4double BDSTunnelInfo::floorOffset

Definition at line 82 of file BDSTunnelInfo.hh.

material

G4Material* BDSTunnelInfo::material

Definition at line 79 of file BDSTunnelInfo.hh.

sensitive

G4bool BDSTunnelInfo::sensitive

Is the tunnel sensitive?

Definition at line 91 of file BDSTunnelInfo.hh.

soilMaterial

G4Material* BDSTunnelInfo::soilMaterial

Definition at line 80 of file BDSTunnelInfo.hh.

soilThickness

G4double BDSTunnelInfo::soilThickness

Definition at line 78 of file BDSTunnelInfo.hh.

thickness

G4double BDSTunnelInfo::thickness

Definition at line 77 of file BDSTunnelInfo.hh.

type

BDSTunnelType BDSTunnelInfo::type

Definition at line 76 of file BDSTunnelInfo.hh.

visible

G4bool BDSTunnelInfo::visible

Is the tunnel visible?

Definition at line 94 of file BDSTunnelInfo.hh.

Referenced by BDSTunnelBuilder::BuildTunnelSections().

---

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

• /Users/nevay/physics/reps/bdsim/include/BDSTunnelInfo.hh
• /Users/nevay/physics/reps/bdsim/src/BDSTunnelInfo.cc