com.supermap.realspace.networkanalyst
类 TransportationAnalystParameter3D

java.lang.Object
  com.supermap.realspace.networkanalyst.TransportationAnalystParameter3D

public class TransportationAnalystParameter3D
extends java.lang.Object

三维交通网络分析参数类。该类用于设置三维交通网络分析所需的各种参数，如分析时途经的结点（或任意点）的集合、权值信息、障碍点和障碍弧段，以及分析结果中是否包含途经结点集合、经过弧段集合、路由对象等。

构造方法摘要

TransportationAnalystParameter3D()
构造一个新的 TransportationAnalystParameter3D 对象。

TransportationAnalystParameter3D(TransportationAnalystParameter3D transportationAnalystParameter)
根据给定的 TransportationAnalystParameter3D 对象构造一个与其完全相同的新对象。

方法摘要

void	dispose() 释放对象所占用的资源。
int[]	getBarrierEdges() 返回障碍弧段 ID 列表。
int[]	getBarrierNodes() 返回障碍结点 ID 列表。
Point3Ds	getBarrierPoints() 返回障碍结点的坐标列表。
int[]	getNodes() 返回分析时途经结点 ID 的集合。
Point3Ds	getPoints() 返回分析时途经点的集合。
java.lang.String	getWeightName() 返回权值字段信息的名称。
boolean	isEdgesReturn() 返回分析结果中是否包含经过弧段的集合。
boolean	isNodesReturn() 返回分析结果中是否包含途经结点的集合。
boolean	isRoutesReturn() 返回分析结果中是否包含路由（GeoLineM）对象的集合。
boolean	isStopIndexesReturn() 返回分析结果中是否包含站点索引的集合。
void	setBarrierEdges(int[] value) 设置障碍弧段 ID 列表。
void	setBarrierNodes(int[] value) 设置障碍结点 ID 列表。
void	setBarrierPoints(Point3Ds value) 设置障碍结点的坐标列表。
void	setEdgesReturn(boolean value) 设置分析结果中是否包含经过弧段的集合。
void	setNodes(int[] value) 设置分析时途经结点 ID 的集合。
void	setNodesReturn(boolean value) 设置分析结果中是否包含途经结点的集合。
void	setPoints(Point3Ds value) 设置分析时途经点的集合。
void	setRoutesReturn(boolean value) 设置分析结果中是否包含路由（GeoLineM）对象的集合。
void	setStopIndexesReturn(boolean value) 设置分析结果中是否要包含站点索引的集合。
void	setWeightName(java.lang.String value) 设置权值字段信息的名称，即三维交通网络分析环境设置（TransportationAnalystSetting3D）中的权值字段信息集合（WeightFieldInfos3D）中的某一个权值字段信息对象（WeightFieldInfo3D）的 getName() 方法的返回值。

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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

TransportationAnalystParameter3D

public TransportationAnalystParameter3D()

构造一个新的 TransportationAnalystParameter3D 对象。

TransportationAnalystParameter3D

public TransportationAnalystParameter3D(TransportationAnalystParameter3D transportationAnalystParameter)

根据给定的 TransportationAnalystParameter3D 对象构造一个与其完全相同的新对象。

参数：

transportationAnalystParameter - 指定的 TransportationAnalystParameter3D 对象。

方法详细信息

getWeightName

public java.lang.String getWeightName()

返回权值字段信息的名称。

返回：

权值字段信息的名称。

默认值:

默认值为一个空字符串。

setWeightName

public void setWeightName(java.lang.String value)

设置权值字段信息的名称，即三维交通网络分析环境设置（TransportationAnalystSetting3D）中的权值字段信息集合（WeightFieldInfos3D）中的某一个权值字段信息对象（WeightFieldInfo3D）的 getName() 方法的返回值。分析时，如果未设置，则默认使用权值字段信息集合中的第一个权值字段信息对象的名称。

参数：

value - 权值字段信息的名称。

getNodes

public int[] getNodes()

返回分析时途经结点 ID 的集合。

返回：

途经结点 ID 的集合。

默认值:

默认值为 null。

setNodes

public void setNodes(int[] value)

设置分析时途经结点 ID 的集合。必设，但与 setPoints 方法互斥，如果同时设置，则只有分析前最后的设置有效。例如，先指定了结点集合，又指定了坐标点集合，然后分析，此时只对坐标点进行分析。

参数：

value - 途经结点 ID 的集合。

getPoints

public Point3Ds getPoints()

返回分析时途经点的集合。

返回：

途经点的集合。

默认值:

默认值为 null。

setPoints

public void setPoints(Point3Ds value)

设置分析时途经点的集合。必设，但与 setNodes 方法互斥，如果同时设置，则只有分析前最后的设置有效。例如，先指定了结点集合，又指定了坐标点集合，然后分析，此时只对坐标点进行分析。

注意：如果设置的途经点集合中的点不在网络数据集的范围内，则该点不会参与分析。

参数：

value - 途经点的集合。

getBarrierNodes

public int[] getBarrierNodes()

返回障碍结点 ID 列表。

返回：

障碍结点 ID 列表。

默认值:

默认值为 null。

setBarrierNodes

public void setBarrierNodes(int[] value)

设置障碍结点 ID 列表。可选。此处指定的障碍结点与三维交通网络分析环境（TransportationAnalystSetting3D）中指定的障碍结点共同作用于三维交通网络分析。

参数：

value - 障碍结点 ID 列表。

getBarrierEdges

public int[] getBarrierEdges()

返回障碍弧段 ID 列表。

返回：

障碍弧段 ID 列表。

默认值:

默认值为 null。

setBarrierEdges

public void setBarrierEdges(int[] value)

设置障碍弧段 ID 列表。可选。此处指定的障碍弧段与三维交通网络分析环境（TransportationAnalystSetting3D）中指定的障碍弧段共同作用于三维交通网络分析。

参数：

value - 障碍弧段 ID 列表。

getBarrierPoints

public Point3Ds getBarrierPoints()

返回障碍结点的坐标列表。

返回：

障碍结点的坐标集合。

默认值:

默认值为 null。

setBarrierPoints

public void setBarrierPoints(Point3Ds value)

设置障碍结点的坐标列表。可选。指定的障碍点可以不在网络上（既不在弧段上也不在结点上），分析时将根据距离容限（setTolerance）把障碍点归结到最近的网络上。

参数：

value - 障碍结点的坐标集合。

isNodesReturn

public boolean isNodesReturn()

返回分析结果中是否包含途经结点的集合。

返回：

一个布尔值，表示分析结果中是否包含途经结点的集合。true 表示分析结果中包含结点集合，false 表示不包含。

默认值:

默认值为 false。

setNodesReturn

public void setNodesReturn(boolean value)

设置分析结果中是否包含途经结点的集合。

参数：

value - 指定分析结果中是否包含途经结点的集合。设置为 true，在分析成功后，可以从 TransportationAnalystResult3D 对象的 getNodes 方法返回途经结点集合；为 false 则返回一个空的数组。

isEdgesReturn

public boolean isEdgesReturn()

返回分析结果中是否包含经过弧段的集合。

返回：

一个布尔值，表示分析结果中是否包含经过弧段的集合。true 表示分析结果中包含经过弧段的集合，false 表示不包含。

默认值:

默认值为 false。

setEdgesReturn

public void setEdgesReturn(boolean value)

设置分析结果中是否包含经过弧段的集合。

参数：

value - 指定分析结果中是否包含经过弧段的集合。设置为 true，在分析成功后，可以从 TransportationAnalystResult3D 对象的 getEdges 方法返回途经弧段集合；为 false 则返回一个空的数组。

isRoutesReturn

public boolean isRoutesReturn()

返回分析结果中是否包含路由（GeoLineM）对象的集合。

返回：

指定是否包含路由对象的集合。返回 true，表示分析结果中包含路由对象集合，返回 false 表示不包含。

默认值:

默认值为 false。

setRoutesReturn

public void setRoutesReturn(boolean value)

设置分析结果中是否包含路由（GeoLineM）对象的集合。

参数：

value - 指定是否包含路由对象的集合。设置为 true，在分析成功后，可以从 TransportationAnalystResult3D 对象的 getRoutes 方法返回路由集合；为 false 则返回一个空的数组。

isStopIndexesReturn

public boolean isStopIndexesReturn()

返回分析结果中是否包含站点索引的集合。

返回：

指定分析结果中是否包含站点索引的集合。返回 true，表示分析结果中包含站点索引集合，返回 false 表示不包含。

默认值:

默认值为 false。

setStopIndexesReturn

public void setStopIndexesReturn(boolean value)

设置分析结果中是否要包含站点索引的集合。

参数：

value - 指定分析结果中是否要包含站点索引的集合。设置为 true，在分析成功后，可以从 TransportationAnalystResult3D 对象的 getStopIndexes 方法返回站点索引集合；为 false 则返回一个空的数组。

dispose

public void dispose()

释放对象所占用的资源。调用该方法之后，此对象不再可用。