The base class for all OPAL beam lines and sequences. More...
#include <BeamSequence.h>
Inheritance diagram for BeamSequence:
Collaboration diagram for BeamSequence:
Public Member Functions | |
| virtual | ~BeamSequence () |
| virtual BeamSequence * | copy (const std::string &name)=0 |
| Make complete copy. More... | |
| virtual const std::string | getCategory () const |
| Return the object category as a string. More... | |
| virtual Beamline * | fetchLine () const =0 |
| Return the embedded CLASSIC beam line. More... | |
 Public Member Functions inherited from Element | |
| virtual | ~Element () |
| virtual bool | canReplaceBy (Object *object) |
| Test if replacement is allowed. More... | |
| virtual bool | shouldTrace () const |
| Trace flag. More... | |
| virtual bool | shouldUpdate () const |
| Update flag. More... | |
| virtual double | getLength () const =0 |
| Return element length. More... | |
| virtual double | getEntrance (ReferenceType) const |
| Return arc length from origin to entrance (negative !). More... | |
| virtual double | getExit (ReferenceType) const |
| Return arc length from origin to exit (positive !). More... | |
| virtual void | setShared (bool) |
| Set shared flag. More... | |
| ElementBase * | getElement () const |
| Return the embedded CLASSIC element. More... | |
| void | setElement (ElementBase *) |
| Assign new CLASSIC element. More... | |
| Public Member Functions inherited from Object | |
| virtual | ~Object () |
| virtual Object * | clone (const std::string &name)=0 |
| Return a clone. More... | |
| void | copyAttributes (const Object &) |
| Copy attributes from another object. More... | |
| virtual void | execute () |
| Execute the command. More... | |
| virtual Attribute * | findAttribute (const std::string &name) |
| Find an attribute by name. More... | |
| virtual const Attribute * | findAttribute (const std::string &name) const |
| Find an attribute by name. More... | |
| virtual Object * | makeTemplate (const std::string &, TokenStream &, Statement &) |
| Macro handler function. More... | |
| virtual Object * | makeInstance (const std::string &name, Statement &, const Parser *) |
| Macro handler function. More... | |
| virtual void | parse (Statement &) |
| Parse the object. More... | |
| virtual void | parseShortcut (Statement &) |
| Parser for single-attribute commands. More... | |
| virtual void | print (std::ostream &) const |
| Print the object. More... | |
| virtual void | printValue (std::ostream &) const |
| virtual void | printHelp (std::ostream &) const |
| Print help. More... | |
| virtual void | replace (Object *oldObject, Object *newObject) |
| Replace references. More... | |
| virtual void | update () |
| Update this object. More... | |
| bool | isBuiltin () const |
| True, if [b]this[/b] is a built-in object. More... | |
| virtual bool | isShared () const |
| Shared flag. More... | |
| void | setDirty (bool) |
| Set/reset the [b]modified[/b] flag. More... | |
| bool | isDirty () const |
| True, if the [b]modified[/b] flag is set. More... | |
| void | setFlag (bool) |
| Flag/unflag this object, e. g. to control output of objects for. More... | |
| bool | isFlagged () const |
| True, if [b]this[/b] is flagged by setFlag(true). More... | |
| const Object * | getBaseObject () const |
| Return the object's base type object. More... | |
| const std::string & | getOpalName () const |
| Return object name. More... | |
| Object * | getParent () const |
| Return parent pointer. More... | |
| bool | isTreeMember (const Object *subTree) const |
| Test for tree membership. More... | |
| void | setOpalName (const std::string &name) |
| Set object name. More... | |
| void | setParent (Object *) |
| Set parent object. More... | |
| void | clear () |
| Clear the occurrence counter. More... | |
| int | increment () |
| Increment and return the occurrence counter. More... | |
| int | occurrenceCount () |
| Return the occurrence counter. More... | |
| void | registerReference (Invalidator *a) |
| Register a reference to this object. More... | |
| void | unregisterReference (Invalidator *a) |
| Unegister a reference to this object. More... | |
| void | registerOwnership (const AttributeHandler::OwnerType &itsClass) 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... | |
Static Public Member Functions | |
| static BeamSequence * | find (const std::string &name) |
| Find a BeamSequence by name. More... | |
| Static Public Member Functions inherited from Element | |
| static Element * | find (const std::string &name) |
| Find named Element. More... | |
Protected Member Functions | |
| BeamSequence (int size, const char *name, const char *help) | |
| Constructor for exemplars. More... | |
| BeamSequence (const std::string &name, BeamSequence *parent) | |
| Constructor for clones. More... | |
| Protected Member Functions inherited from Element | |
| Element (int size, const char *name, const char *help) | |
| Constructor for exemplars. More... | |
| Element (const std::string &name, Element *parent) | |
| Constructor for clones. More... | |
| Protected Member Functions inherited from Object | |
| Object (int size, const char *name, const char *help) | |
| Constructor for exemplars. More... | |
| Object (const std::string &name, Object *parent) | |
| Constructor for clones. More... | |
| Protected Member Functions inherited from RCObject | |
| RCObject () | |
| Default constructor. More... | |
| RCObject (const RCObject &) | |
| Copy constructor. More... | |
| virtual | ~RCObject ()=0 |
| RCObject & | operator= (const RCObject &right) |
Private Member Functions | |
| BeamSequence () | |
| BeamSequence (const BeamSequence &) | |
| void | operator= (const BeamSequence &) |
Additional Inherited Members | |
| Public Types inherited from Element | |
| enum | ReferenceType { IS_ENTRY, IS_CENTRE, IS_EXIT } |
| Reference for element positioning. More... | |
| Public Attributes inherited from Object | |
| std::vector< Attribute > | itsAttr |
| The object attributes (see Attribute.hh). More... | |
| Protected Attributes inherited from Object | |
| bool | builtin |
| Built-in flag. More... | |
| bool | modified |
| Dirty flag. More... | |
| bool | flagged |
| Object flag. More... | |
Detailed Description
The base class for all OPAL beam lines and sequences.
Definition at line 32 of file BeamSequence.h.
Constructor & Destructor Documentation
|
virtual |
Definition at line 27 of file BeamSequence.cpp.
|
protected |
Constructor for exemplars.
Definition at line 47 of file BeamSequence.cpp.
|
protected |
Constructor for clones.
Definition at line 52 of file BeamSequence.cpp.
|
private |
|
private |
Member Function Documentation
|
pure virtual |
|
pure virtual |
Return the embedded CLASSIC beam line.
Implemented in Sequence, and Line.
Referenced by Distribution::createMatchedGaussDistribution(), SetIntegrator::execute(), Dynamic::execute(), Static::execute(), MakeSequence::execute(), ThreadBpm::execute(), ThreadAll::execute(), Micado::execute(), Survey::execute(), Twiss::execute(), and TrackRun::setupCyclotronTracker().
|
static |
Find a BeamSequence by name.
Definition at line 36 of file BeamSequence.cpp.
References OpalData::find(), and OpalData::getInstance().
Referenced by Distribution::createMatchedGaussDistribution(), SetIntegrator::execute(), TrackCmd::execute(), Dynamic::execute(), Static::execute(), MakeSequence::execute(), ThreadBpm::execute(), ThreadAll::execute(), Micado::execute(), Survey::execute(), and Twiss::execute().
Here is the call graph for this function:
|
virtual |
Return the object category as a string.
Reimplemented from Element.
Definition at line 31 of file BeamSequence.cpp.
|
private |
The documentation for this class was generated from the following files:
- src/AbstractObjects/BeamSequence.h
- src/AbstractObjects/BeamSequence.cpp
