class Sequence : public BeamSequence

(Return to index)

The SEQUENCE definition.

Type:	Instantiable
Superclasses:	public BeamSequence
Include file:	./Lines/Sequence.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • typedef TBeamline<SequenceMember> TLine ;
  • Sequence () ;
  • virtual ~Sequence () ;
  • virtual Sequence* clone (const string&) ;
  • virtual Sequence* copy (const string&) ;
  • virtual void doomGet (const DoomReader&) ;
  • virtual void doomPut (DoomWriter&)const ;
  • virtual double getLength ()const ;
  • virtual double getEntrance (ReferenceType)const ;
  • virtual double getExit (ReferenceType)const ;
  • ReferenceType getReference ()const ;
  • virtual Object* makeTemplate (const string&,TokenStream&,Statement&) ;
  • virtual void parse (Statement&) ;
  • virtual void print (std::ostream&)const ;
  • virtual void replace (Object*,Object*) ;
  • virtual void update () ;
  • virtual TLine* fetchLine ()const ;
  • void storeLine (TLine&) ;
  • static BeamSequence* find (const string&) ;
  • virtual const string getCategory ()const ;
  • enum ReferenceType ;
  • virtual bool canReplaceBy (Object*) ;
  • virtual bool shouldTrace ()const ;
  • virtual bool shouldUpdate ()const ;
  • virtual void setShared (bool) ;
  • inline ElementBase* getElement ()const ;
  • inline void setElement (ElementBase*) ;
  • void copyAttributes (const Object&) ;
  • virtual void execute () ;
  • virtual Attribute* findAttribute (const string&) ;
  • virtual const Attribute* findAttribute (const string&)const ;
  • virtual Object* makeInstance (const string&,Statement&) ;
  • virtual void parseShortcut (Statement&) ;
  • virtual void printHelp (std::ostream&)const ;
  • 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 ;
• Friends:
  • class Edit ;
  • class SequenceParser ;
  • class SequenceTemplate ;

Documentation:

• Public members:

  Sequence () ;

  Exemplar constructor.

  typedef TBeamline<SequenceMember> TLine ;

  The type of a sequence line.

  virtual Sequence* clone (const string&) ;

  Make clone.
  The new object is an empty sequence, it will be filled in by the parser.

  virtual Sequence* copy (const string&) ;

  Make copy of the sequence line.

  virtual void doomGet (const DoomReader&) ;

  Read the sequence from the DOOM data base.

  virtual void doomPut (DoomWriter&)const ;

  Write the sequence to the DOOM data base.

  virtual TLine* fetchLine ()const ;

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

  virtual double getEntrance (ReferenceType)const ;

  Return the arc length from origin to entrance.

  virtual double getExit (ReferenceType)const ;

  Return the arc length from origin to exit.

  virtual double getLength ()const ;

  Return sequence length.

  ReferenceType getReference ()const ;

  Return the reference type flag.
  "ENTRY", "CENTRE", or "EXIT".

  virtual Object* makeTemplate (const string&,TokenStream&,Statement&) ;

  Make a sequence template.
  Arguments:

  1. Name to be given to the template.
  2. Token stream to be read for the sequence line.
  3. Statement to be read for the arguments.

  virtual void parse (Statement&) ;

  Parse sequence.

  virtual void print (std::ostream&)const ;

  Print sequence.

  virtual void replace (Object*,Object*) ;

  Replace references to elements.

  void storeLine (TLine&) ;

  Store sequence line.
  Assign to the underlying ideal line and re-insert the drifts.

  virtual void update () ;

  Update the embedded CLASSIC beam line.
  Recompute drift lengths.

• Friends:

  class Edit ;

  This class contains all data for the sequence editor.
  It acts as a communication area between the sequence editor commands.

  class SequenceParser ;

  The parser for SEQUENCE members.
  Recognises the format for all possible SEQUENCE members.

  class SequenceTemplate ;

  An ``archetype'' for a SEQUENCE with arguments.