A simple arc in the XZ plane. More...

#include <PlanarArcGeometry.h>

Inheritance diagram for PlanarArcGeometry:

Collaboration diagram for PlanarArcGeometry:

Public Member Functions
	PlanarArcGeometry (double l, double h)
	Constructor. More...

	PlanarArcGeometry (double phi)
	Constructor. More...

	PlanarArcGeometry (const PlanarArcGeometry &)

virtual	~PlanarArcGeometry ()

const PlanarArcGeometry &	operator= (const PlanarArcGeometry &)

virtual double	getArcLength () const
	Get arc length. More...

virtual double	getElementLength () const
	Get element length. More...

double	getBendAngle () const
	Get angle. More...

double	getCurvature () const
	Get curvature. More...

virtual void	setBendAngle (double)
	Set angle. More...

void	setCurvature (double)
	Set curvature. More...

virtual void	setElementLength (double)
	Set length. More...

virtual double	getOrigin () const
	Get origin. More...

double	getEntrance () const
	Get entrance. More...

double	getExit () const
	Get exit. More...

virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform. More...

virtual Euclid3D	getTransform (double s) const
	Get transform. More...

virtual Euclid3D	getTotalTransform () const
	Get transform. More...

Euclid3D	getEntranceFrame () const
	Get transform. More...

Euclid3D	getExitFrame () const
	Get transform. More...

Public Member Functions inherited from BGeometryBase
	BGeometryBase ()

	BGeometryBase (const BGeometryBase &right)

virtual	~BGeometryBase ()

const BGeometryBase &	operator= (const BGeometryBase &right)

virtual Euclid3D	getEntrancePatch () const
	Get patch. More...

virtual Euclid3D	getExitPatch () const
	Get patch. More...

Private Attributes
double	len

double	h

double	angle

Detailed Description

A simple arc in the XZ plane.

Definition at line 56 of file PlanarArcGeometry.h.

Constructor & Destructor Documentation

◆ PlanarArcGeometry() [1/3]

PlanarArcGeometry::PlanarArcGeometry	(	double	l,
		double	h
	)

inline

Constructor.

Definition at line 148 of file PlanarArcGeometry.h.

◆ PlanarArcGeometry() [2/3]

PlanarArcGeometry::PlanarArcGeometry ( double phi )

inline

Constructor.

Definition at line 153 of file PlanarArcGeometry.h.

◆ PlanarArcGeometry() [3/3]

PlanarArcGeometry::PlanarArcGeometry ( const PlanarArcGeometry & rhs )

inline

Definition at line 158 of file PlanarArcGeometry.h.

◆ ~PlanarArcGeometry()

PlanarArcGeometry::~PlanarArcGeometry ( )

virtual

Definition at line 47 of file PlanarArcGeometry.cpp.

Member Function Documentation

◆ getArcLength()

double PlanarArcGeometry::getArcLength ( ) const

virtual

Get arc length.

Implements BGeometryBase.

Definition at line 51 of file PlanarArcGeometry.cpp.

References len.

◆ getBendAngle()

double PlanarArcGeometry::getBendAngle ( ) const

Get angle.

Definition at line 66 of file PlanarArcGeometry.cpp.

References angle.

◆ getCurvature()

double PlanarArcGeometry::getCurvature ( ) const

Get curvature.

Definition at line 61 of file PlanarArcGeometry.cpp.

References h.

◆ getElementLength()

double PlanarArcGeometry::getElementLength ( ) const

virtual

Get element length.

Implements BGeometryBase.

Definition at line 56 of file PlanarArcGeometry.cpp.

References len.

◆ getEntrance()

double PlanarArcGeometry::getEntrance ( ) const

virtual

Get entrance.

Reimplemented from BGeometryBase.

Definition at line 100 of file PlanarArcGeometry.cpp.

References len.

◆ getEntranceFrame()

Euclid3D PlanarArcGeometry::getEntranceFrame ( ) const

virtual

Get transform.

Reimplemented from BGeometryBase.

Definition at line 125 of file PlanarArcGeometry.cpp.

References h, and len.

◆ getExit()

double PlanarArcGeometry::getExit ( ) const

virtual

Get exit.

Reimplemented from BGeometryBase.

Definition at line 105 of file PlanarArcGeometry.cpp.

