Define the position of a misaligned element. More...

#include <AlignWrapper.h>

Inheritance diagram for AlignWrapper:

Collaboration diagram for AlignWrapper:

Public Member Functions
virtual void	accept (BeamlineVisitor &) const override
	Apply BeamlineVisitor. More...

virtual AlignWrapper *	clone () const override
	Return clone. More...

virtual ElementBase *	copyStructure () override
	Make structural copy. More...

virtual void	makeSharable () override
	Set sharable flag. More...

virtual Euclid3D	getEntranceTransform () const
	Get entrance patch. More...

virtual Euclid3D	getExitTransform () const
	Get exit patch. More...

virtual ElementBase *	getElement () const
	Return the contained element. More...

void	setElement (ElementBase *)
	Replace the contained element. More...

virtual BGeometryBase &	getGeometry () override
	Get geometry. More...

virtual const BGeometryBase &	getGeometry () const override
	Get geometry. More...

Euclid3D &	offset () const
	Return the offset. More...

virtual ElementBase::ElementBase::ElementType	getType () const override
	Get element type std::string. More...

virtual ElementBase *	makeAlignWrapper () override
	Disallow misalignment of an already misaligned object. More...

virtual ElementBase *	makeFieldWrapper () override
	Allow field errors. More...

virtual ElementBase *	removeAlignWrapper () override
	Remove AlignWrapper. More...

virtual const ElementBase *	removeAlignWrapper () const override
	Remove AlignWrapper. More...

virtual ElementBase *	removeFieldWrapper () override
	Remove field wrapper. More...

virtual const ElementBase *	removeFieldWrapper () const override
	Remove field wrapper. More...

virtual ElementBase *	removeWrappers () override
	Return the design element. More...

virtual const ElementBase *	removeWrappers () const override
	Return the design element. More...

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 *	makeWrappers ()
	Allow errors. 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
	AlignWrapper (const AlignWrapper &)

virtual	~AlignWrapper ()

	AlignWrapper (ElementBase *)

	AlignWrapper ()

void	operator= (const AlignWrapper &)

Private Attributes
Pointer< ElementBase >	itsElement

Euclid3D	itsOffset

Friends
class	ElementBase

Additional Inherited Members
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 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 ElementBase
bool	shareFlag

CoordinateSystemTrafo	csTrafoGlobal2Local_m

CoordinateSystemTrafo	misalignment_m

std::pair< ApertureType, std::vector< double > >	aperture_m

double	elementEdge_m

double	rotationZAxis_m

Detailed Description

Define the position of a misaligned element.

Definition at line 39 of file AlignWrapper.h.

Constructor & Destructor Documentation

AlignWrapper::AlignWrapper ( const AlignWrapper & rhs )

private

Definition at line 147 of file AlignWrapper.cpp.

References ElementBase::shareFlag.

AlignWrapper::~AlignWrapper ( )

privatevirtual

Definition at line 153 of file AlignWrapper.cpp.

AlignWrapper::AlignWrapper ( ElementBase * elem )

private

Definition at line 157 of file AlignWrapper.cpp.

References ElementBase::shareFlag.

AlignWrapper::AlignWrapper ( )

private

Referenced by clone(), copyStructure(), and removeFieldWrapper().

Member Function Documentation

void AlignWrapper::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Apply BeamlineVisitor.

Implements ElementBase.

Definition at line 28 of file AlignWrapper.cpp.

References BeamlineVisitor::visitAlignWrapper().

Here is the call graph for this function:

AlignWrapper * AlignWrapper::clone ( ) const

overridevirtual

Return clone.

Implements ElementBase.

Definition at line 33 of file AlignWrapper.cpp.

References AlignWrapper().

Here is the call graph for this function:

ElementBase * AlignWrapper::copyStructure ( )

overridevirtual

Make structural copy.

Reimplemented from ElementBase.

Definition at line 38 of file AlignWrapper.cpp.

References AlignWrapper(), ElementBase::copyStructure(), ElementBase::isSharable(), and itsElement.

Here is the call graph for this function:

ElementBase * AlignWrapper::getElement ( ) const

virtual

Return the contained element.

Definition at line 75 of file AlignWrapper.cpp.

References itsElement.

Referenced by IdealMapper::visitAlignWrapper(), Tracker::visitAlignWrapper(), Mapper::visitAlignWrapper(), OrbitTracker::visitAlignWrapper(), LinearMapper::visitAlignWrapper(), TransportMapper::visitAlignWrapper(), DefaultVisitor::visitAlignWrapper(), and SpecificElementVisitor< ELEM >::visitAlignWrapper().

Euclid3D AlignWrapper::getEntranceTransform ( ) const

virtual

Get entrance patch.

Definition at line 55 of file AlignWrapper.cpp.

References ElementBase::getEntranceFrame(), Euclid3D::inverse(), Euclid3D::isIdentity(), itsElement, and itsOffset.

Referenced by Flatten< Member >::handleBeamline(), Tracker::visitAlignWrapper(), Mapper::visitAlignWrapper(), OrbitTracker::visitAlignWrapper(), LinearMapper::visitAlignWrapper(), and TransportMapper::visitAlignWrapper().

Here is the call graph for this function:

Euclid3D AlignWrapper::getExitTransform ( ) const

