class Corrector : public Component

(Return to index)

Interface for general corrector.

Class Corrector defines the abstract interface for closed orbit correctors.

Type:	Abstract
Superclasses:	public Component
Include file:	./AbsBeamline/Corrector.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • enum Plane ;
  • Corrector (const string&) ;
  • Corrector () ;
  • Corrector (const Corrector&) ;
  • virtual ~Corrector () ;
  • virtual void accept (BeamlineVisitor&)const ;
  • virtual BDipoleField& getField () = 0 ;
  • virtual const BDipoleField& getField ()const = 0 ;
  • virtual StraightGeometry& getGeometry () = 0 ;
  • virtual const StraightGeometry& getGeometry ()const = 0 ;
  • virtual Plane getPlane ()const = 0 ;
  • EVector Efield (const Point3D&)const ;
  • BVector Bfield (const Point3D&)const ;
  • EVector Efield (const Point3D&,double)const ;
  • BVector Bfield (const Point3D&,double)const ;
  • EBVectors EBfield (const Point3D&)const ;
  • EBVectors EBfield (const Point3D&,double)const ;
  • virtual const ElementBase& getDesign ()const ;
  • virtual void trackBunch (PartBunch&,const PartData&,bool,bool)const ;
  • virtual void trackMap (FVps<double,6>&,const PartData&,bool,bool)const ;
  • virtual const string& getName ()const ;
  • virtual void setName (const string&) ;
  • virtual const string& getType ()const = 0 ;
  • virtual double getArcLength ()const ;
  • virtual double getElementLength ()const ;
  • virtual void setElementLength (double) ;
  • virtual double getOrigin ()const ;
  • virtual double getEntrance ()const ;
  • virtual double getExit ()const ;
  • virtual Euclid3D getTransform (double,double)const ;
  • virtual Euclid3D getTransform (double)const ;
  • virtual Euclid3D getTotalTransform ()const ;
  • virtual Euclid3D getEntranceFrame ()const ;
  • virtual Euclid3D getExitFrame ()const ;
  • virtual Euclid3D getEntrancePatch ()const ;
  • virtual Euclid3D getExitPatch ()const ;
  • virtual double getAttribute (const string&)const ;
  • virtual bool hasAttribute (const string&)const ;
  • virtual void removeAttribute (const string&) ;
  • virtual void setAttribute (const string&,double) ;
  • virtual Channel* getChannel (const string&) ;
  • virtual const ConstChannel* getConstChannel (const string&)const ;
  • virtual ElementImage* getImage ()const ;
  • virtual ElementBase* clone ()const = 0 ;
  • virtual ElementBase* copyStructure () ;
  • bool isSharable ()const ;
  • virtual void makeSharable () ;
  • virtual ElementBase* makeAlignWrapper () ;
  • virtual ElementBase* makeFieldWrapper () ;
  • virtual ElementBase* makeWrappers () ;
  • virtual ElementBase* removeAlignWrapper () ;
  • virtual const ElementBase* removeAlignWrapper ()const ;
  • virtual ElementBase* removeFieldWrapper () ;
  • virtual const ElementBase* removeFieldWrapper ()const ;
  • virtual ElementBase* removeWrappers () ;
  • virtual const ElementBase* removeWrappers ()const ;
  • bool update (const AttributeSet&) ;
  • int addReference ()const ;
  • int removeReference ()const ;
  • bool isShared ()const ;
• Protected Members:
  • void operator= (const Corrector&) ;
  • mutable bool shareFlag ;
  • RCObject& operator= (const RCObject&) ;

Documentation:

• Public members:

  Corrector (const string&) ;

  Corrector is off (inactive). Corrector acts on x-plane. Corrector acts on y-plane. Corrector acts on both planes. Constructor with given name.

  enum Plane ;

  Plane selection.

  virtual void accept (BeamlineVisitor&)const ;

  Apply a visitor to Corrector.

  virtual BDipoleField& getField () = 0 ;

  Return the corrector field.
  Version for non-constant object.

  virtual const BDipoleField& getField ()const = 0 ;

  Return the corrector field.
  Version for constant object.

  virtual StraightGeometry& getGeometry () = 0 ;

  Return the corrector geometry.

  virtual const StraightGeometry& getGeometry ()const = 0 ;

  Return the corrector geometry. Version for const object.

  virtual Plane getPlane ()const = 0 ;

  Return the plane on which the corrector acts.

• Protected members: