Package xal.smf.impl

Class MagnetTrimSupply

java.lang.Object
xal.smf.impl.MagnetPowerSupply
xal.smf.impl.MagnetTrimSupply
All Implemented Interfaces:
DataListener
public class MagnetTrimSupply extends MagnetPowerSupply
TrimMagnetSupply is a power supply that represents a trim magnet supply.
Author:
tap

  • Field Details

  • Constructor Details

    • MagnetTrimSupply

      public MagnetTrimSupply(Accelerator anAccelerator)
      Creates a new instance of TrimMagnetSupply

  • Method Details

    • getType

      public String getType()
      Get the power supply type
      Specified by:
      getType in class MagnetPowerSupply
      Returns:
      The power supply type

    • getField

      public double getField() throws GetException
      Get the trim field contribution from this power supply. T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
      Returns:
      the field contribution
      Throws:
      GetException

    • setField

      public void setField(double newField) throws PutException
      Set the trim field contribution from this power supply.
      Parameters:
      newField - is the new field level in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
      Throws:
      PutException

    • getFieldSetting

      public double getFieldSetting() throws GetException
      Get the value to which the field is set. Note that this is not the readback.
      Returns:
      the field setting in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
      Throws:
      GetException

    • getTrimCurrent

      public double getTrimCurrent() throws GetException
      Get the magnet trim power supply current
      Returns:
      the magnet trim power supply current in amperes
      Throws:
      ConnectionException - if the readback channel cannot be connected
      GetException - if the readback channel get action fails

    • setTrimCurrent

      public void setTrimCurrent(double current) throws PutException
      Set the magnet trim power supply current.
      Parameters:
      current - The current in amperes
      Throws:
      ConnectionException - if the put channel cannot be connected
      PutException - if the put channel set action fails

    • upperFieldLimit

      public double upperFieldLimit() throws GetException
      get the field upper settable limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
      Throws:
      GetException

    • lowerFieldLimit

      public double lowerFieldLimit() throws GetException
      get the field lower settable limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
      Throws:
      GetException

    • suppliesNode

      public boolean suppliesNode(AcceleratorNode node)
      Check if the electromagnet is supplied by this power supply.
      Specified by:
      suppliesNode in class MagnetPowerSupply
      Parameters:
      node - The electromagnet to check
      Returns:
      true if the node is supplied by this supply and false otherwise