#include <TBeamline.h>

Inheritance diagram for TBeamline< T >:

Collaboration diagram for TBeamline< T >:

Public Member Functions
	TBeamline ()
	Default constructor.
	TBeamline (const std::string &name)
	Constructor with given name.
	TBeamline (const TBeamline< T > &right)
virtual	~TBeamline ()
virtual void	accept (BeamlineVisitor &) const
	Apply BeamlineVisitor to this line.
virtual void	iterate (BeamlineVisitor &, bool r2l) const
	Apply visitor to all elements of the line.
virtual TBeamline< T > *	clone () const
	Make clone.
virtual TBeamline< T > *	copyStructure ()
	Make structure copy.
virtual void	makeSharable ()
	Set sharable flag.
virtual BeamlineGeometry &	getGeometry ()
	Get geometry.
virtual const BeamlineGeometry &	getGeometry () const
	Get geometry.
virtual double	getArcLength () const
	Get arc length.
virtual double	getElementLength () const
	Get design length.
virtual double	getOrigin () const
	Get origin position.
virtual double	getEntrance () const
	Get entrance position.
virtual double	getExit () const
	Get exit position.
virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform.
virtual Euclid3D	getTransform (double s) const
	Get transform.
virtual Euclid3D	getTotalTransform () const
	Get transform.
virtual Euclid3D	getEntranceFrame () const
	Get transform.
virtual Euclid3D	getExitFrame () const
	Get transform.
virtual ElementType	getType () const
	Get beamline type.
virtual void	append (const T &)
	Append a T object.
virtual void	prepend (const T &)
	Prepend a T object.
void	setOrigin3D (const Vector_t< double, 3 > &ori)
Vector_t< double, 3 >	getOrigin3D () const
void	setInitialDirection (const Quaternion &rot)
Quaternion	getInitialDirection () const
void	setRelativeFlag (bool flag)
bool	getRelativeFlag () const
size_t	size () const
	Get the number of elements in the TBeamline.
virtual const std::string &	getName () const
	Get element name.
virtual void	setName (const std::string &name)
	Set element name.
std::string	getTypeString () const
virtual void	setElementLength (double length)
	Set design length.
virtual void	getElementDimensions (double &begin, double &end) const
virtual Euclid3D	getEntrancePatch () const
	Get patch.
virtual Euclid3D	getExitPatch () const
	Get patch.
virtual double	getAttribute (const std::string &aKey) const
	Get attribute value.
virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute.
virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute.
virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute.
virtual Channel *	getChannel (const std::string &aKey, bool create=false)
	Construct a read/write channel.
virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel.
bool	isSharable () const
	Test if the element can be shared.
bool	update (const AttributeSet &)
	Update element.
virtual void	setBoundaryGeometry (BoundaryGeometry *geo)
virtual BoundaryGeometry *	getBoundaryGeometry () const
	return the attached boundary geometrt object if there is any
virtual bool	hasBoundaryGeometry () const
virtual void	setWake (WakeFunction *wf)
	attach a wake field to the element
virtual WakeFunction *	getWake () const
	return the attached wake object if there is any
virtual bool	hasWake () const
virtual void	setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)
virtual ParticleMatterInteractionHandler *	getParticleMatterInteraction () const
virtual bool	hasParticleMatterInteraction () const
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< ApertureType, std::vector< double > >	getAperture () const
virtual bool	isInside (const Vector_t< double, 3 > &r) const
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.
double	getRotationAboutZ () const
virtual BoundingBox	getBoundingBoxInLabCoords () const
virtual int	getRequiredNumberOfTimeSteps () const
void	setOutputFN (std::string fn)
	Set output filename.
std::string	getOutputFN () const
	Get output filename.
void	setFlagDeleteOnTransverseExit (bool=true)
bool	getFlagDeleteOnTransverseExit () const
int	addReference () const
	Increment reference count.
int	removeReference () const
	Decrement the reference count.
bool	isShared () const
	Test for sharing.

void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute.
double	getElementPosition () const
bool	isElementPositionSet () const

Static Public Member Functions
static std::string	getTypeString (ElementType type)

Public Attributes
T	elements
	STL member.

Protected Member Functions
bool	isInsideTransverse (const Vector_t< double, 3 > &r) const

Protected Attributes
BeamlineGeometry	itsGeometry
	The beamline geometry.
Vector_t< double, 3 >	itsOrigin_m
Quaternion	itsCoordTrafoTo_m
bool	relativePositions_m
bool	shareFlag
CoordinateSystemTrafo	csTrafoGlobal2Local_m
CoordinateSystemTrafo	misalignment_m
std::pair< ApertureType, std::vector< double > >	aperture_m
double	elementEdge_m
double	rotationZAxis_m

Private Attributes
std::string	elementID
AttributeSet	userAttribs
WakeFunction *	wake_m
BoundaryGeometry *	bgeometry_m
ParticleMatterInteractionHandler *	parmatint_m
bool	positionIsFixed
std::queue< std::pair< double, double > >	actionRange_m
std::string	outputfn_m
bool	deleteOnTransverseExit_m = true
int	refCount

double	elementPosition_m
	ELEMEDGE attribute.
bool	elemedgeSet_m

Static Private Attributes
static const std::map< ElementType, std::string >	elementTypeToString_s

Detailed Description

template<class T>
class TBeamline< T >

Definition at line 33 of file TBeamline.h.

Constructor & Destructor Documentation

◆ TBeamline() [1/3]

template<class T>

TBeamline< T >::TBeamline ( )

Default constructor.

Definition at line 158 of file TBeamline.h.

References Beamline::Beamline(), itsCoordTrafoTo_m, itsGeometry, itsOrigin_m, and relativePositions_m.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TBeamline() [2/3]

template<class T>

TBeamline< T >::TBeamline ( const std::string & name )

explicit

Constructor with given name.

Definition at line 168 of file TBeamline.h.

References Beamline::Beamline(), itsCoordTrafoTo_m, itsGeometry, itsOrigin_m, and relativePositions_m.

Here is the call graph for this function:

◆ TBeamline() [3/3]

template<class T>

TBeamline< T >::TBeamline ( const TBeamline< T > & right )

Definition at line 178 of file TBeamline.h.

References Beamline::Beamline(), itsCoordTrafoTo_m, itsGeometry, itsOrigin_m, relativePositions_m, and TBeamline().

Here is the call graph for this function:

◆ ~TBeamline()

template<class T>

TBeamline< T >::~TBeamline ( )

virtual

Definition at line 188 of file TBeamline.h.

Member Function Documentation

◆ accept()

template<class T>

void TBeamline< T >::accept ( BeamlineVisitor & visitor ) const

virtual

Apply BeamlineVisitor to this line.

Implements ElementBase.

Definition at line 192 of file TBeamline.h.

References BeamlineVisitor::visitBeamline().

Here is the call graph for this function:

◆ addReference()

int RCObject::addReference ( ) const

inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References refCount.

Referenced by Pointer< Object >::operator=(), Pointer< Object >::operator=(), and Pointer< Object >::unique().

Here is the caller graph for this function:

◆ append()

template<class T>

void TBeamline< T >::append ( const T & obj )

inlinevirtual

Append a T object.

Definition at line 388 of file TBeamline.h.

Referenced by clone(), and copyStructure().

Here is the caller graph for this function:

◆ clone()

template<class T>

TBeamline< T > * TBeamline< T >::clone ( ) const

virtual

Make clone.

Implements ElementBase.

Definition at line 211 of file TBeamline.h.

References append(), begin(), end(), ElementBase::getName(), itsCoordTrafoTo_m, itsOrigin_m, relativePositions_m, and TBeamline().

Here is the call graph for this function:

◆ copyStructure()

template<class T>

TBeamline< T > * TBeamline< T >::copyStructure ( )

virtual

Make structure copy.

