CorrectorWrapper Class Reference

Representation for a perturbed closed orbit corrector. More...

#include <CorrectorWrapper.h>

Inheritance diagram for CorrectorWrapper:

Collaboration diagram for CorrectorWrapper:

Public Member Functions
	CorrectorWrapper (Corrector *)
	Constructor. More...
	CorrectorWrapper (const CorrectorWrapper &)
virtual	~CorrectorWrapper ()
virtual void	accept (BeamlineVisitor &) const
	Apply visitor to modified corrector. More...
virtual ElementBase *	clone () const
	Make clone. More...
virtual ElementBase *	copyStructure ()
	Make structural copy. More...
virtual BDipoleField &	errorField () const
	Get corrector field error. More...
virtual void	makeSharable ()
	Set sharable flag. More...
virtual BDipoleField &	getField ()
	Get corrector field. More...
virtual const BDipoleField &	getField () const
	Get corrector field. More...
virtual StraightGeometry &	getGeometry ()
	Get geometry. More...
virtual const StraightGeometry &	getGeometry () const
	Get geometry. More...
virtual Plane	getPlane () const
	Get plane of action. More...
virtual ElementBase::ElementType	getType () const
	Get element type string. More...
virtual const Corrector &	getDesign () const
	Get design corrector. More...
virtual Corrector &	getDesign ()
	Get design corrector. More...
virtual ElementBase *	makeFieldWrapper ()
	Make wrapper for this corrector. More...
virtual ElementBase *	removeFieldWrapper ()
	Remove field wrapper. More...
virtual const ElementBase *	removeFieldWrapper () const
	Remove field wrapper. More...
virtual ElementBase *	removeWrappers ()
	Remove all wrappers. More...
virtual const ElementBase *	removeWrappers () const
	Remove all wrappers. More...
Public Member Functions inherited from Corrector
	Corrector (const std::string &name)
	Constructor with given name. More...
	Corrector ()
	Corrector (const Corrector &right)
virtual	~Corrector ()
virtual bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B)
virtual bool	apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B)
virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)
virtual void	goOnline (const double &kineticEnergy)
virtual void	finalise ()
virtual bool	bends () const
virtual void	getDimensions (double &zBegin, double &zEnd) const
void	setKickX (double k)
void	setKickY (double k)
virtual void	setDesignEnergy (const double &ekin, bool changeable=true)
double	getKickX () const
double	getKickY () const
void	setKickField (const Vector_t &k0)
Public Member Functions inherited from Component
	Component (const std::string &name)
	Constructor with given name. More...
	Component ()
	Component (const Component &right)
virtual	~Component ()
EVector	Efield (const Point3D &P) const
	Return the field in a point. More...
BVector	Bfield (const Point3D &P) const
	Return the field in a point. More...
EVector	Efield (const Point3D &P, double t) const
	Return the field in a point. More...
BVector	Bfield (const Point3D &P, double t) const
	Return the field in a point. More...
EBVectors	EBfield (const Point3D &P) const
	Return the field in a point. More...
EBVectors	EBfield (const Point3D &P, double t) const
	Return the field in a point. More...
virtual void	addKR (int i, double t, Vector_t &K)
virtual void	addKT (int i, double t, Vector_t &K)
virtual bool	applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B)
virtual bool	getPotential (const Vector_t &R, const double &t, Vector_t &A, double &phi)
virtual double	getDesignEnergy () const
virtual void	goOffline ()
virtual bool	Online ()
virtual void	setComponentType (std::string)
virtual std::string	getComponentType () const
virtual void	trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track particle bunch. More...
virtual void	trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
	Track a map. More...
void	setExitFaceSlope (const double &)
Public Member Functions inherited from ElementBase
	ElementBase (const std::string &name)
	Constructor with given name. More...
	ElementBase ()
	ElementBase (const ElementBase &)
virtual	~ElementBase ()
virtual const std::string &	getName () const
	Get element name. More...
virtual void	setName (const std::string &name)
	Set element name. More...
std::string	getTypeString () const
virtual double	getArcLength () const
	Get arc length. More...
virtual double	getElementLength () const
	Get design length. More...
virtual void	setElementLength (double length)
	Set design length. More...
