FacilityAnalystProvider

```
public interface FacilityAnalystProvider
```
设施网络分析服务提供者

SuperMap 设施网络分析服务提供者提供 SuperMap 设施网络分析的相关服务，封装了与 SuperMap 设施网络分析相关的 GIS 功能。

方法概要

方法
限定符和类型	方法和说明
`Feature[]`	`checkLoops()` 检查环路。
`FacilityAnalystResult`	`findCommonAncestors(int[] elementIDs, FacilityElementType elementType, boolean isLoopValid, FacilityAnalystResultOption option)` 返回给定结点或弧段的共同上游。
`FacilityAnalystResult`	`findCommonCatchements(int[] elementIDs, FacilityElementType elementType, boolean isLoopValid, FacilityAnalystResultOption option)` 返回给定结点或弧段的共同下游。
`FacilityAnalystResult`	`findConnected(int[] elementIDs, FacilityElementType elementType, FacilityAnalystResultOption option)` 连通性分析，返回与给定网络结点或弧段相连通的所有弧段。
`FacilityAnalystResult`	`findDisConnected(int[] elementIDs, FacilityElementType elementType, FacilityAnalystResultOption option)` 不连通性分析，返回与给定网络结点或弧段不连通的所有弧段。
`Geometry`	`findEdge(Point2D point)` 根据给定的坐标点，找到与该坐标点距离最近的网络弧段。
`FacilityAnalystResult`	`findLoops(int[] elementIDs, FacilityElementType elementType, FacilityAnalystResultOption option)` 查找环路，根据给定的弧段或结点，查找与这些弧段或结点连通的环路。
`Geometry`	`findNode(Point2D point)` 根据给定的坐标点，找到与该坐标点距离最近的网络结点。
`FacilityAnalystResult`	`findPath(int elementID, FacilityElementType elementType, FlowDirection direction, java.lang.String weightName, FacilityAnalystResultOption option)` 最短路径查找，可以查找上游最短路径，或者下游最短路径。
`FacilityAnalystResult`	`findPath(int fromElementID, int endElementID, FacilityElementType elementType, java.lang.String weightName, FacilityAnalystResultOption option)` 查找两个结点或弧段之间的最短路径。
`FacilityAnalystResult`	`findSink(int elementID, FacilityElementType elementType, FacilityAnalystResultOption option)` 查找最远的汇点。
`FacilityAnalystResult`	`findSource(int elementID, FacilityElementType elementType, FacilityAnalystResultOption option)` 查找最远的源点。
`PrjCoordSys`	`getPrjCoordSys()` 获取网络数据集的投影信息。
`java.lang.String[]`	`getWeightNames()` 获取权值字段的名称。
`FacilityAnalystResult`	`trace(int elementID, FacilityElementType elementType, FlowDirection direction, FacilityAnalystResultOption option)` 追踪给定的分析结点/弧段到上游或者下游所流经的所有弧段。

- 方法详细资料
  - checkLoops
```
Feature[] checkLoops()
```
    检查环路。返回所有构成环路的弧段。
    
    环路是指网络中具有无效流向的弧段。在SuperMap中，进行设施网络分析的网络数据集的流向是存储在流向字段中的，流向字段值有四个：
    
    值意义
    
    0 流向与线的方向相同
    
    1 流向与线的方向相反
    
    2 环路
    
    3 不连通弧段
    
    下图中以线段 AB 为例介绍流向字段值的确定。如果 A 点为源点，则水流（假设设施是河流）的方向应该是从 A->B，这与线的方向（A->B）是相同的，此时流向字段值为0；如果 B 为源点，则水流将从 B 流到 A 点，则水流的方向与线的方向（A->B）是相反的，此时流向字段值为1。
    
    环路：如果 A 和 B 均为源点，则水流方向在 A 点为源点时与线的方向相同，而在 B 为源点的时候与线的方向相反，构成了一个无效的流向，又称为环路。如下图所示：
    
    返回:
    
    所有构成环路的弧段。
  - findCommonAncestors
```
FacilityAnalystResult findCommonAncestors(int[] elementIDs,
                                        FacilityElementType elementType,
                                        boolean isLoopValid,
                                        FacilityAnalystResultOption option)
```
    返回给定结点或弧段的共同上游。
    
    参数:
    
    elementIDs - 结点或弧段的 ID 列表。
    
    elementType - 待分析的设施要素的类型。可以是结点或者弧段。
    
    isLoopValid - 环路是否有效。当该参数为 true 时, 环路有效，追踪分析继续进行；而当参数为 false 时，环路无效，追踪分析到此结束。
    
    option - 设施网络分析结果设置。
    
    mapParameter - 输出的地图图片的参数。包括地图的范围、比例尺、背景透明等。
    
    返回:
    
    共同上游分析结果。
  - findCommonCatchements
```
FacilityAnalystResult findCommonCatchements(int[] elementIDs,
                                          FacilityElementType elementType,
                                          boolean isLoopValid,
                                          FacilityAnalystResultOption option)
```
    返回给定结点或弧段的共同下游。
    
    参数:
    
    elementIDs - 结点或弧段的 ID 列表。
    
    elementType - 待分析的设施要素的类型。可以是结点或者弧段。
    
    isLoopValid - 环路是否有效。当该参数为 true 时, 环路有效，追踪分析继续进行；而当参数为 false 时，环路无效，追踪分析到此结束。
    
    option - 设施网络分析结果设置。
    
    mapParameter - 输出的地图图片的参数。包括地图的范围、比例尺、背景透明等。
    
    返回:
    
    共同下游分析结果。
  - findConnected
```
FacilityAnalystResult findConnected(int[] elementIDs,
                                  FacilityElementType elementType,
                                  FacilityAnalystResultOption option)
```
    连通性分析，返回与给定网络结点或弧段相连通的所有弧段。
    
    参数:
    
    elementIDs - 结点或弧段的 ID 列表。
    
    elementType - 待分析的设施要素的类型。可以是结点或者弧段。
    
    option - 设施网络分析结果设置。
    
    mapParameter - 输出的地图图片的参数。包括地图的范围、比例尺、背景透明等。
    
    返回:
    
    与分析结点/弧段连通的所有弧段。
  - findDisConnected
```
FacilityAnalystResult findDisConnected(int[] elementIDs,
                                     FacilityElementType elementType,
                                     FacilityAnalystResultOption option)
```
    不连通性分析，返回与给定网络结点或弧段不连通的所有弧段。
    
    参数:
    
    elementIDs - 结点或弧段的 ID 列表。
    
    elementType - 待分析的设施要素的类型。可以是结点或者弧段。
    
    option - 设施网络分析结果设置。
    
    mapParameter - 输出的地图图片的参数。包括地图的范围、比例尺、背景透明等。
    
    返回:
    
    与分析结点/弧段不连通的所有弧段。
  - findLoops
```
FacilityAnalystResult findLoops(int[] elementIDs,
                              FacilityElementType elementType,
                              FacilityAnalystResultOption option)
```
    查找环路，根据给定的弧段或结点，查找与这些弧段或结点连通的环路。
    
    参数:
    
    elementIDs - 结点或弧段的 ID 列表。
    
    elementType - 待分析的设施要素的类型。可以是结点或者弧段。
    
    option - 设施网络分析结果设置。
    
    mapParameter - 输出的地图图片的参数。包括地图的范围、比例尺、背景透明等。
    
    返回:
    
    与分析结点/弧段连通的所有环路。
  - findPath
```
FacilityAnalystResult findPath(int elementID,
                             FacilityElementType elementType,
                             FlowDirection direction,
                             java.lang.String weightName,
                             FacilityAnalystResultOption option)
```
    最短路径查找，可以查找上游最短路径，或者下游最短路径。
    
    参数:
    
    elementID - 结点或弧段的 ID 。
    
    elementType - 待分析的设施要素的类型。可以是结点或者弧段。
    
    direction -
    
    option - 设施网络分析结果设置。
    
    mapParameter - 输出的地图图片的参数。包括地图的范围、比例尺、背景透明等。
    
    返回:
    
    到上游或者下游最短路径的分析结果。
  - findPath
```
FacilityAnalystResult findPath(int fromElementID,
                             int endElementID,
                             FacilityElementType elementType,
                             java.lang.String weightName,
                             FacilityAnalystResultOption option)
```
    查找两个结点或弧段之间的最短路径。
    
    参数:
    
    fromElementID - 起始结点或弧段的ID。
    
    endElementID - 终止结点或弧段的ID。
    
    elementType - 待分析的设施要素的类型。可以是结点或者弧段。
    
    direction -
    
    weight - 路径分析的权值字段名。
    
    option - 设施网络分析结果设置。
    
    mapParameter - 输出的地图图片的参数。包括地图的范围、比例尺、背景透明等。
    
    返回:
    
    最短路径分析的结果。
  - trace
```
FacilityAnalystResult trace(int elementID,
                          FacilityElementType elementType,
                          FlowDirection direction,
                          FacilityAnalystResultOption option)
```
    追踪给定的分析结点/弧段到上游或者下游所流经的所有弧段。
    
    参数:
    
    elementID - 结点或弧段的 ID。
    
    elementType - 待分析的设施要素的类型。可以是结点或者弧段。
    
    direction - 路径查找的方向，可以是上游或者下游。
    
    option - 设施网络分析结果设置。
    
    mapParameter - 输出的地图图片的参数。包括地图的范围、比例尺、背景透明等。
    
    返回:
    
    追踪分析结果集。
  - findSink
```
FacilityAnalystResult findSink(int elementID,
                             FacilityElementType elementType,
                             FacilityAnalystResultOption option)
```
    查找最远的汇点。返回流经的所有弧段。
    
    参数:
    
    elementID - 结点或弧段的 ID。
    
    elementType - 待分析的设施要素的类型。可以是结点或者弧段。
    
    option - 设施网络分析结果设置。
    
    mapParameter - 输出的地图图片的参数。包括地图的范围、比例尺、背景透明等。
    
    返回:
    
    从分析要素到最远的汇点所流经的所有弧段。
  - findSource
```
FacilityAnalystResult findSource(int elementID,
                               FacilityElementType elementType,
                               FacilityAnalystResultOption option)
```
    查找最远的源点。返回流经的所有弧段。
    
    参数:
    
    elementID - 结点或弧段的 ID。
    
    elementType - 待分析的设施要素的类型。可以是结点或者弧段。
    
    option - 设施网络分析结果设置。
    
    mapParameter - 输出的地图图片的参数。包括地图的范围、比例尺、背景透明等。
    
    返回:
    
    流经的所有弧段。
  - getPrjCoordSys
```
PrjCoordSys getPrjCoordSys()
```
    获取网络数据集的投影信息。
    
    返回:
    
    网络数据集的投影信息。
  - getWeightNames
```
java.lang.String[] getWeightNames()
```
    获取权值字段的名称。
    
    返回:
    
    权值字段的名称。
  - findNode
```
Geometry findNode(Point2D point)
```
    根据给定的坐标点，找到与该坐标点距离最近的网络结点。
    
    参数:
    
    point - 给定的坐标点。
    
    返回:
    
    与该坐标点距离最近的网络结点。
  - findEdge
```
Geometry findEdge(Point2D point)
```
    根据给定的坐标点，找到与该坐标点距离最近的网络弧段。
    
    参数:
    
    point - 给定的坐标点。
    
    返回:
    
    与该坐标点距离最近的网络弧段。

值	意义
0	流向与线的方向相同
1	流向与线的方向相反
2	环路
3	不连通弧段

接口 FacilityAnalystProvider

方法概要

方法详细资料

checkLoops

findCommonAncestors

findCommonCatchements

findConnected

findDisConnected

findLoops

findPath

findPath

trace

findSink

findSource

getPrjCoordSys

getWeightNames

findNode

findEdge