Reimplemented from ElementBase.

Definition at line 230 of file TBeamline.h.

References append(), begin(), end(), ElementBase::getName(), ElementBase::isSharable(), itsCoordTrafoTo_m, itsOrigin_m, relativePositions_m, and TBeamline().

Here is the call graph for this function:

◆ fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 521 of file ElementBase.h.

References positionIsFixed.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ getAperture()

std::pair< ApertureType, std::vector< double > > ElementBase::getAperture ( ) const

inlineinherited

Definition at line 500 of file ElementBase.h.

References aperture_m.

Referenced by MeshGenerator::add(), and Offset::operator=().

Here is the caller graph for this function:

◆ getArcLength()

template<class T>

double TBeamline< T >::getArcLength ( ) const

virtual

Get arc length.

Reimplemented from ElementBase.

Definition at line 273 of file TBeamline.h.

References begin(), and end().

Referenced by getExit(), and getOrigin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttribute()

double ElementBase::getAttribute ( const std::string & aKey ) const

virtualinherited

Get attribute value.

Definition at line 153 of file ElementBase.cpp.

References getConstChannel().

Here is the call graph for this function:

◆ getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtualinherited

return the attached boundary geometrt object if there is any

Definition at line 456 of file ElementBase.h.

References bgeometry_m.

◆ getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtualinherited

Definition at line 272 of file ElementBase.cpp.

References csTrafoGlobal2Local_m, getEdgeToBegin(), and getEdgeToEnd().

Here is the call graph for this function:

◆ getChannel()

Channel * ElementBase::getChannel	(	const std::string &	aKey,
		bool	create = false )

virtualinherited

Construct a read/write channel.

Reimplemented in DriftRep, MonitorRep, MultipoleRep, ProbeRep, RFCavityRep, SolenoidRep, and TravelingWaveRep.

Definition at line 190 of file ElementBase.cpp.

References userAttribs.

Referenced by DriftRep::getChannel(), MonitorRep::getChannel(), MultipoleRep::getChannel(), ProbeRep::getChannel(), RFCavityRep::getChannel(), SolenoidRep::getChannel(), TravelingWaveRep::getChannel(), getConstChannel(), and setAttribute().

Here is the caller graph for this function:

◆ getConstChannel()

const ConstChannel * ElementBase::getConstChannel ( const std::string & aKey ) const

virtualinherited

Construct a read-only channel.

Definition at line 194 of file ElementBase.cpp.

References ElementBase(), and getChannel().

Referenced by getAttribute(), and hasAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 479 of file ElementBase.h.

References csTrafoGlobal2Local_m.

Referenced by MeshGenerator::add().

Here is the caller graph for this function:

◆ getEdgeToBegin()

CoordinateSystemTrafo ElementBase::getEdgeToBegin ( ) const

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 483 of file ElementBase.h.

Referenced by getBoundingBoxInLabCoords(), and TBeamline< FlaggedElmPtr >::getConstChannel().

Here is the caller graph for this function:

◆ getEdgeToEnd()

CoordinateSystemTrafo ElementBase::getEdgeToEnd ( ) const

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 488 of file ElementBase.h.

References getElementLength().

Referenced by getBoundingBoxInLabCoords().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElementDimensions()

virtual void ElementBase::getElementDimensions	(	double &	begin,
		double &	end ) const

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 159 of file ElementBase.h.

References begin(), end(), and getElementLength().

Referenced by MeshGenerator::add().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElementLength()

template<class T>

double TBeamline< T >::getElementLength ( ) const

virtual

Get design length.

Reimplemented from ElementBase.

Definition at line 284 of file TBeamline.h.

References begin(), and end().

Here is the call graph for this function:

◆ getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 553 of file ElementBase.h.

References elemedgeSet_m, elementPosition_m, and getName().

Here is the call graph for this function:

◆ getEntrance()

template<class T>

double TBeamline< T >::getEntrance ( ) const

virtual

Get entrance position.

Reimplemented from ElementBase.

Definition at line 300 of file TBeamline.h.

References getOrigin().

Referenced by getEntranceFrame(), and getTransform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEntranceFrame()

template<class T>

Euclid3D TBeamline< T >::getEntranceFrame ( ) const

virtual

Get transform.

Reimplemented from ElementBase.

Definition at line 373 of file TBeamline.h.

References getEntrance(), and getTransform().

Here is the call graph for this function:

◆ getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 436 of file ElementBase.h.

References BGeometryBase::getEntrancePatch(), and getGeometry().

Here is the call graph for this function:

◆ getExit()

template<class T>

double TBeamline< T >::getExit ( ) const

virtual

Get exit position.

Reimplemented from ElementBase.

Definition at line 305 of file TBeamline.h.

References getArcLength().

Referenced by getExitFrame(), and getTransform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExitFrame()

template<class T>

Euclid3D TBeamline< T >::getExitFrame ( ) const

virtual

Get transform.

Reimplemented from ElementBase.

Definition at line 378 of file TBeamline.h.

References getExit(), and getTransform().

Here is the call graph for this function:

◆ getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 440 of file ElementBase.h.

References BGeometryBase::getExitPatch(), and getGeometry().

Here is the call graph for this function:

◆ getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 574 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by Corrector::apply(), Multipole::apply(), Multipole::apply(), MultipoleT::apply(), MultipoleTBase::apply(), RFCavity::apply(), Solenoid::apply(), and TravelingWave::apply().

Here is the caller graph for this function:

◆ getGeometry() [1/2]

template<class T>

BeamlineGeometry & TBeamline< T >::getGeometry ( )

inlinevirtual

Get geometry.

Implements ElementBase.

Definition at line 263 of file TBeamline.h.

References itsGeometry.

◆ getGeometry() [2/2]

template<class T>

const BeamlineGeometry & TBeamline< T >::getGeometry ( ) const

inlinevirtual

Get geometry.

Implements ElementBase.

Definition at line 268 of file TBeamline.h.

References itsGeometry.

◆ getInitialDirection()

template<class T>

Quaternion TBeamline< T >::getInitialDirection ( ) const

inlinevirtual

Reimplemented from Beamline.

Definition at line 413 of file TBeamline.h.

References itsCoordTrafoTo_m.

Referenced by ParallelTracker::visitBeamline().

Here is the caller graph for this function:

◆ getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 513 of file ElementBase.h.

References misalignment_m.

◆ getMisalignment() [2/2]

void ElementBase::getMisalignment	(	double &	x,
		double &	y,
		double &	s ) const

inherited

◆ getName()

const std::string & ElementBase::getName ( ) const

virtualinherited

Get element name.

Definition at line 132 of file ElementBase.cpp.

Referenced by Ring::appendElement(), Ring::apply(), TBeamline< T >::clone(), TBeamline< T >::copyStructure(), Probe::doGoOffline(), PlaceRep::enter(), getElementPosition(), RFCavity::getMomentaKick(), getOutputFN(), CavityAutophaser::getPhaseAtMaxEnergy(), Selector::handleElement(), RFCavity::initialise(), Ring::initialise(), Solenoid::initialise(), PlaceRep::leave(), Offset::Offset(), operator<<(), Offset::operator=(), operator==(), Sequence::print(), Ring::Ring(), ClassicField::SortAsc(), Component::trackBunch(), Component::trackMap(), Sequence::updateList(), ParallelTracker::updateRFElement(), and Replacer::visitFlaggedElmPtr().

Here is the caller graph for this function:

◆ getOrigin()

template<class T>

double TBeamline< T >::getOrigin ( ) const

virtual

Get origin position.

Reimplemented from ElementBase.

Definition at line 295 of file TBeamline.h.

References getArcLength().

Referenced by getEntrance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOrigin3D()

template<class T>

Vector_t< double, 3 > TBeamline< T >::getOrigin3D ( ) const

inlinevirtual

Reimplemented from Beamline.

