BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
|
Information about a registered sampler. More...
#include <BDSSamplerPlacementRecord.hh>
Public Member Functions | |
BDSSamplerPlacementRecord ()=delete | |
No default constructor. | |
BDSSamplerPlacementRecord (const G4String &nameIn, BDSSampler *samplerIn, const G4Transform3D &transformIn, G4double sPositionIn=-1000, const BDSBeamlineElement *elementIn=nullptr, const G4String &uniqueNameIn="", BDSSamplerType typeIn=BDSSamplerType::plane, G4double radiusIn=0) | |
G4String | Name () const |
Accessor. | |
G4String | UniqueName () const |
Accessor. | |
BDSSampler * | Sampler () const |
Accessor. | |
G4Transform3D | Transform () const |
Accessor. | |
G4Transform3D | TransformInverse () const |
Accessor. | |
G4double | SPosition () const |
Accessor. | |
const BDSBeamlineElement * | Element () const |
Accessor. | |
G4int | BeamlineIndex () const |
Accessor. | |
BDSSamplerType | Type () const |
Accessor. | |
G4double | Radius () const |
Accessor. | |
Private Attributes | |
G4String | name |
The name of the sampler. | |
BDSSampler * | sampler |
The sampler instance that this information pertains to. | |
G4Transform3D | transform |
The transform the sampler was placed with. | |
G4Transform3D | transformInverse |
The calculated inverse of the transform the sampler was placed with. | |
G4double | sPosition |
The curvilinear S position of this sampler. | |
const BDSBeamlineElement * | element |
The beam line element to which this sampler pertains (if any). | |
G4String | uniqueName |
The name of the sampler but suffixed with a number - guaranteed to be unique. | |
BDSSamplerType | type |
G4double | radius |
Information about a registered sampler.
This class contains the information about a constructed and placed sampler. The sampler registry holds a vector of this class. This class is NOT a template to build a sampler, but a record of what was built (unlike the other BDSXXXXInfo classes in BDSIM.
This does not own the BDSSampler instance, merely keeps a record of it. Note, there can be many placements and therefore registrations of one sampler instance. This also means that the compiler provided default copy constructor is safe.
Definition at line 46 of file BDSSamplerPlacementRecord.hh.
BDSSamplerPlacementRecord::BDSSamplerPlacementRecord | ( | const G4String & | nameIn, |
BDSSampler * | samplerIn, | ||
const G4Transform3D & | transformIn, | ||
G4double | sPositionIn = -1000 , |
||
const BDSBeamlineElement * | elementIn = nullptr , |
||
const G4String & | uniqueNameIn = "" , |
||
BDSSamplerType | typeIn = BDSSamplerType::plane , |
||
G4double | radiusIn = 0 |
||
) |
Definition at line 24 of file BDSSamplerPlacementRecord.cc.
|
inline |
Definition at line 60 of file BDSSamplerPlacementRecord.hh.
|
inline |
Accessor.
Definition at line 87 of file BDSSamplerPlacementRecord.hh.
References element, and BDSBeamlineElement::GetIndex().
Referenced by BDSSDSampler::ProcessHits(), BDSSDSamplerCylinder::ProcessHits(), and BDSSDSamplerSphere::ProcessHits().
|
inline |
|
inline |
Accessor.
Definition at line 63 of file BDSSamplerPlacementRecord.hh.
References name.
Referenced by BDSSamplerRegistry::GetNames().
|
inline |
Accessor.
Definition at line 72 of file BDSSamplerPlacementRecord.hh.
Referenced by BDSSamplerRegistry::GetUniqueNameToRadiusCylinder(), and BDSSamplerRegistry::GetUniqueNameToRadiusSphere().
|
inline |
|
inline |
Accessor.
Definition at line 68 of file BDSSamplerPlacementRecord.hh.
References sPosition.
Referenced by BDSSamplerRegistry::GetUniquePlaneNamesAndSPosition(), BDSSDSampler::ProcessHits(), BDSSDSamplerCylinder::ProcessHits(), and BDSSDSamplerSphere::ProcessHits().
|
inline |
|
inline |
|
inline |
Accessor.
Definition at line 71 of file BDSSamplerPlacementRecord.hh.
Referenced by BDSSamplerRegistry::GetUniqueNameToRadiusCylinder(), BDSSamplerRegistry::GetUniqueNameToRadiusSphere(), and BDSSamplerRegistry::GetUniquePlaneNamesAndSPosition().
|
inline |
Accessor.
Definition at line 64 of file BDSSamplerPlacementRecord.hh.
References uniqueName.
Referenced by BDSSamplerRegistry::GetUniqueNames(), BDSSamplerRegistry::GetUniqueNameToRadiusCylinder(), BDSSamplerRegistry::GetUniqueNameToRadiusSphere(), and BDSSamplerRegistry::GetUniquePlaneNamesAndSPosition().
|
private |
The beam line element to which this sampler pertains (if any).
Definition at line 81 of file BDSSamplerPlacementRecord.hh.
Referenced by BeamlineIndex(), and Element().
|
private |
The name of the sampler.
Definition at line 76 of file BDSSamplerPlacementRecord.hh.
Referenced by Name().
|
private |
Definition at line 84 of file BDSSamplerPlacementRecord.hh.
|
private |
The sampler instance that this information pertains to.
Definition at line 77 of file BDSSamplerPlacementRecord.hh.
Referenced by Sampler().
|
private |
The curvilinear S position of this sampler.
Definition at line 80 of file BDSSamplerPlacementRecord.hh.
Referenced by SPosition().
|
private |
The transform the sampler was placed with.
Definition at line 78 of file BDSSamplerPlacementRecord.hh.
Referenced by Transform().
|
private |
The calculated inverse of the transform the sampler was placed with.
Definition at line 79 of file BDSSamplerPlacementRecord.hh.
Referenced by TransformInverse().
|
private |
Definition at line 83 of file BDSSamplerPlacementRecord.hh.
|
private |
The name of the sampler but suffixed with a number - guaranteed to be unique.
Definition at line 82 of file BDSSamplerPlacementRecord.hh.
Referenced by UniqueName().