Interface ModelOpticsData

  • All Superinterfaces:
    Data, DynamicData
    All Known Implementing Classes:
    JMadModelOpticsData

    public interface ModelOpticsData
    extends DynamicData
    this interface shall provide data of the model, consistent with the actual selected monitors/correctors
    • Method Detail

      • getMonitorDispersions

        java.util.List<java.lang.Double> getMonitorDispersions​(Plane plane)
        Parameters:
        plane - the plane for which to retrieve the values
        Returns:
        the dispersion values for the actually active monitors
      • getMonitorDispersions

        java.util.List<java.lang.Double> getMonitorDispersions()
        Returns:
        the dispersion-values for both planes
      • getMonitorBetas

        java.util.List<java.lang.Double> getMonitorBetas​(Plane plane)
        Parameters:
        plane - the plane for which to retrieve the values
        Returns:
        the beta-values for the actually active monitors
      • getMonitorBetas

        java.util.List<java.lang.Double> getMonitorBetas()
        Returns:
        the beta-values for both planes
      • getMonitorPhases

        java.util.List<java.lang.Double> getMonitorPhases​(Plane plane)
        Parameters:
        plane - the plane for which to retrieve the values
        Returns:
        the phase-values for the actually active monitors
      • getMonitorPos

        java.util.List<java.lang.Double> getMonitorPos​(Plane plane)
        Parameters:
        plane - the plane for which to retrieve the transverse positions
        Returns:
        the transvers position for the given plane
      • getMonitorPos

        java.util.List<java.lang.Double> getMonitorPos()
        Returns:
        the positions at the monitors for both planes (H+V)
      • getAllDispersions

        java.util.List<java.lang.Double> getAllDispersions​(Plane plane)
        the dispersion values for all points
        Parameters:
        plane - the plane for which to retrieve the dispersion-values
        Returns:
        the dispersion values
      • getAllBetas

        java.util.List<java.lang.Double> getAllBetas​(Plane plane)
        Parameters:
        plane - the plane for which to retrieve the values
        Returns:
        the beta-values for the actually active monitors
      • getAllPhases

        java.util.List<java.lang.Double> getAllPhases​(Plane plane)
        Parameters:
        plane - the plane for which to retrieve the values
        Returns:
        the phase-values for the actually active monitors
      • getAllPos

        java.util.List<java.lang.Double> getAllPos​(Plane plane)
        Parameters:
        plane - plane for which to retrieve the data
        Returns:
        plane the transvers positions fo all elements
      • getPhase

        java.lang.Double getPhase​(java.lang.String elementName,
                                  Plane plane)
        retrieves the phase for one element.
        Parameters:
        elementName - the name of the element for which to get the phase
        plane - the plane for which to return the phase
        Returns:
        the phase of the given element
      • getAllSPositions

        java.util.List<java.lang.Double> getAllSPositions()
        Returns:
        the positions of all elements
      • getSPosition

        java.lang.Double getSPosition​(java.lang.String elementName)
        Returns:
        the position of the element with given name
      • getMonitorSPositions

        java.util.List<java.lang.Double> getMonitorSPositions​(Plane plane)
        the s-positions for the monitors in the given plane
        Parameters:
        plane -
        Returns:
      • getAllNames

        java.util.List<java.lang.String> getAllNames()
        returns a list with the names of all elements
        Returns: