Interface ResponseRequest

  • All Known Implementing Classes:
    ResponseRequestImpl

    public interface ResponseRequest
    this interface defines, what kickers shall be used for calculating the response matrix and at what monitors the response-values shall be calculated.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getCorrectorNames()
      This method must return the names of the correctors which shall be used for calculating the response request.
      java.util.List<JMadPlane> getCorrectorPlanes()
      must return the planes in which the correctors shall be kicked.
      java.util.List<java.lang.String> getMonitorNames()
      The monitor names.
      java.util.List<JMadPlane> getMonitorPlanes()
      must return a plane for each of monitors, at which the position shall be taken to calc the response matrix element.
      java.util.List<java.lang.String> getMonitorRegexps()
      must return regular expressions representing the monitors.
      java.util.List<java.lang.Double> getStrengthValues()
      This method must return the strengthes which shall be used at the corrector for calculating the response at the according correctors.
    • Method Detail

      • getCorrectorNames

        java.util.List<java.lang.String> getCorrectorNames()
        This method must return the names of the correctors which shall be used for calculating the response request.
        Returns:
        The names of the correctors to use.
      • getCorrectorPlanes

        java.util.List<JMadPlane> getCorrectorPlanes()
        must return the planes in which the correctors shall be kicked.
        Returns:
        the planes for the correctors.
      • getStrengthValues

        java.util.List<java.lang.Double> getStrengthValues()
        This method must return the strengthes which shall be used at the corrector for calculating the response at the according correctors. The given strength will be applied once positive and once negative. The Response-matrix element is then the difference of the two trajectories devided by twice the strength.
        Returns:
        the strengths to use
      • getMonitorNames

        java.util.List<java.lang.String> getMonitorNames()
        The monitor names.
        Returns:
        the names of the monitors at which positions the the response shall be calculated.
      • getMonitorPlanes

        java.util.List<JMadPlane> getMonitorPlanes()
        must return a plane for each of monitors, at which the position shall be taken to calc the response matrix element.
        Returns:
        the monitor-planes
      • getMonitorRegexps

        java.util.List<java.lang.String> getMonitorRegexps()
        must return regular expressions representing the monitors. This makes the twiss faster then using all the names seperately as filter.
        Returns:
        a list of regular expressions.