class BeamSequence : public Element

(Return to index)

The base class for all MAD beam lines and sequences.

It implements the common behaviour of sequences, it can also be used via dynamic casting to determine whether an object represents a sequence.

Type:	Abstract
Superclasses:	public Element
Include file:	./AbstractObjects/BeamSequence.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • virtual ~BeamSequence () ;
  • virtual BeamSequence* copy (const string&) = 0 ;
  • static BeamSequence* find (const string&) ;
  • virtual const string getCategory ()const ;
  • virtual Beamline* fetchLine ()const = 0 ;
  • enum ReferenceType ;
  • virtual bool canReplaceBy (Object*) ;
  • virtual bool shouldTrace ()const ;
  • virtual bool shouldUpdate ()const ;
  • virtual double getLength ()const = 0 ;
  • virtual double getEntrance (ReferenceType)const ;
  • virtual double getExit (ReferenceType)const ;
  • virtual void setShared (bool) ;
  • inline ElementBase* getElement ()const ;
  • inline void setElement (ElementBase*) ;
  • virtual Object* clone (const string&) = 0 ;
  • void copyAttributes (const Object&) ;
  • virtual void doomGet (const DoomReader&) ;
  • virtual void doomPut (DoomWriter&)const ;
  • virtual void execute () ;
  • virtual Attribute* findAttribute (const string&) ;
  • virtual const Attribute* findAttribute (const string&)const ;
  • virtual Object* makeTemplate (const string&,TokenStream&,Statement&) ;
  • virtual Object* makeInstance (const string&,Statement&) ;
  • virtual void parse (Statement&) ;
  • virtual void parseShortcut (Statement&) ;
  • virtual void print (std::ostream&)const ;
  • virtual void printHelp (std::ostream&)const ;
  • virtual void replace (Object*,Object*) ;
  • virtual void update () ;
  • bool isBuiltin ()const ;
  • virtual bool isShared ()const ;
  • void setDirty (bool) ;
  • bool isDirty ()const ;
  • void setFlag (bool) ;
  • bool isFlagged ()const ;
  • void setDoomTime (double) ;
  • double getDoomTime ()const ;
  • const Object* getBaseObject ()const ;
  • const string& getMadName ()const ;
  • Object* getParent ()const ;
  • bool isTreeMember (const Object*)const ;
  • void setMadName (const string&) ;
  • void setParent (Object*) ;
  • void clear () ;
  • int increment () ;
  • int occurrenceCount () ;
  • void registerReference (AttributeBase*) ;
  • void unregisterReference (AttributeBase*) ;
  • std::vector<Attribute> itsAttr ;
• Protected Members:
  • BeamSequence (int,const char*,const char*) ;
  • BeamSequence (const string&,BeamSequence*) ;
  • bool builtin ;
  • bool modified ;
  • bool flagged ;

Documentation:

• Public members:

  virtual BeamSequence* copy (const string&) = 0 ;

  Make complete copy.
  Copy also the line list.

  virtual Beamline* fetchLine ()const = 0 ;

  Return the embedded CLASSIC beam line.
  The result it the ideal line.

  static BeamSequence* find (const string&) ;

  Find a BeamSequence by name.

  virtual const string getCategory ()const ;

  Return the object category as a string.
  Return the string "SEQUENCE".

• Protected members:

  BeamSequence (int,const char*,const char*) ;

  Constructor for exemplars.

  BeamSequence (const string&,BeamSequence*) ;

  Constructor for clones.
  The clone will be empty. It has to be filled in by the corresponding parser.