class CorrectorRep : public Corrector

(Return to index)

Representation of a closed orbit corrector.

The base class acts on both planes.

Type:	Instantiable
Superclasses:	public Corrector
Include file:	./BeamlineCore/CorrectorRep.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • CorrectorRep (const string&) ;
  • CorrectorRep () ;
  • CorrectorRep (const CorrectorRep&) ;
  • virtual ~CorrectorRep () ;
  • virtual ElementBase* clone ()const ;
  • virtual Channel* getChannel (const string&) ;
  • virtual StraightGeometry& getGeometry () ;
  • virtual const StraightGeometry& getGeometry ()const ;
  • virtual ElementImage* getImage ()const ;
  • virtual Plane getPlane ()const ;
  • virtual const string& getType ()const ;
  • virtual double getBx ()const ;
  • virtual double getBy ()const ;
  • virtual BDipoleField& getField () ;
  • virtual const BDipoleField& getField ()const ;
  • virtual void setBx (double) ;
  • virtual void setBy (double) ;
  • virtual ElementBase* makeFieldWrapper () ;
  • virtual void setActive (bool) ;
  • enum Plane ;
  • virtual void accept (BeamlineVisitor&)const ;
  • 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 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 const ConstChannel* getConstChannel (const string&)const ;
  • virtual ElementBase* copyStructure () ;
  • bool isSharable ()const ;
  • virtual void makeSharable () ;
  • virtual ElementBase* makeAlignWrapper () ;
  • 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:
  • StraightGeometry geometry ;
  • BDipoleField field ;
  • bool active ;
  • void operator= (const Corrector&) ;
  • mutable bool shareFlag ;
  • RCObject& operator= (const RCObject&) ;

Documentation:

• Public members:

  CorrectorRep (const string&) ;

  Constructor with given name.

  virtual ElementBase* clone ()const ;

  Return clone.
  Return an identical deep copy of the element.

  virtual double getBx ()const ;

  Get horizontal field component in Teslas.

  virtual double getBy ()const ;

  Get vertical field component in Teslas.

  virtual Channel* getChannel (const string&) ;

  Construct a read/write channel.
  This method constructs a Channel permitting read/write access to the attribute aKey and returns it. If the attribute does not exist, it returns NULL.

  virtual BDipoleField& getField () ;

  Get corrector field.

  virtual const BDipoleField& getField ()const ;

  Get corrector field. Version for const corrector.

  virtual StraightGeometry& getGeometry () ;

  Get geometry.
  Return the element geometry. Version for non-constant object.

  virtual const StraightGeometry& getGeometry ()const ;

  Get geometry.
  Return the element geometry Version for constant object.

  virtual ElementImage* getImage ()const ;

  Construct an image.
  Return the image of the element, containing the name and type string of the element, and a copy of the user-defined attributes.

  virtual Plane getPlane ()const ;

  Get plane(s) of action.

  virtual const string& getType ()const ;

  Get element type string.

  virtual ElementBase* makeFieldWrapper () ;

  Allow field errors.
  Build a FieldWrapper pointing to the corrector and return a pointer to that wrapper.

  virtual void setActive (bool) ;

  Set active flag.
  If flag is true, the corrector is activated, otherwise deactivated.

  virtual void setBx (double) ;

  Set horizontal field component in Teslas.

  virtual void setBy (double) ;

  Set vertical field component in Teslas.

• Protected members:

  bool active ;

  The active/inactive flag.

  BDipoleField field ;

  The corrector strengths.

  StraightGeometry geometry ;

  The corrector geometry.