class SBendRep : public SBend

(Return to index)

Representation for a sector bend magnet.

A sector bend magnet has a planar arc geometry about which its multipole components are specified.

Type:	Instantiable
Superclasses:	public SBend
Include file:	./BeamlineCore/SBendRep.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • SBendRep (const string&) ;
  • SBendRep () ;
  • SBendRep (const SBendRep&) ;
  • virtual ~SBendRep () ;
  • virtual ElementBase* clone ()const ;
  • virtual Channel* getChannel (const string&) ;
  • virtual BMultipoleField& getField () ;
  • virtual const BMultipoleField& getField ()const ;
  • virtual PlanarArcGeometry& getGeometry () ;
  • virtual const PlanarArcGeometry& getGeometry ()const ;
  • virtual ElementImage* getImage ()const ;
  • virtual const string& getType ()const ;
  • virtual double getB ()const ;
  • virtual void setB (double) ;
  • virtual void setField (const BMultipoleField&) ;
  • virtual ElementBase* makeFieldWrapper () ;
  • virtual double getEntryFaceRotation ()const ;
  • virtual double getExitFaceRotation ()const ;
  • virtual double getEntryFaceCurvature ()const ;
  • virtual double getExitFaceCurvature ()const ;
  • virtual void setEntryFaceRotation (double) ;
  • virtual void setExitFaceRotation (double) ;
  • virtual void setEntryFaceCurvature (double) ;
  • virtual void setExitFaceCurvature (double) ;
  • virtual void accept (BeamlineVisitor&)const ;
  • double getNormalComponent (int)const ;
  • double getSkewComponent (int)const ;
  • void setNormalComponent (int,double) ;
  • void setSkewComponent (int,double) ;
  • 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 ;

Documentation:

• Public members:

  SBendRep (const string&) ;

  Constructor with given name.

  virtual ElementBase* clone ()const ;

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

  virtual double getB ()const ;

  Get field.
  Return the vertical component of the field 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 double getEntryFaceCurvature ()const ;

  Get entry pole face curvature.
  Return the curvature of the entry pole face. A positive curvature creates a convex pole face.

  virtual double getEntryFaceRotation ()const ;

  Get pole entry face rotation.
  Return the rotation of the entry pole face with respect to the x-axis. A positive angle rotates the pole face normal away from the centre of the machine.

  virtual double getExitFaceCurvature ()const ;

  Get exit pole face curvature.
  Return the curvature of the exit pole face. A positive curvature creates a convex pole face.

  virtual double getExitFaceRotation ()const ;

  Get exit pole face rotation.
  Return the rotation of the exit pole face with respect to the x-axis. A positive angle rotates the pole face normal away from the centre of the machine.

  virtual BMultipoleField& getField () ;

  Get field.
  Version for non-constant object.

  virtual const BMultipoleField& getField ()const ;

  Get field.
  Version for constant object.

  virtual PlanarArcGeometry& getGeometry () ;

  Get geometry.
  Version for non-constant object.

  virtual const PlanarArcGeometry& getGeometry ()const ;

  Get 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 const string& getType ()const ;

  Get element type string.

  virtual ElementBase* makeFieldWrapper () ;

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

  virtual void setB (double) ;

  Set vertical component.
  Assign the vertical component of the field in Teslas.

  virtual void setEntryFaceCurvature (double) ;

  Set entry pole face curvature.
  Return the curvature of the entry pole face. A positive curvature creates a convex pole face.

  virtual void setEntryFaceRotation (double) ;

  Set pole entry face rotation.
  Return the rotation of the entry pole face with respect to the x-axis. A positive angle rotates the pole face normal away from the centre of the machine.

  virtual void setExitFaceCurvature (double) ;

  Set exit pole face curvature.
  Return the curvature of the exit pole face. A positive curvature creates a convex pole face.

  virtual void setExitFaceRotation (double) ;

  Set exit pole face rotation.
  Return the rotation of the exit pole face with respect to the x-axis. A positive angle rotates the pole face normal away from the centre of the machine.

  virtual void setField (const BMultipoleField&) ;

  Set field.
  Assign the multipole expansion.