Definition at line 403 of file TBeamline.h.

References itsOrigin_m.

Referenced by ParallelTracker::visitBeamline().

Here is the caller graph for this function:

◆ getOutputFN()

std::string ElementBase::getOutputFN ( ) const

inherited

Get output filename.

Definition at line 144 of file ElementBase.cpp.

References getName(), and outputfn_m.

Referenced by Probe::doInitialise(), Monitor::initialise(), and PluginElement::initialise().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 464 of file ElementBase.h.

References parmatint_m.

◆ getRelativeFlag()

template<class T>

bool TBeamline< T >::getRelativeFlag ( ) const

inlinevirtual

Reimplemented from Beamline.

Definition at line 423 of file TBeamline.h.

References relativePositions_m.

Referenced by ParallelTracker::visitBeamline().

Here is the caller graph for this function:

◆ getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

Reimplemented in Drift, Marker, and Monitor.

Definition at line 566 of file ElementBase.h.

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 540 of file ElementBase.h.

References rotationZAxis_m.

◆ getTotalTransform()

template<class T>

Euclid3D TBeamline< T >::getTotalTransform ( ) const

virtual

Get transform.

Reimplemented from ElementBase.

Definition at line 357 of file TBeamline.h.

References begin(), Euclid3D::dotBy(), and end().

Here is the call graph for this function:

◆ getTransform() [1/2]

template<class T>

Euclid3D TBeamline< T >::getTransform	(	double	fromS,
		double	toS ) const

virtual

Get transform.

Reimplemented from ElementBase.

Definition at line 310 of file TBeamline.h.

References begin(), ElementBase::ElementBase(), end(), ElementBase::getArcLength(), getEntrance(), getExit(), and ElementBase::getTransform().

Referenced by getEntranceFrame(), getExitFrame(), and getTransform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTransform() [2/2]

template<class T>

Euclid3D TBeamline< T >::getTransform ( double s ) const

virtual

Get transform.

Reimplemented from ElementBase.

Definition at line 368 of file TBeamline.h.

References getTransform().

Here is the call graph for this function:

◆ getType()

template<class T>

ElementType TBeamline< T >::getType ( ) const

inlinevirtual

Get beamline type.

Implements ElementBase.

Definition at line 383 of file TBeamline.h.

References BEAMLINE.

◆ getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inlineinherited

Definition at line 544 of file ElementBase.h.

References getType(), and getTypeString().

Referenced by getTypeString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTypeString() [2/2]

std::string ElementBase::getTypeString ( ElementType type )

staticinherited

Definition at line 200 of file ElementBase.cpp.

References elementTypeToString_s.

◆ getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtualinherited

return the attached wake object if there is any

Definition at line 448 of file ElementBase.h.

References wake_m.

◆ hasAttribute()

bool ElementBase::hasAttribute ( const std::string & aKey ) const

virtualinherited

Test for existence of an attribute.

Definition at line 165 of file ElementBase.cpp.

References getConstChannel().

Here is the call graph for this function:

◆ hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 460 of file ElementBase.h.

References bgeometry_m.

◆ hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 468 of file ElementBase.h.

References parmatint_m.

◆ hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 452 of file ElementBase.h.

References wake_m.

◆ isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 562 of file ElementBase.h.

References elemedgeSet_m.

◆ isInside()

bool ElementBase::isInside ( const Vector_t< double, 3 > & r ) const

inlinevirtualinherited

Reimplemented in Monitor, Multipole, RFCavity, Solenoid, and TravelingWave.

Definition at line 504 of file ElementBase.h.

References getElementLength(), and isInsideTransverse().

Here is the call graph for this function:

◆ isInsideTransverse()

bool ElementBase::isInsideTransverse ( const Vector_t< double, 3 > & r ) const

protectedinherited

Definition at line 245 of file ElementBase.cpp.

References aperture_m.

Referenced by Component::apply(), Corrector::apply(), Multipole::apply(), Multipole::apply(), Component::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), isInside(), Monitor::isInside(), Multipole::isInside(), RFCavity::isInside(), Solenoid::isInside(), and TravelingWave::isInside().

