Package cern.accsoft.steering.jmad.domain.aperture

Interface Aperture

  • All Known Implementing Classes:
    ApertureImpl
    public interface Aperture

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.Double> getMaxValues​(JMadPlane plane, boolean aroundTrajectory)
      get the maximum values for the given plane
      java.util.List<java.lang.Double> getMinValues​(JMadPlane plane, boolean aroundTrajectory)
      get the minimum values for the given plane
      java.util.List<java.lang.Double> getSValues()  
      java.util.List<java.lang.Double> getXmaxValues​(boolean aroundTrajectory)  
      java.util.List<java.lang.Double> getXminValues​(boolean aroundTrajectory)  
      java.util.List<java.lang.Double> getYmaxValues​(boolean aroundTrajectory)  
      java.util.List<java.lang.Double> getYminValues​(boolean aroundTrajectory)  

    • Method Detail

      • getSValues

        java.util.List<java.lang.Double> getSValues()
        Returns:
        the s-Positions of the ApertureSequence

      • getXminValues

        java.util.List<java.lang.Double> getXminValues​(boolean aroundTrajectory)
        Parameters:
        aroundTrajectory - if true the aperture around the nominal beam trajectory is returned, otherwise the aperture as defined.
        Returns:
        the minimum values in the x-plane

      • getXmaxValues

        java.util.List<java.lang.Double> getXmaxValues​(boolean aroundTrajectory)
        Parameters:
        aroundTrajectory - if true the aperture around the nominal beam trajectory is returned, otherwise the aperture as defined.
        Returns:
        the maximum values in the x-plane

      • getYminValues

        java.util.List<java.lang.Double> getYminValues​(boolean aroundTrajectory)
        Parameters:
        aroundTrajectory - if true the aperture around the nominal beam trajectory is returned, otherwise the aperture as defined.
        Returns:
        the minimum values in the y plane

      • getYmaxValues

        java.util.List<java.lang.Double> getYmaxValues​(boolean aroundTrajectory)
        Parameters:
        aroundTrajectory - if true the aperture around the nominal beam trajectory is returned, otherwise the aperture as defined.
        Returns:
        the maximum values in the y plane

      • getMinValues

        java.util.List<java.lang.Double> getMinValues​(JMadPlane plane,
                                              boolean aroundTrajectory)
        get the minimum values for the given plane
        Parameters:
        plane - the plane for which to retrieve the minValues
        aroundTrajectory - if true the aperture around the nominal beam trajectory is returned, otherwise the aperture as defined.
        Returns:
        the minimum Values for the given plane

      • getMaxValues

        java.util.List<java.lang.Double> getMaxValues​(JMadPlane plane,
                                              boolean aroundTrajectory)
        get the maximum values for the given plane
        Parameters:
        plane - the plane for which to retrieve the maximum Values
        aroundTrajectory - if true the aperture around the nominal beam trajectory is returned, otherwise the aperture as defined.
        Returns:
        the maximum values for the given plane