com.supermap.analyst.networkanalyst

Class FacilityAnalystResult

  • java.lang.Object
    • com.supermap.analyst.networkanalyst.FacilityAnalystResult


  • public class FacilityAnalystResult
    extends java.lang.Object
    The FacilityAnalystResult class. This class is used to get the analysis results of finding source and sink, tracing upstream and downstream, and path query including edge ID array, result node ID array and the cost.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      double getCost()
      Returns the cost in the facility network analysis results.
      int[] getEdges()
      Returns the edge ID array in the facility network analysis results.
      int[] getNodes()
      Returns the node ID array in the facility network analysis results.
      • Methods inherited from class java.lang.Object

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

      • getEdges

        public int[] getEdges()
        Returns the edge ID array in the facility network analysis results.

        For different facility network analysis functions, The return value of this method has different meanings:

        • Finding Source: This value is the edge ID array of edges contained by the least cost path that the edge or node reaches the source.
        • Finding Sink: This value is the edge ID array of edges contained by the least cost path that the edge or node reaches the sink.
        • Tracing Upstream: This value is the edge ID array of edges contained by the edge or node in the upstream.
        • Tracing Downstream: This value is the edge ID array of edges contained by the edge or node in the downstream.
        • Path analysis (findPathFromEdges, findPathFromNodes) :This value is the array of edges ID array of edges passed by the least cost path.
        • Tracing upstream (findPathUpFromEdge, findPathUpFromNode) :This value is the edges ID array of edges passed by the upstream least cost path.
        • Tracing downstream (findPathDownFromEdge, findPathDownFromNode): This value is the edges ID array of edges passed by the downstream least cost path.
        Returns:
        The edge ID array in the facility network analysis results.
      • getNodes

        public int[] getNodes()
        Returns the node ID array in the facility network analysis results.

        For different facility network analysis functions, The return value of this method has different meanings:

        • Finding Source: This value is the node ID array of nodes contained by the least cost path that the edge or node reaches the source.
        • Finding Sink: This value is the node ID array of nodes contained by the least cost path that the edge or node reaches the sink.
        • Tracing Upstream: This value is the node ID array of nodes contained by the edge or node in the upstream.
        • Tracing downstream: This value is the node ID array of nodes contained by the edge or node in the downstream.
        • Path analysis (findPathFromEdges, findPathFromNodes): This value is the array of nodes ID array of nodes passed by the least cost path.
        • Tracing upstream (findPathUpFromEdge, findPathUpFromNode): This value is the nodes ID array of nodes passed by the upstream least cost path.
        • Tracing upstream (findPathDownFromEdge, findPathDownFromNode): This value is the nodes ID array of nodes passed by the downstream least cost path.
        Returns:
        The node ID array in the facility network analysis results.
      • getCost

        public double getCost()
        Returns the cost in the facility network analysis results.

        For different facility network analysis functions, The return value of this method has different meanings:

        • Finding Source: This value is the cost of the least cost path that the edge or node reaches the source.
        • Finding Sink: This value is the cost of the least cost path that the edge or node reaches the sink.
        • Tracing Upstream: This value is the cost of edges contained by the edge or node in the upstream.
        • Tracing Downstream: This value is the cost of edges contained by the edge or node in the downstream.
        • Path analysis (findPathFromEdges, findPathFromNodes): This value is the cost of the least cost route.
        • Tracing upstream (findPathUpFromEdge, findPathUpFromNode): This value is the upstream cost of the least cost route.
        • Tracing downstream(findPathDownFromEdge、{@link FacilityAnalyst#findPathDownFromNode(int, String, boolean) findPathDownFromNode}): This value is the downstream cost of the least cost route.
        Returns:
        The cost in the facility network analysis results.