virtual void	getElementDimensions (double &begin, double &end) const
virtual double	getOrigin () const
	Get origin position. More...
virtual double	getEntrance () const
	Get entrance position. More...
virtual double	getExit () const
	Get exit position. 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...
virtual Euclid3D	getEntranceFrame () const
	Get transform. More...
virtual Euclid3D	getExitFrame () const
	Get transform. More...
virtual Euclid3D	getEntrancePatch () const
	Get patch. More...
virtual Euclid3D	getExitPatch () const
	Get patch. More...
virtual double	getAttribute (const std::string &aKey) const
	Get attribute value. More...
virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute. More...
virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute. More...
virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute. More...
virtual Channel *	getChannel (const std::string &aKey, bool create=false)
	Construct a read/write channel. More...
virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel. More...
virtual ElementImage *	getImage () const
	Construct an image. More...
bool	isSharable () const
	Test if the element can be shared. More...
virtual ElementBase *	makeAlignWrapper ()
	Allow misalignment. More...
virtual ElementBase *	makeWrappers ()
	Allow errors. More...
virtual ElementBase *	removeAlignWrapper ()
	Remove align wrapper. More...
virtual const ElementBase *	removeAlignWrapper () const
	Remove align wrapper. More...
bool	update (const AttributeSet &)
	Update element. More...
virtual void	setBoundaryGeometry (BoundaryGeometry *geo)
virtual BoundaryGeometry *	getBoundaryGeometry () const
	return the attached boundary geometrt object if there is any More...
virtual bool	hasBoundaryGeometry () const
virtual void	setWake (WakeFunction *wf)
	attach a wake field to the element More...
virtual WakeFunction *	getWake () const
	return the attached wake object if there is any More...
virtual bool	hasWake () const
virtual void	setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)
virtual ParticleMatterInteractionHandler *	getParticleMatterInteraction () const
virtual bool	hasParticleMatterInteraction () const
ElemType	getElType () const
	returns element type as enumeration needed in the envelope tracker More...
void	setElType (ElemType elt)
	set the element type as enumeration needed in the envelope tracker More...
void	setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)
CoordinateSystemTrafo	getCSTrafoGlobal2Local () const
void	releasePosition ()
void	fixPosition ()
bool	isPositioned () const
virtual CoordinateSystemTrafo	getEdgeToBegin () const
virtual CoordinateSystemTrafo	getEdgeToEnd () const
void	setAperture (const ApertureType &type, const std::vector< double > &args)
std::pair < ElementBase::ApertureType, std::vector< double > >	getAperture () const
virtual bool	isInside (const Vector_t &r) const
void	setMisalignment (double x, double y, double s)
void	setMisalignment (const CoordinateSystemTrafo &cst)
void	getMisalignment (double &x, double &y, double &s) const
CoordinateSystemTrafo	getMisalignment () const
void	setActionRange (const std::queue< std::pair< double, double > > &range)
void	setCurrentSCoordinate (double s)
void	setRotationAboutZ (double rotation)
	Set rotation about z axis in bend frame. More...
double	getRotationAboutZ () const
void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute. More...
double	getElementPosition () const
bool	isElementPositionSet () const
Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...
int	removeReference () const
	Decrement the reference count. More...
bool	isShared () const
	Test for sharing. More...

Private Member Functions
	CorrectorWrapper ()
void	operator= (const CorrectorWrapper &)

Private Attributes
Pointer< Corrector >	itsDesign
BDipoleField	itsError
	The field modifiers. More...
BDipoleField	tempField

Additional Inherited Members
Public Types inherited from Corrector
enum	Plane { OFF, X, Y, XY }
	Plane selection. More...
