An abstract sequence of beam line components. More...
#include <Beamline.h>
Inheritance diagram for Beamline:
Collaboration diagram for Beamline:
Public Member Functions | |
| Beamline (const std::string &name) | |
| Constructor with given name. More... | |
| Beamline () | |
| Beamline (const Beamline &) | |
| virtual | ~Beamline () |
| virtual void | iterate (BeamlineVisitor &, bool reverse) const =0 |
| Apply visitor to all elements of the line. More... | |
| virtual Vector_t | getOrigin3D () const |
| virtual Quaternion | getInitialDirection () const |
| virtual bool | getRelativeFlag () const |
 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... | |
| virtual ElementType | getType () const =0 |
| Get element type std::string. More... | |
| std::string | getTypeString () const |
| virtual BGeometryBase & | getGeometry ()=0 |
| Get geometry. More... | |
| virtual const BGeometryBase & | getGeometry () const =0 |
| Get geometry. More... | |
| 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 void | accept (BeamlineVisitor &visitor) const =0 |
| Apply visitor. More... | |
| virtual ElementBase * | clone () const =0 |
| Return clone. More... | |
| virtual ElementBase * | copyStructure () |
| Make a structural copy. More... | |
| bool | isSharable () const |
| Test if the element can be shared. More... | |
| virtual void | makeSharable () |
| Set sharable flag. 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 |
| 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 &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. More... | |
| double | getRotationAboutZ () const |
| virtual BoundingBox | getBoundingBoxInLabCoords () const |
| virtual int | getRequiredNumberOfTimeSteps () const |
| void | setOutputFN (std::string fn) |
| Set output filename. More... | |
| std::string | getOutputFN () const |
| Get output filename. More... | |
| void | setFlagDeleteOnTransverseExit (bool=true) |
| bool | getFlagDeleteOnTransverseExit () 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 | |
| void | operator= (const Beamline &) |
Additional Inherited Members | |
| 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) 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
An abstract sequence of beam line components.
Definition at line 34 of file Beamline.h.
Constructor & Destructor Documentation
◆ Beamline() [1/3]
|
explicit |
Constructor with given name.
Definition at line 40 of file Beamline.cpp.
References ElementBase::shareFlag.
◆ Beamline() [2/3]
| Beamline::Beamline | ( | ) |
Definition at line 28 of file Beamline.cpp.
References ElementBase::shareFlag.
◆ Beamline() [3/3]
| Beamline::Beamline | ( | const Beamline & | ) |
Definition at line 34 of file Beamline.cpp.
References ElementBase::shareFlag.
◆ ~Beamline()
|
virtual |
Definition at line 46 of file Beamline.cpp.
Member Function Documentation
◆ getInitialDirection()
|
virtual |
Reimplemented in TBeamline< T >.
Definition at line 53 of file Beamline.cpp.
Referenced by ThickTracker::ThickTracker().
◆ getOrigin3D()
|
virtual |
Reimplemented in TBeamline< T >.
Definition at line 49 of file Beamline.cpp.
Referenced by ThickTracker::ThickTracker().
◆ getRelativeFlag()
|
virtual |
Reimplemented in TBeamline< T >.
Definition at line 57 of file Beamline.cpp.
◆ iterate()
|
pure virtual |
Apply visitor to all elements of the line.
Implemented in TBeamline< T >.
Referenced by SpecificElementVisitor< ELEM >::SpecificElementVisitor(), SpecificElementVisitor< ELEM >::visitBeamline(), and DefaultVisitor::visitBeamline().
◆ operator=()
|
private |
The documentation for this class was generated from the following files:
- /Users/gsell/src/OPAL/src/src/Classic/Beamlines/Beamline.h
- /Users/gsell/src/OPAL/src/src/Classic/Beamlines/Beamline.cpp