Here is the caller graph for this function:

◆ isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 525 of file ElementBase.h.

References positionIsFixed.

◆ isSharable()

bool ElementBase::isSharable ( ) const

inlineinherited

Test if the element can be shared.

Definition at line 444 of file ElementBase.h.

References shareFlag.

Referenced by copyStructure(), TBeamline< T >::copyStructure(), and Sequence::updateList().

Here is the caller graph for this function:

◆ isShared()

bool RCObject::isShared ( ) const

inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References refCount.

◆ iterate()

template<class T>

void TBeamline< T >::iterate	(	BeamlineVisitor &	visitor,
		bool	r2l ) const

virtual

Apply visitor to all elements of the line.

Implements Beamline.

Definition at line 197 of file TBeamline.h.

References begin(), and end().

Referenced by ParallelTracker::visitBeamline().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeSharable()

template<class T>

void TBeamline< T >::makeSharable ( )

inlinevirtual

Set sharable flag.

Reimplemented from ElementBase.

Definition at line 254 of file TBeamline.h.

References begin(), end(), and ElementBase::shareFlag.

Here is the call graph for this function:

◆ prepend()

template<class T>

void TBeamline< T >::prepend ( const T & obj )

inlinevirtual

Prepend a T object.

Definition at line 393 of file TBeamline.h.

◆ releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 517 of file ElementBase.h.

References positionIsFixed.

◆ removeAttribute()

void ElementBase::removeAttribute ( const std::string & aKey )

virtualinherited

Remove an existing attribute.

Definition at line 176 of file ElementBase.cpp.

References userAttribs.

◆ removeReference()

int RCObject::removeReference ( ) const

inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References refCount.

◆ setActionRange()

void ElementBase::setActionRange ( const std::queue< std::pair< double, double > > & range )

inlineinherited

Definition at line 529 of file ElementBase.h.

References actionRange_m, and elementEdge_m.

◆ setAperture()

void ElementBase::setAperture	(	const ApertureType &	type,
		const std::vector< double > &	args )

inlineinherited

Definition at line 495 of file ElementBase.h.

References aperture_m.

Referenced by Component::Component(), Offset::operator=(), and OpalElement::update().

Here is the caller graph for this function:

◆ setAttribute()

void ElementBase::setAttribute	(	const std::string &	aKey,
		double	val )

virtualinherited

Set value of an attribute.

Definition at line 180 of file ElementBase.cpp.

References getChannel(), and Channel::isSettable().

Referenced by update(), and OpalElement::updateUnknown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry * geo )

virtualinherited

attach a boundary geometry field to the element

Definition at line 228 of file ElementBase.cpp.

References bgeometry_m.

◆ setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo & ori )

inlineinherited

Definition at line 472 of file ElementBase.h.

References csTrafoGlobal2Local_m, and positionIsFixed.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 236 of file ElementBase.cpp.

◆ setElementLength()

void ElementBase::setElementLength ( double length )

inlinevirtualinherited

Set design length.

Definition at line 400 of file ElementBase.h.

References getGeometry(), and BGeometryBase::setElementLength().

Referenced by RFCavity::initialise(), Solenoid::initialise(), TravelingWave::initialise(), SequenceMember::setLength(), OpalCavity::update(), OpalMonitor::update(), OpalMultipole::update(), OpalMultipoleT::update(), OpalProbe::update(), OpalSolenoid::update(), and OpalTravelingWave::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setElementPosition()

void ElementBase::setElementPosition ( double elemedge )

inlineinherited

Access to ELEMEDGE attribute.

Definition at line 548 of file ElementBase.h.

References elemedgeSet_m, and elementPosition_m.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 570 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ setInitialDirection()

template<class T>

void TBeamline< T >::setInitialDirection ( const Quaternion & rot )

inline

Definition at line 408 of file TBeamline.h.