Public Types inherited from ElementBase
enum	ApertureType { RECTANGULAR, ELLIPTICAL, CONIC_RECTANGULAR, CONIC_ELLIPTICAL }
enum	ElementType {   ALIGNWRAPPER, BEAMBEAM, BEAMBEAM3D, BEAMLINE,   BEAMSTRIPPING, CCOLLIMATOR, CORRECTOR, CORRECTORWRAPPER,   CYCLOTRON, CYCLOTRONWRAPPER, CYCLOTRONVALLEY, DEGRADER,   DIAGNOSTIC, DRIFT, FLEXIBLECOLLIMATOR, INTEGRATOR,   LAMBERTSON, MARKER, MONITOR, MPSPLITINTEGRATOR,   MULTIPOLE, MULTIPOLET, MULTIPOLEWRAPPER, OFFSET,   PARALLELPLATE, PATCH, PROBE, RBEND,   RBEND3D, RBENDWRAPPER, RFCAVITY, RFQUADRUPOLE,   RING, SBEND3D, SBEND, SBENDWRAPPER,   SEPARATOR, SEPTUM, SOLENOID, SOURCE,   STRIPPER, TRAVELINGWAVE, VARIABLERFCAVITY, ANY }
Static Public Member Functions inherited from ElementBase
static std::string	getTypeString (ElementType type)
Protected Member Functions inherited from Corrector
void	operator= (const Corrector &)
Protected Member Functions inherited from ElementBase
bool	isInsideTransverse (const Vector_t &r, double f=1) const
Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...
	RCObject (const RCObject &)
	Copy constructor. More...
virtual	~RCObject ()=0
RCObject &	operator= (const RCObject &right)
Protected Attributes inherited from Corrector
Plane	plane_m
Protected Attributes inherited from Component
double	exit_face_slope_m
PartBunchBase< double, 3 > *	RefPartBunch_m
bool	online_m
Protected Attributes inherited from ElementBase
bool	shareFlag
CoordinateSystemTrafo	csTrafoGlobal2Local_m
CoordinateSystemTrafo	misalignment_m
std::pair< ApertureType, std::vector< double > >	aperture_m
double	elementEdge_m
double	rotationZAxis_m
Static Protected Attributes inherited from Component
static const std::vector< double >	defaultAperture_m

Detailed Description

Representation for a perturbed closed orbit corrector.

Definition at line 37 of file CorrectorWrapper.h.

Constructor & Destructor Documentation

CorrectorWrapper::CorrectorWrapper

(

Corrector *

corr

)

Constructor.

Definition at line 30 of file CorrectorWrapper.cpp.

References ElementBase::shareFlag.

CorrectorWrapper::CorrectorWrapper

(

const CorrectorWrapper &

rhs

)

Definition at line 39 of file CorrectorWrapper.cpp.

References ElementBase::shareFlag.

CorrectorWrapper::~CorrectorWrapper ( )

virtual

Definition at line 48 of file CorrectorWrapper.cpp.

CorrectorWrapper::CorrectorWrapper ( )

private

Referenced by clone(), and copyStructure().

Member Function Documentation

void CorrectorWrapper::accept ( BeamlineVisitor &  visitor ) const

virtual

Apply visitor to modified corrector.

Reimplemented from Corrector.

Definition at line 52 of file CorrectorWrapper.cpp.

References BeamlineVisitor::visitCorrectorWrapper().

Here is the call graph for this function:

ElementBase * CorrectorWrapper::clone ( ) const

virtual

Make clone.

Implements ElementBase.

Definition at line 57 of file CorrectorWrapper.cpp.

References ElementBase::clone(), CorrectorWrapper(), and itsDesign.

Here is the call graph for this function:

ElementBase * CorrectorWrapper::copyStructure ( )

virtual

Make structural copy.

Reimplemented from ElementBase.

Definition at line 64 of file CorrectorWrapper.cpp.

References ElementBase::copyStructure(), CorrectorWrapper(), ElementBase::isSharable(), and itsDesign.

Here is the call graph for this function:

BDipoleField & CorrectorWrapper::errorField ( ) const

virtual

Get corrector field error.

Definition at line 111 of file CorrectorWrapper.cpp.

References itsError.

Referenced by OpalHKicker::fillRegisteredAttributes(), OpalVKicker::fillRegisteredAttributes(), and OpalKicker::fillRegisteredAttributes().

const Corrector & CorrectorWrapper::getDesign ( ) const

virtual

Get design corrector.

Reimplemented from Component.

Definition at line 101 of file CorrectorWrapper.cpp.

References itsDesign.

Referenced by OpalHKicker::fillRegisteredAttributes(), OpalVKicker::fillRegisteredAttributes(), OpalKicker::fillRegisteredAttributes(), and IdealMapper::visitCorrectorWrapper().

Corrector & CorrectorWrapper::getDesign ( )

