class CorrectionBase : public Action

(Return to index)

Abstract base class for all orbit correction commands.

Factors out all common behaviour for these algorithms.

Type:	Abstract
Superclasses:	public Action
Include file:	./Tables/CorrectionBase.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • virtual ~CorrectionBase () ;
  • typedef TBeamline<Row> TLine ;
  • virtual bool canReplaceBy (Object*) ;
  • virtual const string getCategory ()const ;
  • virtual bool shouldTrace ()const ;
  • virtual bool shouldUpdate ()const ;
  • 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 ;
  • virtual void setShared (bool) ;
  • 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:
  • struct Row ;
  • CorrectionBase (int,const char*,const char*) ;
  • CorrectionBase (const string&,CorrectionBase*) ;
  • void addKick (int,TLine::iterator&,double) ;
  • void buildIdealMatrix () ;
  • void listCorrectors (int) ;
  • void listMonitors (int) ;
  • void test (ElementBase*) ;
  • TLine itsLine ;
  • PartData reference ;
  • FVector<double,6> orbitGuess ;
  • bool isCorr ;
  • bool isMoni ;
  • bool builtin ;
  • bool modified ;
  • bool flagged ;

Documentation:

• Public members:

• Protected members:

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

  Exemplar constructor.

  CorrectionBase (const string&,CorrectionBase*) ;

  Clone constructor.

  struct Row ;

  The comon attributes for orbit correction commands. Structure for a row of the Twiss table.

  void addKick (int,TLine::iterator&,double) ;

  Add to kicker strength.
  Arguments:

  1. The plane: (0 = x, 1 = y).
  2. The position, given by an iterator into the Twiss table.
  3. The kick change.

  void buildIdealMatrix () ;

  Build the ideal transfer matrices from beginning to current position.

  bool isCorr ;

  Flags telling wether a corrector exists.

  bool isMoni ;

  Flag telling wether a monitor exists.

  TLine itsLine ;

  The flat beam line on which the correction is done.

  void listCorrectors (int) ;

  List correctors before or after correction.

  void listMonitors (int) ;

  List monitors before or after correction.

  FVector<double,6> orbitGuess ;

  The closed orbit guess.

  PartData reference ;

  The particle reference data.

  void test (ElementBase*) ;

  Routine to test for corrector or monitor.