Package xal.smf.attr

Class MagnetBucket

java.lang.Object
xal.smf.attr.AttributeBucket
xal.smf.attr.MagnetBucket
All Implemented Interfaces:
Serializable, DataListener
Direct Known Subclasses:
DipoleBucket
public class MagnetBucket extends AttributeBucket
Attribute set for magnet information
len - is the effective magnetic length [m]
dfltMagField is the default field value (T for dipole, T/m for quad, etc.)
polarity - is the polarity flag. 1 means positive current = positive field. -1 means positive current = negative field
multFieldNorm - is an array of the normal direction multipole components element n is the n'th pole field level over the primary field where n= 0 for dipole, n=1 for quad, ...
multFieldSkew - is the same as multFieldNorm, but is for the skew direction
Author:
Nikolay Malitsky, John Galambos, Christopher K. Allen, Paul C. Chu
See Also:

  • Constructor Details

    • MagnetBucket

      public MagnetBucket()

  • Method Details

    • getType

      public String getType()
      Override virtual to provide type signature
      Specified by:
      getType in class AttributeBucket

    • getEffLength

      public double getEffLength()
      return the magnetic length (in m)

    • getDfltField

      public double getDfltField()
      return the design magnetic field strength (in Tesla)

    • getPolarity

      public double getPolarity()
      return the magnet polarity ( 1 or -1)

    • getNormField

      public double[] getNormField()

    • getTangField

      public double[] getTangField()

    • getUseCurrentFlag

      public boolean getUseCurrentFlag()

    • getConversionFactor

      public double getConversionFactor()

    • setEffLength

      public void setEffLength(double dblVal)
      set the magnetic length (in m)
      Parameters:
      dblVal - magnetic length in meters

    • setPolarity

      public void setPolarity(double dblVal)
      set the magnet polarity
      Parameters:
      dblVal - magnet polarity (1 or -1)

    • setNormField

      public void setNormField(double[] arrVal)

    • setTangField

      public void setTangField(double[] arrVal)

    • setDfltField

      public void setDfltField(double dblVal)

    • setUseCurrentFlag

      public void setUseCurrentFlag(boolean bolVal)

    • setConversionFactor

      public void setConversionFactor(double dblVal)