virtual

Get exit patch.

Definition at line 65 of file AlignWrapper.cpp.

References ElementBase::getExitFrame(), Inverse(), Euclid3D::isIdentity(), itsElement, and itsOffset.

Referenced by Flatten< Member >::handleBeamline(), Tracker::visitAlignWrapper(), Mapper::visitAlignWrapper(), OrbitTracker::visitAlignWrapper(), LinearMapper::visitAlignWrapper(), and TransportMapper::visitAlignWrapper().

Here is the call graph for this function:

BGeometryBase & AlignWrapper::getGeometry ( )

overridevirtual

Get geometry.

Implements ElementBase.

Definition at line 85 of file AlignWrapper.cpp.

References ElementBase::getGeometry(), and itsElement.

Here is the call graph for this function:

const BGeometryBase & AlignWrapper::getGeometry ( ) const

overridevirtual

Get geometry.

Implements ElementBase.

Definition at line 90 of file AlignWrapper.cpp.

References ElementBase::getGeometry(), and itsElement.

Here is the call graph for this function:

ElementBase::ElementBase::ElementType AlignWrapper::getType ( ) const

overridevirtual

Get element type std::string.

Implements ElementBase.

Definition at line 95 of file AlignWrapper.cpp.

References ElementBase::getType(), and itsElement.

Here is the call graph for this function:

ElementBase * AlignWrapper::makeAlignWrapper ( )

overridevirtual

Disallow misalignment of an already misaligned object.

Reimplemented from ElementBase.

Definition at line 105 of file AlignWrapper.cpp.

ElementBase * AlignWrapper::makeFieldWrapper ( )

overridevirtual

Allow field errors.

Reimplemented from ElementBase.

Definition at line 110 of file AlignWrapper.cpp.

References ElementBase::getName(), itsElement, ElementBase::makeFieldWrapper(), and ElementBase::setName().

Here is the call graph for this function:

void AlignWrapper::makeSharable ( )

overridevirtual

Set sharable flag.

Reimplemented from ElementBase.

Definition at line 49 of file AlignWrapper.cpp.

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

Here is the call graph for this function:

Euclid3D & AlignWrapper::offset ( ) const

Return the offset.

Definition at line 100 of file AlignWrapper.cpp.

References itsOffset.

Referenced by OpalElement::fillRegisteredAttributes(), Tracker::visitAlignWrapper(), Mapper::visitAlignWrapper(), OrbitTracker::visitAlignWrapper(), LinearMapper::visitAlignWrapper(), and TransportMapper::visitAlignWrapper().

void AlignWrapper::operator= ( const AlignWrapper & )

private

ElementBase * AlignWrapper::removeAlignWrapper ( )

overridevirtual

Remove AlignWrapper.

Reimplemented from ElementBase.

Definition at line 117 of file AlignWrapper.cpp.

References itsElement.

const ElementBase * AlignWrapper::removeAlignWrapper ( ) const

overridevirtual

Remove AlignWrapper.

Reimplemented from ElementBase.

Definition at line 122 of file AlignWrapper.cpp.

References itsElement.

ElementBase * AlignWrapper::removeFieldWrapper ( )

overridevirtual

Remove field wrapper.

Reimplemented from ElementBase.

Definition at line 127 of file AlignWrapper.cpp.

References AlignWrapper(), itsElement, and ElementBase::removeFieldWrapper().

Here is the call graph for this function:

const ElementBase * AlignWrapper::removeFieldWrapper ( ) const

overridevirtual

Remove field wrapper.

Reimplemented from ElementBase.

Definition at line 132 of file AlignWrapper.cpp.

References AlignWrapper(), itsElement, and ElementBase::removeFieldWrapper().

Here is the call graph for this function:

ElementBase * AlignWrapper::removeWrappers ( )

overridevirtual

Return the design element.

Reimplemented from ElementBase.

Definition at line 137 of file AlignWrapper.cpp.

References itsElement, and ElementBase::removeWrappers().

Here is the call graph for this function:

const ElementBase * AlignWrapper::removeWrappers ( ) const

overridevirtual

Return the design element.

Reimplemented from ElementBase.

Definition at line 142 of file AlignWrapper.cpp.

References itsElement, and ElementBase::removeWrappers().

Here is the call graph for this function:

void AlignWrapper::setElement ( ElementBase * elem )

Replace the contained element.

Definition at line 80 of file AlignWrapper.cpp.

References itsElement.

Friends And Related Function Documentation

friend class ElementBase

friend

Definition at line 41 of file AlignWrapper.h.

Member Data Documentation

Pointer<ElementBase> AlignWrapper::itsElement

private

Definition at line 151 of file AlignWrapper.h.

Referenced by copyStructure(), getElement(), getEntranceTransform(), getExitTransform(), getGeometry(), getType(), makeFieldWrapper(), makeSharable(), removeAlignWrapper(), removeFieldWrapper(), removeWrappers(), and setElement().

Euclid3D AlignWrapper::itsOffset

mutableprivate

Definition at line 158 of file AlignWrapper.h.

Referenced by getEntranceTransform(), getExitTransform(), and offset().

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

src/Classic/AbsBeamline/AlignWrapper.h
src/Classic/AbsBeamline/AlignWrapper.cpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation