Package xal.model.elem.sync

Interface IElectrostatic

All Known Implementing Classes:
IdealEDipole, IdealEQuad, ThickElectrostatic
public interface IElectrostatic
This interface defines the common properties of all electrostatic elements.
Author:
Carla Benatti, adapted from Christopher K. Allen's IElectromagnet.java

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ORIENT_HOR
    dipole is oriented to provide action in the horizontal plane
    static final int
    ORIENT_NONE
    no dipole orientation given - indicates error condition for oriented elements
    static final int
    ORIENT_VER
    dipole is oriented to provide action in the vertical plane

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getOrientation()
    Return the orientation enumeration code.
    double
    getVoltage()
    Get the voltage applied to the electrostatic device
    void
    setOrientation(int enmOrient)
    Return the orientation enumeration code.
    void
    setVoltage(double dblVoltage)
    Set the voltage applied to the electrostatic device.

  • Field Details

    • ORIENT_NONE

      static final int ORIENT_NONE
      no dipole orientation given - indicates error condition for oriented elements
      See Also:

    • ORIENT_HOR

      static final int ORIENT_HOR
      dipole is oriented to provide action in the horizontal plane
      See Also:

    • ORIENT_VER

      static final int ORIENT_VER
      dipole is oriented to provide action in the vertical plane
      See Also:

  • Method Details

    • getOrientation

      int getOrientation()
      Return the orientation enumeration code.
      Returns:
      ORIENT_NONE - no electrostatic orientation (possible error) ORIENT_HOR - magnet oriented for action in x (horizontal) plane ORIENT_VER - magnet oriented for action in y (vertical) plane

    • getVoltage

      double getVoltage()
      Get the voltage applied to the electrostatic device
      Returns:
      Voltage (in kV).

    • setOrientation

      void setOrientation(int enmOrient)
      Return the orientation enumeration code.
      Parameters:
      enmOrient - magnet orientation enumeration code
      See Also:

    • setVoltage

      void setVoltage(double dblVoltage)
      Set the voltage applied to the electrostatic device.
      Parameters:
      dblVoltage - Voltage (in kV).