template class SingleMultipole<int> : public Multipole

(Return to index)

Representation for single multipoles.

Template for representation of single multipoles. Represents all the basic (design) multipole magnets found in an accelerator. A single multipole has only one multipole component, the pole-number of which cannot be changed (once a quadrupole, always a quadrupole). This differs from a MultipoleRep object which can have an arbitrary number of multipole components.

This template class can be used to instantiate classes like:

• Quadrupole (order = 2),
• Sextupole (order = 3),
• Octupole (order = 4),
• SkewQuadrupole (order = -2),
• SkewSextupole (order = -3),
• SkewOctupole (order = -4).

Type:	Instantiable
Superclasses:	public Multipole
Include file:	./BeamlineCore/SingleMultipole.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • SingleMultipole (const string&) ;
  • SingleMultipole () ;
  • SingleMultipole (const SingleMultipole&) ;
  • virtual ~SingleMultipole () ;
  • virtual BMultipoleField& getField () ;
  • virtual const BMultipoleField& getField ()const ;
  • virtual StraightGeometry& getGeometry () ;
  • virtual const StraightGeometry& getGeometry ()const ;
  • virtual double getComponent ()const ;
  • virtual void setComponent (double) ;
  • virtual ElementBase* clone ()const ;
  • virtual Channel* getChannel (const string&) ;
  • ElementImage* getImage ()const ;
  • virtual const string& getType ()const ;
  • 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* 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 ;

Documentation:

• Public members:

  SingleMultipole (const string&) ;

  Constructor with given name.

  virtual ElementBase* clone ()const ;

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

  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 getComponent ()const ;

  Get component.
  Return the single multipole component in T/m**(n-1).

  virtual BMultipoleField& getField () ;

  Get field.
  Version for non-constant object.

  virtual const BMultipoleField& getField ()const ;

  Get 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.

  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 void setComponent (double) ;

  Set component.
  Assign the single multipole component in T/m**(n-1).