BDSTiltOffset Class Reference

A holder for any placement offsets and rotations for a BDSAcceleratorComponent. More...

#include <BDSTiltOffset.hh>

Collaboration diagram for BDSTiltOffset:

Public Member Functions
	BDSTiltOffset (G4double xOffset, G4double yOffset, G4double tiltIn)
G4ThreeVector	GetOffset () const
	More advance accessor for offset - only in x,y.
G4Transform3D	Transform3D () const
	Get a transform to represent this tilt offset.
G4double	GetXOffset () const
	Accessor.
G4double	GetYOffset () const
	Accessor.
G4double	GetTilt () const
	Accessor.
G4bool	HasFiniteOffset () const
	Inspector.
G4bool	HasFiniteTilt () const
	Inspector.

Private Attributes
G4double	dx
	Horizontal displacement (mm) - note right handed coordinate system.
G4double	dy
	Vertical displacement (mm)
G4double	tilt
	Tilt angle (rad) - rotation angle about Z axis.

Friends
std::ostream &	operator<< (std::ostream &out, BDSTiltOffset const &to)
	Output stream.

Detailed Description

A holder for any placement offsets and rotations for a BDSAcceleratorComponent.

Note, no rotation variables are provided other than along the beam axis (z) as this would cause overlapping volumes between a component and the next one in the line. This leads to much more complicated geometry or padding space (perhaps acceptable for very low angles), but for now is left to be implemented in future.

Author

Laurie Nevay

Definition at line 39 of file BDSTiltOffset.hh.

Constructor & Destructor Documentation

BDSTiltOffset() [1/2]

BDSTiltOffset::BDSTiltOffset

(

)

Definition at line 28 of file BDSTiltOffset.cc.

BDSTiltOffset() [2/2]

BDSTiltOffset::BDSTiltOffset	(	G4double	xOffset,
		G4double	yOffset,
		G4double	tiltIn
	)

Definition at line 32 of file BDSTiltOffset.cc.

Member Function Documentation

GetOffset()

G4ThreeVector BDSTiltOffset::GetOffset ( ) const

inline

More advance accessor for offset - only in x,y.

Definition at line 55 of file BDSTiltOffset.hh.

References dx, and dy.

Referenced by BDSBeamline::AddSingleComponent(), BDSExtent::TiltOffset(), and Transform3D().

Here is the caller graph for this function:

GetTilt()

G4double BDSTiltOffset::GetTilt ( ) const

inline

Accessor.

Definition at line 51 of file BDSTiltOffset.hh.

References tilt.

Referenced by BDSBeamline::AddSingleComponent(), BDSCurvilinearFactory::CreateCurvilinearVolume(), BDSOutputROOTEventModel::Fill(), BDSBeamlineElement::GetTilt(), BDSBeamlineElement::InputFaceNormal(), BDSBeamlineElement::OutputFaceNormal(), and BDSExtent::TiltOffset().

Here is the caller graph for this function:

GetXOffset()

G4double BDSTiltOffset::GetXOffset ( ) const

inline

Accessor.

Definition at line 49 of file BDSTiltOffset.hh.

References dx.

Referenced by BDSOutputROOTEventModel::Fill().

Here is the caller graph for this function:

GetYOffset()

G4double BDSTiltOffset::GetYOffset ( ) const

inline

Accessor.

Definition at line 50 of file BDSTiltOffset.hh.

References dy.

Referenced by BDSOutputROOTEventModel::Fill().

Here is the caller graph for this function:

HasFiniteOffset()

G4bool BDSTiltOffset::HasFiniteOffset

(

)

const

Inspector.

Definition at line 52 of file BDSTiltOffset.cc.

References dx, dy, and BDS::IsFinite().

Referenced by BDSBeamline::AddSingleComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

HasFiniteTilt()

G4bool BDSTiltOffset::HasFiniteTilt

(

)

const

Inspector.

Definition at line 57 of file BDSTiltOffset.cc.

References BDS::IsFinite(), and tilt.

Referenced by BDSBeamline::AddSingleComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

Transform3D()

G4Transform3D BDSTiltOffset::Transform3D

(

)

const

Get a transform to represent this tilt offset.

Definition at line 44 of file BDSTiltOffset.cc.

References GetOffset(), and tilt.

Referenced by BDSComponentFactory::CreateFieldTransform().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  out, BDSTiltOffset const &  to  )

friend

Output stream.

Definition at line 38 of file BDSTiltOffset.cc.

Field Documentation

dx

G4double BDSTiltOffset::dx

private

Horizontal displacement (mm) - note right handed coordinate system.

Definition at line 70 of file BDSTiltOffset.hh.

Referenced by GetOffset(), GetXOffset(), and HasFiniteOffset().

dy

G4double BDSTiltOffset::dy

private

Vertical displacement (mm)

Definition at line 72 of file BDSTiltOffset.hh.

Referenced by GetOffset(), GetYOffset(), and HasFiniteOffset().

tilt

G4double BDSTiltOffset::tilt

private

Tilt angle (rad) - rotation angle about Z axis.

Definition at line 74 of file BDSTiltOffset.hh.

Referenced by GetTilt(), HasFiniteTilt(), and Transform3D().

---

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

• /__w/bdsim/bdsim/include/BDSTiltOffset.hh
• /__w/bdsim/bdsim/src/BDSTiltOffset.cc