virtual

Get design corrector.

Definition at line 106 of file CorrectorWrapper.cpp.

References itsDesign.

BDipoleField & CorrectorWrapper::getField ( )

virtual

Get corrector field.

Implements Corrector.

Definition at line 141 of file CorrectorWrapper.cpp.

References BDipoleField::addField(), Corrector::getField(), itsDesign, itsError, and tempField.

Referenced by OpalHKicker::fillRegisteredAttributes(), OpalVKicker::fillRegisteredAttributes(), and OpalKicker::fillRegisteredAttributes().

Here is the call graph for this function:

const BDipoleField & CorrectorWrapper::getField ( ) const

virtual

Get corrector field.

Implements Corrector.

Definition at line 148 of file CorrectorWrapper.cpp.

References BDipoleField::addField(), Corrector::getField(), itsDesign, itsError, and tempField.

Here is the call graph for this function:

StraightGeometry & CorrectorWrapper::getGeometry ( )

virtual

Get geometry.

Implements Corrector.

Definition at line 81 of file CorrectorWrapper.cpp.

References Corrector::getGeometry(), and itsDesign.

Here is the call graph for this function:

const StraightGeometry & CorrectorWrapper::getGeometry ( ) const

virtual

Get geometry.

Implements Corrector.

Definition at line 86 of file CorrectorWrapper.cpp.

References Corrector::getGeometry(), and itsDesign.

Here is the call graph for this function:

Corrector::Plane CorrectorWrapper::getPlane ( ) const

virtual

Get plane of action.

Implements Corrector.

Definition at line 91 of file CorrectorWrapper.cpp.

References Corrector::getPlane(), and itsDesign.

Here is the call graph for this function:

ElementBase::ElementType CorrectorWrapper::getType ( ) const

virtual

Get element type string.

Reimplemented from Corrector.

Definition at line 96 of file CorrectorWrapper.cpp.

References ElementBase::CORRECTORWRAPPER.

ElementBase * CorrectorWrapper::makeFieldWrapper ( )

virtual

Make wrapper for this corrector.

Reimplemented from ElementBase.

Definition at line 116 of file CorrectorWrapper.cpp.

void CorrectorWrapper::makeSharable ( )

virtual

Set sharable flag.

Reimplemented from ElementBase.

Definition at line 75 of file CorrectorWrapper.cpp.

References itsDesign, ElementBase::makeSharable(), and ElementBase::shareFlag.

Here is the call graph for this function:

void CorrectorWrapper::operator= ( const CorrectorWrapper &  )

private

ElementBase * CorrectorWrapper::removeFieldWrapper ( )

virtual

Remove field wrapper.

Reimplemented from ElementBase.

Definition at line 121 of file CorrectorWrapper.cpp.

References itsDesign.

const ElementBase * CorrectorWrapper::removeFieldWrapper ( ) const

virtual

Remove field wrapper.

Reimplemented from ElementBase.

Definition at line 126 of file CorrectorWrapper.cpp.

References itsDesign.

ElementBase * CorrectorWrapper::removeWrappers ( )

virtual

Remove all wrappers.

Reimplemented from ElementBase.

Definition at line 131 of file CorrectorWrapper.cpp.

References itsDesign.

const ElementBase * CorrectorWrapper::removeWrappers ( ) const

virtual

Remove all wrappers.

Reimplemented from ElementBase.

Definition at line 136 of file CorrectorWrapper.cpp.

References itsDesign.

Member Data Documentation

Pointer<Corrector> CorrectorWrapper::itsDesign

private

Definition at line 122 of file CorrectorWrapper.h.

Referenced by clone(), copyStructure(), getDesign(), getField(), getGeometry(), getPlane(), makeSharable(), removeFieldWrapper(), and removeWrappers().

BDipoleField CorrectorWrapper::itsError

mutableprivate

The field modifiers.

Definition at line 125 of file CorrectorWrapper.h.

Referenced by errorField(), and getField().

BDipoleField CorrectorWrapper::tempField

mutableprivate

Definition at line 128 of file CorrectorWrapper.h.

Referenced by getField().

---

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

• src/Classic/ComponentWrappers/CorrectorWrapper.h
• src/Classic/ComponentWrappers/CorrectorWrapper.cpp