References len.

◆ getExitFrame()

Euclid3D PlanarArcGeometry::getExitFrame ( ) const

virtual

Get transform.

Reimplemented from BGeometryBase.

Definition at line 130 of file PlanarArcGeometry.cpp.

References h, and len.

◆ getOrigin()

double PlanarArcGeometry::getOrigin ( ) const

virtual

Get origin.

Reimplemented from BGeometryBase.

Definition at line 95 of file PlanarArcGeometry.cpp.

References len.

◆ getTotalTransform()

Euclid3D PlanarArcGeometry::getTotalTransform ( ) const

virtual

Get transform.

Reimplemented from BGeometryBase.

Definition at line 115 of file PlanarArcGeometry.cpp.

References h, and len.

◆ getTransform() [1/2]

Euclid3D PlanarArcGeometry::getTransform	(	double	fromS,
		double	toS
	)		const

virtual

Get transform.

Implements BGeometryBase.

Definition at line 110 of file PlanarArcGeometry.cpp.

References h.

◆ getTransform() [2/2]

Euclid3D PlanarArcGeometry::getTransform ( double s ) const

virtual

Get transform.

Reimplemented from BGeometryBase.

Definition at line 120 of file PlanarArcGeometry.cpp.

References h.

◆ operator=()

const PlanarArcGeometry & PlanarArcGeometry::operator= ( const PlanarArcGeometry & rhs )

inline

Definition at line 163 of file PlanarArcGeometry.h.

References len.

◆ setBendAngle()

void PlanarArcGeometry::setBendAngle ( double phi )

virtual

Set angle.

Definition at line 71 of file PlanarArcGeometry.cpp.

References angle, h, and len.

◆ setCurvature()

void PlanarArcGeometry::setCurvature ( double hh )

Set curvature.

Definition at line 77 of file PlanarArcGeometry.cpp.

References angle, h, and len.

Referenced by MultipoleT::initialise(), ScalingFFAMagnet::initialise(), MultipoleTCurvedConstRadius::initialise(), and SBend3D::setFieldMapFileName().

◆ setElementLength()

void PlanarArcGeometry::setElementLength ( double l )

virtual

Set length.

Reimplemented from BGeometryBase.

Definition at line 85 of file PlanarArcGeometry.cpp.

References angle, h, and len.

Referenced by MultipoleT::initialise(), ScalingFFAMagnet::initialise(), MultipoleTCurvedConstRadius::initialise(), and SBend3D::setFieldMapFileName().

Member Data Documentation

◆ angle

double PlanarArcGeometry::angle

private

Definition at line 143 of file PlanarArcGeometry.h.

Referenced by getBendAngle(), setBendAngle(), setCurvature(), and setElementLength().

◆ h

double PlanarArcGeometry::h

private

Definition at line 142 of file PlanarArcGeometry.h.

Referenced by getCurvature(), getEntranceFrame(), getExitFrame(), getTotalTransform(), getTransform(), setBendAngle(), setCurvature(), and setElementLength().

◆ len

double PlanarArcGeometry::len

private

Definition at line 141 of file PlanarArcGeometry.h.

Referenced by getArcLength(), getElementLength(), getEntrance(), getEntranceFrame(), getExit(), getExitFrame(), getOrigin(), getTotalTransform(), operator=(), setBendAngle(), setCurvature(), and setElementLength().

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

/Users/gsell/src/OPAL/src/src/Classic/BeamlineGeometry/PlanarArcGeometry.h
/Users/gsell/src/OPAL/src/src/Classic/BeamlineGeometry/PlanarArcGeometry.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PlanarArcGeometry() [1/3]

◆ PlanarArcGeometry() [2/3]

◆ PlanarArcGeometry() [3/3]

◆ ~PlanarArcGeometry()

Member Function Documentation

◆ getArcLength()

◆ getBendAngle()

◆ getCurvature()

◆ getElementLength()

◆ getEntrance()

◆ getEntranceFrame()

◆ getExit()

◆ getExitFrame()

◆ getOrigin()

◆ getTotalTransform()

◆ getTransform() [1/2]

◆ getTransform() [2/2]

◆ operator=()

◆ setBendAngle()

◆ setCurvature()

◆ setElementLength()

Member Data Documentation

◆ angle

◆ h

◆ len