NetworkAnalyst3DProvider

All Known Implementing Classes:

UGCNetworkAnalyst3DProvider
```
public interface NetworkAnalyst3DProvider
```
Three-dimensional network analysis provider. Including three-dimensional facilities Network analysis and three-dimensional traffic network-related functions, currently only supports three-dimensional facilities network analysis related functions, including finding nodes or arcs to the source or sink between the arc, upstream tracking, downstream tracking and upstream nearest facilities Search and other analysis functions.

Facilities network is a simulation of common networks and infrastructures in the real world, such as water supply networks, transmission lines, communication lines, natural gas pipelines, rivers, etc., whose common features are that the flow of resources has a direction. Three-dimensional facilities network analysis is based on the analysis of three-dimensional network data set which created flow, is an important part of the three-dimensional network analysis, the main functions are: Finds arcs, upstream traces, downstream traces, and upstream closest-approach facility and so on between nodes or arcs and source or sink. Compared to the traditional two-dimensional facility network analysis, three-dimensional facilities network analysis because of its true three-dimensional display, which be better for the design of facilities network, construction, emergency treatment to provide guidance and decision support.

Since:

7.1.0

Method Summary

Methods
Modifier and Type	Method and Description
`FacilityAnalyst3DResult`	`findCriticalFacilitiesUpFromEdge(int[] sourceNodeIDs, int edgeID, FacilityAnalystParameter parameter)` Upstream key facility lookup, that is, find the key facility nodes in the upstream of a given arc, return the key node ID array and its downstream arc ID array.
`FacilityAnalyst3DResult`	`findCriticalFacilitiesUpFromNode(int[] sourceNodeIDs, int nodeID, FacilityAnalystParameter parameter)` Upstream key facility lookup, that is, find the key facility nodes in the upstream of a given node, return the key node ID array and its downstream arc ID array.
`FacilityAnalyst3DResult`	`findSinkFromEdge(int edgeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given arc ID to find the sink, that is, starting from a given arc, find out the downstream sinks that outflow the arc according to the flow, and returns the arc, point and cost which the specified arc reach to the sink the minimum path contains.
`FacilityAnalyst3DResult`	`findSinkFromNode(int nodeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given node ID to find the sink, that is, from a given node, find out the downstream sinks that outflow the node according to the flow, and returns the arc, point and cost which the specified arc reach to the sink the minimum path contains.
`FacilityAnalyst3DResult`	`findSourceFromEdge(int edgeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given arc ID to find the source, that is, starting from a given arc, find out the network source that flow to the arc according to the flow, and returns the arc, point and cost which the specified source reach to the specified arc the minimum path contains.
`FacilityAnalyst3DResult`	`findSourceFromNode(int nodeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given node ID to find the source, that is, from a given node, find the network source that flow to the node according to the flow , and returns the arc, nodes and cost that the source node reach to the specified node the minimum cost path contains .
`FacilityAnalyst3DContent`	`getContent()` Gets the content information of the network data.
`java.lang.String`	`getNetworkDataName()` Gets the network data name.
`boolean`	`reloadModel()` Reloads the network data model.
`FacilityAnalyst3DResult`	`traceDownFromEdge(int edgeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given arc ID for downstream tracking, that is, to find downstream of a given arc, returns the arc, node and total cost which downstream contains.
`FacilityAnalyst3DResult`	`traceDownFromNode(int nodeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given node ID for downstream tracking, that is, to find downstream of a given arc, returns the arc, node and total cost which downstream contains.
`FacilityAnalyst3DResult`	`traceUpFromEdge(int edgeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given arc ID for upstream tracking, that is, to find upstream of a given arc, returns the arc, node and total cost which upstream contains.
`FacilityAnalyst3DResult`	`traceUpFromNode(int nodeID, java.lang.String weightName, FacilityAnalystParameter parameter)` According to the given node ID for upstream tracking, that is, to find upstream of a given arc, returns the arc, node and total cost which upstream contains.

- Method Detail
  - getNetworkDataName
```
java.lang.String getNetworkDataName()
```
    Gets the network data name.
    
    Returns:
  - reloadModel
```
boolean reloadModel()
```
    Reloads the network data model.
    
    Returns:
  - findCriticalFacilitiesUpFromEdge
```
FacilityAnalyst3DResult findCriticalFacilitiesUpFromEdge(int[] sourceNodeIDs,
                                                       int edgeID,
                                                       FacilityAnalystParameter parameter)
```
    Upstream key facility lookup, that is, find the key facility nodes in the upstream of a given arc, return the key node ID array and its downstream arc ID array.
    
    Parameters:
    
    sourceNodeIDs - Specified facility node ID array can not be empty.
    
    edgeID - Specified analysis arc ID.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results. Facility network analysis results. Returns null if did not find the key facility node.
  - findCriticalFacilitiesUpFromNode
```
FacilityAnalyst3DResult findCriticalFacilitiesUpFromNode(int[] sourceNodeIDs,
                                                       int nodeID,
                                                       FacilityAnalystParameter parameter)
```
    Upstream key facility lookup, that is, find the key facility nodes in the upstream of a given node, return the key node ID array and its downstream arc ID array.
    
    Parameters:
    
    sourceNodeIDs - Specified facility node ID array can not be empty.
    
    nodeID - The specified analysis node ID.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results. Facility network analysis results. Returns null if did not find the key facility node.
  - findSinkFromEdge
```
FacilityAnalyst3DResult findSinkFromEdge(int edgeID,
                                       java.lang.String weightName,
                                       FacilityAnalystParameter parameter)
```
    According to the given arc ID to find the sink, that is, starting from a given arc, find out the downstream sinks that outflow the arc according to the flow, and returns the arc, point and cost which the specified arc reach to the sink the minimum path contains.
    
    Parameters:
    
    edgeID - Specified analysis arc ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - findSinkFromNode
```
FacilityAnalyst3DResult findSinkFromNode(int nodeID,
                                       java.lang.String weightName,
                                       FacilityAnalystParameter parameter)
```
    According to the given node ID to find the sink, that is, from a given node, find out the downstream sinks that outflow the node according to the flow, and returns the arc, point and cost which the specified arc reach to the sink the minimum path contains.
    
    Parameters:
    
    nodeID - The specified node ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - traceUpFromEdge
```
FacilityAnalyst3DResult traceUpFromEdge(int edgeID,
                                      java.lang.String weightName,
                                      FacilityAnalystParameter parameter)
```
    According to the given arc ID for upstream tracking, that is, to find upstream of a given arc, returns the arc, node and total cost which upstream contains.
    
    Parameters:
    
    edgeID - Specified arc ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - traceUpFromNode
```
FacilityAnalyst3DResult traceUpFromNode(int nodeID,
                                      java.lang.String weightName,
                                      FacilityAnalystParameter parameter)
```
    According to the given node ID for upstream tracking, that is, to find upstream of a given arc, returns the arc, node and total cost which upstream contains.
    
    Parameters:
    
    nodeID - The specified node ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - traceDownFromEdge
```
FacilityAnalyst3DResult traceDownFromEdge(int edgeID,
                                        java.lang.String weightName,
                                        FacilityAnalystParameter parameter)
```
    According to the given arc ID for downstream tracking, that is, to find downstream of a given arc, returns the arc, node and total cost which downstream contains.
    
    Parameters:
    
    edgeID - Specified arc ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - traceDownFromNode
```
FacilityAnalyst3DResult traceDownFromNode(int nodeID,
                                        java.lang.String weightName,
                                        FacilityAnalystParameter parameter)
```
    According to the given node ID for downstream tracking, that is, to find downstream of a given arc, returns the arc, node and total cost which downstream contains.
    
    Parameters:
    
    nodeID - The specified node ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - findSourceFromEdge
```
FacilityAnalyst3DResult findSourceFromEdge(int edgeID,
                                         java.lang.String weightName,
                                         FacilityAnalystParameter parameter)
```
    According to the given arc ID to find the source, that is, starting from a given arc, find out the network source that flow to the arc according to the flow, and returns the arc, point and cost which the specified source reach to the specified arc the minimum path contains.
    
    Parameters:
    
    edgeID - Specified arc ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - findSourceFromNode
```
FacilityAnalyst3DResult findSourceFromNode(int nodeID,
                                         java.lang.String weightName,
                                         FacilityAnalystParameter parameter)
```
    According to the given node ID to find the source, that is, from a given node, find the network source that flow to the node according to the flow , and returns the arc, nodes and cost that the source node reach to the specified node the minimum cost path contains .
    
    Parameters:
    
    nodeID - The specified node ID.
    
    weightName - For the name of the specified weight field information object, see # name.
    
    parameter - Three - dimensional facility network analysis general parameters.
    
    Returns:
    
    Facility network analysis results.
  - getContent
```
FacilityAnalyst3DContent getContent()
```
    Gets the content information of the network data.
    
    Returns:

Interface NetworkAnalyst3DProvider

Method Summary

Method Detail

getNetworkDataName

reloadModel

findCriticalFacilitiesUpFromEdge

findCriticalFacilitiesUpFromNode

findSinkFromEdge

findSinkFromNode

traceUpFromEdge

traceUpFromNode

traceDownFromEdge

traceDownFromNode

findSourceFromEdge

findSourceFromNode

getContent