com.supermap.analyst.networkanalyst3d
Class TransportationAnalystResult3D
- java.lang.Object
-
- com.supermap.data.InternalHandle
-
- com.supermap.data.InternalHandleDisposable
-
- com.supermap.analyst.networkanalyst3d.TransportationAnalystResult3D
-
public class TransportationAnalystResult3D extends InternalHandleDisposable
The results class of the 3D transportation network analysis. The TransportationAnalystResult3D class is used to return the results of various 3D transportation network analyses, including the route dataset, the node/edge ID dataset, the stop ID dataset, the weight dataset, the cost of each stop, etc.
-
-
Constructor Summary
Constructors Constructor and Description TransportationAnalystResult3D()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description void
dispose()
Disposes the resources occupied by the object.int[][]
getEdges()
Returns the edges dataset of the analysis result.int[][]
getNodes()
Returns the nodes dataset of the analysis result.GeoLine3D[]
getRoutes()
Returns the routes dataset of the analysis result.int[][]
getStopIndexes()
Returns the 2D array of the stop indexes which reflects the order of the stops after analysis.double[][]
getStopWeights()
Returns the values of the weights passed by the analysis.double[]
getWeights()
Returns the weight array represented the cost.
-
-
-
Method Detail
-
dispose
public void dispose()
Disposes the resources occupied by the object. After calling this method, this object will not be usable.
-
getRoutes
public GeoLine3D[] getRoutes()
Returns the routes dataset of the analysis result. Note: TheTransportationAnalystParameter3D
property of theTransportationAnalystParameter3D
class must be set as true so that the analysis results can contain the routes dataset; otherwise, it is a null array.- Returns:
- GeoLine3D[]
-
getNodes
public int[][] getNodes()
Returns the nodes dataset of the analysis result. Note: ThesetNodesReturn ()
property of theTransportationAnalystParameter3D
object must be set as true so that the analysis results can contain the nodes dataset; otherwise, it is a null array. The returned value represents different meanings in different analyses.Optimal path analysis (findPath()
): Since the analysis only has one result route, the one-dimensional length of the array is 1, and its 2D length is the number of the nodes in the analysis which records the node ID according to the order passed by the optimal path.- Returns:
- The passed nodes set of the analysis result.
-
getEdges
public int[][] getEdges()
Returns the edges dataset of the analysis result. Note: ThesetEdgesReturn()
property of theTransportationAnalystParameter3D
object must be set as true so that the analysis results can contain the edges dataset; otherwise, it is a null array. The returned value represents different meanings in different analyses.Optimal path analysis (findPath()
): Since the analysis only has one result route, the one-dimensional length of the array is 1, and its 2D length is the number of the edges in the analysis which records the edge ID according to the order passed by the optimal path.- Returns:
- The passed nodes set of the analysis result.
-
getStopIndexes
public int[][] getStopIndexes()
Returns the 2D array of the stop indexes which reflects the order of the stops after analysis. Note: ThesetStopIndexesReturn()
property of theTransportationAnalystParameter3D
object must be set as true so that the analysis results can contain the passed edges set; otherwise, it is a null array. The returned value represents different meanings in different analyses. The node mode of the optimal path analysis (findPath()
): If the specified node ID is 1, 3, 5, then the order of the result must also be 1, 3, 5, so the returned value of the method is 0, 1, 2. The result order is the index of the specified nodes. The coordinate point mode of the optimal path analysis (findPath()
): The passed result node ID has no relations to the coordinate point index we set, so the index value of this method has no meanings.- Returns:
- The array of the site index.
-
getStopWeights
public double[][] getStopWeights()
Returns the values of the weights passed by the analysis. It has the same unit with the weight field of theWeightFieldInfo3D
object specified thesetWeightName()
method of theTransportationAnalystParameter3D
object. This method can get the cost between stops, which are the nodes or coordinate points involved in the analysis. The order of the stops related to the weight that is gotten by the method is consistent with the stop index gotten by the#getStopIndexes() getStopIndexes()
method. But you need to pay attention on the tiny differences between different functions. For example, for the optimal path analysis (findPath()
), it is specified to pass the point 1, 2, 3, then the values of the array elements are the cost from 1 to 2, and the cost from 2 to 3.- Returns:
- The weight of stops to be passed.
-
getWeights
public double[] getWeights()
Returns the weight array represented the cost. It has the same unit with the weight field of theWeightFieldInfo3D
object specified thesetWeightName()
method of theTransportationAnalystParameter3D
object. The returned value represents different meanings in different analysis. E.g., the optimal path analysis (findPath()
): Since the analysis only has one result route, the length of the array is 1 which is the total cost of the path.- Returns:
- The weight array of the cost.
-
-