Class ServiceAreaPolygon


  • public final class ServiceAreaPolygon
    extends java.lang.Object
    Defines a service area polygon calculated with a ServiceAreaTask.

    Represents the area of the network that can be reached within a given time, distance, or other travel-cost cutoffs.

    Since:
    100.1.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double getFromImpedanceCutoff()
      Gets the minimal impedance value of a service area.
      Polygon getGeometry()
      Gets the service area polygon's geometry.
      double getToImpedanceCutoff()
      Gets the maximum impedance value of a service area.
      • Methods inherited from class java.lang.Object

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

      • getGeometry

        public Polygon getGeometry()
        Gets the service area polygon's geometry.
        Returns:
        the service area polygon's geometry
        Since:
        100.1.0
      • getFromImpedanceCutoff

        public double getFromImpedanceCutoff()
        Gets the minimal impedance value of a service area.

        A service area polygon's minimal impedance value. For example, a time impedance value of "5 10 15" specifies service areas of 0-5, 5-10, and 10-15 minutes intervals, which would result in three polygons, one covering an area from 0 to 5 minutes interval, and two others covering 5 to 10 minutes and 10 to 15 minutes intervals respectively.

        Returns:
        a value of from impedance cutoff
        Since:
        100.1.0
        See Also:
        ServiceAreaFacility.getImpedanceCutoffs()
      • getToImpedanceCutoff

        public double getToImpedanceCutoff()
        Gets the maximum impedance value of a service area.

        For example, a time impedance value of "5 10 15" specifies service areas of 0-5, 5-10, and 10-15 minutes intervals, which would result in three polygons, one covering an area from 0 to 5 minutes interval, and two others covering 5 to 10 minutes and 10 to 15 minutes intervals respectively.

        Returns:
        a value of to impedance cutoff
        Since:
        100.1.0
        See Also:
        ServiceAreaFacility.getImpedanceCutoffs()