FacilityAnalystSetting3D (iObjects Java Help)

java.lang.Object
- com.supermap.realspace.networkanalyst.FacilityAnalystSetting3D

```
public class FacilityAnalystSetting3D
extends Object
```
三维设施网络分析环境设置类。该类用于提供三维设施网络分析时所需的所有参数信息，包括三维网络数据集、流向字段、障碍弧段和障碍结点、权值信息等。这些参数的设置直接影响着三维设施网络分析的结果。

构造器概要

构造器
构造器和说明
`FacilityAnalystSetting3D()` 构造一个新的 FacilityAnalystSetting3D 对象。
`FacilityAnalystSetting3D(FacilityAnalystSetting3D facilityAnalystSetting)` 根据给定的 FacilityAnalystSetting3D 对象构造一个与其完全相同的新对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`int[]`	`getBarrierEdges()` 返回障碍弧段的 ID 列表。
`int[]`	`getBarrierNodes()` 返回障碍结点的 ID 列表。
`String`	`getDirectionField()` 返回三维网络数据集的流向字段。
`String`	`getEdgeIDField()` 返回三维网络数据集中标识弧段 ID 的字段。
`String`	`getFNodeIDField()` 返回三维网络数据集中标识弧段起始结点 ID 的字段。
`DatasetVector`	`getNetworkDataset()` 返回用于分析的三维网络数据集。
`String`	`getNodeIDField()` 返回三维网络数据集中标识结点 ID 的字段。
`String`	`getTNodeIDField()` 返回三维网络数据集中标识弧段终止结点 ID 的字段。
`double`	`getTolerance()` 返回点到弧段的距离容限。
`WeightFieldInfos3D`	`getWeightFieldInfos()` 返回权值字段信息集合对象。
`void`	`setBarrierEdges(int[] edges)` 设置障碍弧段的 ID 列表。
`void`	`setBarrierNodes(int[] nodes)` 设置障碍结点的 ID 列表。
`void`	`setDirectionField(String directionField)` 设置三维网络数据集的流向字段。
`void`	`setEdgeIDField(String edgeIDfield)` 设置三维网络数据集中标识弧段 ID 的字段。
`void`	`setFNodeIDField(String fNodeIDField)` 设置三维网络数据集中标识弧段起始结点 ID 的字段。
`void`	`setNetworkDataset(DatasetVector datasetVector)` 设置用于分析的三维网络数据集。
`void`	`setNodeIDField(String nodeIDField)` 设置三维网络数据集中标识结点 ID 的字段。
`void`	`setTNodeIDField(String tNodeIDField)` 设置三维网络数据集中标识弧段终止结点 ID 的字段。
`void`	`setTolerance(double tolerance)` 设置点到弧段的距离容限。
`void`	`setWeightFieldInfos(WeightFieldInfos3D weightFieldInfos)` 设置权值字段信息集合对象。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - FacilityAnalystSetting3D
```
public FacilityAnalystSetting3D()
```
    构造一个新的 FacilityAnalystSetting3D 对象。
  - FacilityAnalystSetting3D
```
public FacilityAnalystSetting3D(FacilityAnalystSetting3D facilityAnalystSetting)
```
    根据给定的 FacilityAnalystSetting3D 对象构造一个与其完全相同的新对象。
    
    参数:
    
    facilityAnalystSetting - 指定的 FacilityAnalystSetting3D 对象。
- 方法详细资料
  - getBarrierEdges
```
public int[] getBarrierEdges()
```
    返回障碍弧段的 ID 列表。
    
    返回:
    
    障碍弧段的 ID 列表。
    
    默认值:
    
    默认值为 null。
  - setBarrierEdges
```
public void setBarrierEdges(int[] edges)
```
    设置障碍弧段的 ID 列表。可选。
    一条边一旦被设置为障碍边，就表示这条边在分析过程中是禁行的。障碍边可以在分析过程中动态设置，不影响效率。
    
    参数:
    
    edges - 障碍弧段的 ID 列表。
  - getBarrierNodes
```
public int[] getBarrierNodes()
```
    返回障碍结点的 ID 列表。
    
    返回:
    
    障碍结点的 ID 列表。
    
    默认值:
    
    默认值为 null。
  - setBarrierNodes
```
public void setBarrierNodes(int[] nodes)
```
    设置障碍结点的 ID 列表。可选。
    同障碍边意义相同，障碍点是网络中禁止通行的点，但其所设置的障碍是网络结点。
    
    参数:
    
    nodes - 障碍结点的 ID 列表。
  - getNetworkDataset
```
public DatasetVector getNetworkDataset()
```
    返回用于分析的三维网络数据集。
    
    返回:
    
    三维网络数据集。
    
    默认值:
    
    默认值为 null。
  - setNetworkDataset
```
public void setNetworkDataset(DatasetVector datasetVector)
```
    设置用于分析的三维网络数据集。必设。
    
    参数:
    
    datasetVector - 用于分析的三维网络数据集。
  - getDirectionField
```
public String getDirectionField()
```
    返回三维网络数据集的流向字段。
    
    返回:
    
    三维网络数据集的流向字段。
    
    默认值:
    
    默认值为 null。
  - setDirectionField
```
public void setDirectionField(String directionField)
```
    设置三维网络数据集的流向字段。如果不指定，在进行三维设施网络分析时，默认流向均为 0，即与数字化方向相同。在创建流向时，必须通过该方法指定流向字段。
    
    参数:
    
    directionField - 三维网络数据集的流向字段。
  - getEdgeIDField
```
public String getEdgeIDField()
```
    返回三维网络数据集中标识弧段 ID 的字段。
    
    返回:
    
    三维网络数据集中标识弧段 ID 的字段。
    
    默认值:
    
    默认值为 "SmID"。
  - setEdgeIDField
```
public void setEdgeIDField(String edgeIDfield)
```
    设置三维网络数据集中标识弧段 ID 的字段。必须正确设定标识弧段 ID 的字段。仅支持 16 位整型、32 位整型字段。
    
    参数:
    
    edgeIDfield - 三维网络数据集中标识弧段 ID 的字段。
  - getFNodeIDField
```
public String getFNodeIDField()
```
    返回三维网络数据集中标识弧段起始结点 ID 的字段。
    
    返回:
    
    三维网络数据集中标识弧段起始结点 ID 的字段。
    
    默认值:
    
    默认值为 "SmFNode"。
  - setFNodeIDField
```
public void setFNodeIDField(String fNodeIDField)
```
    设置三维网络数据集中标识弧段起始结点 ID 的字段。必须正确设定标识弧段起始结点 ID 的字段。仅支持 16 位整型、32 位整型字段。
    
    参数:
    
    fNodeIDField - 三维网络数据集中标识弧段起始结点 ID 的字段。
  - getNodeIDField
```
public String getNodeIDField()
```
    返回三维网络数据集中标识结点 ID 的字段。
    
    返回:
    
    三维网络数据集中标识结点 ID 的字段。
    
    默认值:
    
    默认值为 "SmNodeID"。
  - setNodeIDField
```
public void setNodeIDField(String nodeIDField)
```
    设置三维网络数据集中标识结点 ID 的字段。必须正确设定标识结点 ID 的字段。仅支持 16 位整型、32 位整型字段。
    
    参数:
    
    nodeIDField - 三维网络数据集中标识结点 ID 的字段。
  - getTNodeIDField
```
public String getTNodeIDField()
```
    返回三维网络数据集中标识弧段终止结点 ID 的字段。
    
    返回:
    
    三维网络数据集中标识弧段终止结点 ID 的字段。
    
    默认值:
    
    默认值为 "SmTNode"。
  - setTNodeIDField
```
public void setTNodeIDField(String tNodeIDField)
```
    设置三维网络数据集中标识弧段终止结点 ID 的字段。必须正确设定标识弧段终止结点 ID 的字段。仅支持 16 位整型、32 位整型字段。
    
    参数:
    
    tNodeIDField - 三维网络数据集中标识弧段终止结点 ID 的字段。
  - getTolerance
```
public double getTolerance()
```
    返回点到弧段的距离容限。单位为米。
    有关点到弧段的距离容限，请参见 setTolerance 方法的介绍。
    
    返回:
    
    点到弧段的距离容限。
    
    默认值:
    
    默认值为 0.0。
  - setTolerance
```
public void setTolerance(double tolerance)
```
    设置点到弧段的距离容限。单位为米。
    原则上，网络分析中可以指定网络中任意的点作为路径分析中的一个站点，站点应该在网络附近。如果这个点不在网络上（既不在弧段上也不在结点上），网络分析会根据该距离容限把站点归结到网络上。
    如下图所示，桔色点代表网络结点，蓝色代表弧段，灰色点为站点，红色线段是站点到弧段 AB 的距离，如果该距离在设定的距离容限内，则把站点归结到弧段 AB 上。
    
    设置合适的距离容限值才能保证网络分析的正常进行，距离容限值的计算方法：
    1. 计算出网络数据集中包含所有对象的最小外接矩形；
    2. 计算出该矩形对象的高度及宽度；
    3. 取两者中的较小值除以40，得出较合适的距离容限值。
    参数:
    
    tolerance - 点到弧段的距离容限。
  - getWeightFieldInfos
```
public WeightFieldInfos3D getWeightFieldInfos()
```
    返回权值字段信息集合对象。
    
    返回:
    
    权值字段信息集合对象。
    
    默认值:
    
    默认值为包含一个元素的 WeightFieldInfos3D 对象。该元素的名称为“Length”，正向阻力字段和反向阻力字段都为“SmLength”。
  - setWeightFieldInfos
```
public void setWeightFieldInfos(WeightFieldInfos3D weightFieldInfos)
```
    设置权值字段信息集合对象。
    
    参数:
    
    weightFieldInfos - 权值字段信息集合对象。

类 FacilityAnalystSetting3D

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

FacilityAnalystSetting3D

FacilityAnalystSetting3D

方法详细资料

getBarrierEdges

setBarrierEdges

getBarrierNodes

setBarrierNodes

getNetworkDataset

setNetworkDataset

getDirectionField

setDirectionField

getEdgeIDField

setEdgeIDField

getFNodeIDField

setFNodeIDField

getNodeIDField

setNodeIDField

getTNodeIDField

setTNodeIDField

getTolerance

setTolerance

getWeightFieldInfos

setWeightFieldInfos