Class ApertureImpl

  • All Implemented Interfaces:
    Aperture

    public class ApertureImpl
    extends java.lang.Object
    implements Aperture
    geometric aperture information for jmad
    • Constructor Summary

      Constructors 
      Constructor Description
      ApertureImpl()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addMarker​(java.lang.String name, double pos)  
      void addSlice​(ApertureSlice newSlice)  
      java.util.List<ApertureSlice> getApertureSlices()  
      java.lang.Double getMarkerPos​(java.lang.String markerName)  
      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.String> getMissedMarkers()
      this list will be changed by the reader!
      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)  
      boolean isIndexLoaded()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ApertureImpl

        public ApertureImpl()
    • Method Detail

      • getMaxValues

        public java.util.List<java.lang.Double> getMaxValues​(JMadPlane plane,
                                                             boolean aroundTrajectory)
        Description copied from interface: Aperture
        get the maximum values for the given plane
        Specified by:
        getMaxValues in interface Aperture
        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
      • getMinValues

        public java.util.List<java.lang.Double> getMinValues​(JMadPlane plane,
                                                             boolean aroundTrajectory)
        Description copied from interface: Aperture
        get the minimum values for the given plane
        Specified by:
        getMinValues in interface Aperture
        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
      • getSValues

        public java.util.List<java.lang.Double> getSValues()
        Specified by:
        getSValues in interface Aperture
        Returns:
        the s-Positions of the ApertureSequence
      • getXminValues

        public java.util.List<java.lang.Double> getXminValues​(boolean aroundTrajectory)
        Specified by:
        getXminValues in interface Aperture
        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

        public java.util.List<java.lang.Double> getXmaxValues​(boolean aroundTrajectory)
        Specified by:
        getXmaxValues in interface Aperture
        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

        public java.util.List<java.lang.Double> getYminValues​(boolean aroundTrajectory)
        Specified by:
        getYminValues in interface Aperture
        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

        public java.util.List<java.lang.Double> getYmaxValues​(boolean aroundTrajectory)
        Specified by:
        getYmaxValues in interface Aperture
        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
      • addMarker

        public void addMarker​(java.lang.String name,
                              double pos)
      • getMissedMarkers

        public java.util.List<java.lang.String> getMissedMarkers()
        this list will be changed by the reader!
        Returns:
        the list of missed markers
      • getMarkerPos

        public java.lang.Double getMarkerPos​(java.lang.String markerName)
      • getApertureSlices

        public java.util.List<ApertureSlice> getApertureSlices()
      • isIndexLoaded

        public boolean isIndexLoaded()