References itsCoordTrafoTo_m.

Referenced by Line::parse().

Here is the caller graph for this function:

◆ setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inlineinherited

Definition at line 509 of file ElementBase.h.

References misalignment_m.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ setName()

void ElementBase::setName ( const std::string & name )

virtualinherited

Set element name.

Definition at line 136 of file ElementBase.cpp.

References elementID.

Referenced by Sequence::insertDrifts(), Offset::Offset(), and Offset::operator=().

Here is the caller graph for this function:

◆ setOrigin3D()

template<class T>

void TBeamline< T >::setOrigin3D ( const Vector_t< double, 3 > & ori )

inline

Definition at line 398 of file TBeamline.h.

References itsOrigin_m.

Referenced by Line::parse().

Here is the caller graph for this function:

◆ setOutputFN()

void ElementBase::setOutputFN ( std::string fn )

inherited

Set output filename.

Definition at line 140 of file ElementBase.cpp.

References outputfn_m.

Referenced by OpalMonitor::update(), and OpalProbe::update().

Here is the caller graph for this function:

◆ setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler * spys )

virtualinherited

Definition at line 232 of file ElementBase.cpp.

◆ setRelativeFlag()

template<class T>

void TBeamline< T >::setRelativeFlag ( bool flag )

inline

Definition at line 418 of file TBeamline.h.

References relativePositions_m.

Referenced by Line::parse().

Here is the caller graph for this function:

◆ setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 536 of file ElementBase.h.

References rotationZAxis_m.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ setWake()

void ElementBase::setWake ( WakeFunction * wf )

virtualinherited

attach a wake field to the element

Definition at line 224 of file ElementBase.cpp.

References wake_m.

◆ size()

template<class T>

size_t TBeamline< T >::size ( ) const

Get the number of elements in the TBeamline.

Definition at line 428 of file TBeamline.h.

References begin(), and end().

Here is the call graph for this function:

◆ update()

bool ElementBase::update ( const AttributeSet & set )

inherited

Update element.

Definition at line 216 of file ElementBase.cpp.

References AttributeSet::begin(), AttributeSet::end(), and setAttribute().

Here is the call graph for this function:

Member Data Documentation

◆ actionRange_m

std::queue<std::pair<double, double> > ElementBase::actionRange_m

privateinherited

Definition at line 382 of file ElementBase.h.

Referenced by setActionRange().

◆ aperture_m

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

protectedinherited

Definition at line 353 of file ElementBase.h.

Referenced by ElementBase(), getAperture(), isInsideTransverse(), and setAperture().

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 373 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), getBoundaryGeometry(), hasBoundaryGeometry(), and setBoundaryGeometry().

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 350 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), getBoundingBoxInLabCoords(), getCSTrafoGlobal2Local(), and setCSTrafoGlobal2Local().

◆ deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 386 of file ElementBase.h.

Referenced by ElementBase(), getFlagDeleteOnTransverseExit(), and setFlagDeleteOnTransverseExit().

◆ elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 380 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), getElementPosition(), isElementPositionSet(), and setElementPosition().

◆ elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 355 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), and setActionRange().

◆ elementID

std::string ElementBase::elementID

privateinherited

Definition at line 364 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), and setName().

◆ elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 379 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), getElementPosition(), and setElementPosition().

◆ elements

T std::list< T >::elements

inherited

STL member.

◆ elementTypeToString_s

const std::map< ElementType, std::string > ElementBase::elementTypeToString_s

staticprivateinherited

Initial value:

= {
    {ElementType::ANY, "Any"},
    {ElementType::BEAMLINE, "Beamline"},
    {ElementType::DRIFT, "Drift"},
    {ElementType::MARKER, "Marker"},
    {ElementType::MULTIPOLE, "Multipole"},
    {ElementType::RFCAVITY, "RFCavity"},
    {ElementType::TRAVELINGWAVE, "TravelingWave"},
    {ElementType::SBEND, "SBEND"},
    {ElementType::RBEND, "RBEND"},
    {ElementType::RBEND3D, "RBEND3D"},
    {ElementType::RING, "Ring"},
    {ElementType::SOURCE, "SOURCE"},
    {ElementType::SOLENOID, "SOLENOID"},
    {ElementType::PROBE, "Probe"},
    {ElementType::VACUUM, "Vacuum"}}

Definition at line 69 of file ElementBase.h.

Referenced by getTypeString().

◆ itsCoordTrafoTo_m

template<class T>

Quaternion TBeamline< T >::itsCoordTrafoTo_m

protected

Definition at line 150 of file TBeamline.h.

Referenced by clone(), copyStructure(), getInitialDirection(), setInitialDirection(), TBeamline(), TBeamline(), and TBeamline().

◆ itsGeometry

template<class T>

BeamlineGeometry TBeamline< T >::itsGeometry

protected

The beamline geometry.

Definition at line 147 of file TBeamline.h.

Referenced by getGeometry(), getGeometry(), TBeamline(), TBeamline(), and TBeamline().

◆ itsOrigin_m

template<class T>

Vector_t<double, 3> TBeamline< T >::itsOrigin_m

protected

Definition at line 149 of file TBeamline.h.

Referenced by clone(), copyStructure(), getOrigin3D(), setOrigin3D(), TBeamline(), TBeamline(), and TBeamline().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 351 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), getMisalignment(), and setMisalignment().

◆ outputfn_m

std::string ElementBase::outputfn_m

privateinherited

The name of the outputfile

Definition at line 384 of file ElementBase.h.

Referenced by ElementBase(), getOutputFN(), and setOutputFN().

◆ parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 375 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), getParticleMatterInteraction(), and hasParticleMatterInteraction().

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 377 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), fixPosition(), isPositioned(), releasePosition(), and setCSTrafoGlobal2Local().

◆ refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

Referenced by addReference(), isShared(), RCObject(), RCObject(), and removeReference().

◆ relativePositions_m

template<class T>

bool TBeamline< T >::relativePositions_m

protected

Definition at line 151 of file TBeamline.h.

Referenced by clone(), copyStructure(), getRelativeFlag(), setRelativeFlag(), TBeamline(), TBeamline(), and TBeamline().

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 357 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), getRotationAboutZ(), and setRotationAboutZ().

◆ shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 348 of file ElementBase.h.

Referenced by Beamline::Beamline(), Beamline::Beamline(), Beamline::Beamline(), ElementBase(), ElementBase(), isSharable(), makeSharable(), and TBeamline< T >::makeSharable().

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 369 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), getChannel(), and removeAttribute().

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 371 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), getWake(), hasWake(), and setWake().

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

TBeamline.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TBeamline() [1/3]

◆ TBeamline() [2/3]

◆ TBeamline() [3/3]

◆ ~TBeamline()

Member Function Documentation

◆ accept()

◆ addReference()

◆ append()

◆ clone()

◆ copyStructure()

◆ fixPosition()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getChannel()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEntrance()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getFlagDeleteOnTransverseExit()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getInitialDirection()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getOrigin()

◆ getOrigin3D()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getRelativeFlag()

◆ getRequiredNumberOfTimeSteps()

◆ getRotationAboutZ()

◆ getTotalTransform()

◆ getTransform() [1/2]

◆ getTransform() [2/2]

◆ getType()

◆ getTypeString() [1/2]

◆ getTypeString() [2/2]

◆ getWake()

◆ hasAttribute()

◆ hasBoundaryGeometry()

◆ hasParticleMatterInteraction()

◆ hasWake()

◆ isElementPositionSet()

◆ isInside()

◆ isInsideTransverse()

◆ isPositioned()

◆ isSharable()

◆ isShared()

◆ iterate()

◆ makeSharable()

◆ prepend()

◆ releasePosition()

◆ removeAttribute()

◆ removeReference()

◆ setActionRange()

◆ setAperture()

◆ setAttribute()

◆ setBoundaryGeometry()