class MultipoleWrapper : public Multipole

(Return to index)

Representation of a perturbed multipole.

A MultipoleWrapper represents a unique instance of a multipole magnet in the accelerator model. It defines imperfections of the field, related to an ``ideal'' magnet contained in the wrapper.

Type:	Instantiable
Superclasses:	public Multipole
Include file:	./ComponentWrappers/MultipoleWrapper.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • MultipoleWrapper (Multipole*) ;
  • MultipoleWrapper (const MultipoleWrapper&) ;
  • virtual ~MultipoleWrapper () ;
  • virtual void accept (BeamlineVisitor&)const ;
  • virtual ElementBase* clone ()const ;
  • virtual ElementBase* copyStructure () ;
  • virtual BMultipoleField& errorField ()const ;
  • virtual void makeSharable () ;
  • virtual BMultipoleField& getField () ;
  • virtual const BMultipoleField& getField ()const ;
  • virtual StraightGeometry& getGeometry () ;
  • virtual const StraightGeometry& getGeometry ()const ;
  • virtual const string& getType ()const ;
  • virtual const Multipole& getDesign ()const ;
  • virtual Multipole& getDesign () ;
  • virtual ElementBase* makeFieldWrapper () ;
  • virtual ElementBase* removeFieldWrapper () ;
  • virtual const ElementBase* removeFieldWrapper ()const ;
  • virtual ElementBase* removeWrappers () ;
  • virtual const ElementBase* removeWrappers ()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 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 Channel* getChannel (const string&) ;
  • virtual const ConstChannel* getConstChannel (const string&)const ;
  • virtual ElementImage* getImage ()const ;
  • bool isSharable ()const ;
  • virtual ElementBase* makeAlignWrapper () ;
  • virtual ElementBase* makeWrappers () ;
  • virtual ElementBase* removeAlignWrapper () ;
  • virtual const ElementBase* removeAlignWrapper ()const ;
  • bool update (const AttributeSet&) ;
  • int addReference ()const ;
  • int removeReference ()const ;
  • bool isShared ()const ;

Documentation:

• Public members:

  MultipoleWrapper (Multipole*) ;

  Constructor.
  Constructs a wrapper for its argument. The wrapper is not sharable by default.

  virtual void accept (BeamlineVisitor&)const ;

  Apply visitor to modified multipole.

  virtual ElementBase* clone ()const ;

  Make clone.

  virtual ElementBase* copyStructure () ;

  Make structural copy.

  virtual BMultipoleField& errorField ()const ;

  Get multipole field error.
  This method can be used to get or set the error field. The error field offset is mutable, so as to allow changing it in a constant structure.

  virtual const Multipole& getDesign ()const ;

  Get design corrector.
  Version for constant object.

  virtual Multipole& getDesign () ;

  Get design corrector.
  Version for non-constant object.

  virtual BMultipoleField& getField () ;

  Get field.
  Return the perturbed field. Version for non-constant object.

  virtual const BMultipoleField& getField ()const ;

  Get field.
  Return the perturbed field. Version for constant object.

  virtual StraightGeometry& getGeometry () ;

  Get geometry.
  Version for non-constant object.

  virtual const StraightGeometry& getGeometry ()const ;

  Get geometry.
  Version for constant object.

  virtual const string& getType ()const ;

  Get element type string.

  virtual ElementBase* makeFieldWrapper () ;

  Make wrapper for this multipole.
  Return this, since this is already a field wrapper.

  virtual void makeSharable () ;

  Set sharable flag.
  The whole structure depending on this is marked as sharable. After this call a copyStructure() call reuses the element.

  virtual ElementBase* removeFieldWrapper () ;

  Remove field wrapper.

  virtual const ElementBase* removeFieldWrapper ()const ;

  Remove field wrapper.

  virtual ElementBase* removeWrappers () ;

  Remove all wrappers.

  virtual const ElementBase* removeWrappers ()const ;

  Remove all wrappers.