com.supermap.analyst.networkanalyst
类 TransportationAnalystParameter

java.lang.Object
  com.supermap.analyst.networkanalyst.TransportationAnalystParameter

public class TransportationAnalystParameter
extends java.lang.Object

交通网络分析参数设置类。

该类主要用来对交通网络分析的参数进行设置。通过交通网络分析参数设置类可以设置障碍边、障碍点、权值字段信息的名字标识、转向权值字段、分析途径的点或结点，还可以对分析结果进行一些设置，即在分析结果中是否包含分析途经的以下内容：结点集合，弧段集合，路由对象集合以及站点集合。

构造方法摘要

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

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

方法摘要

void	dispose() 释放对象所占用的资源。
int[]	getBarrierEdges() 返回障碍弧段 ID 列表。
int[]	getBarrierNodes() 返回障碍结点 ID 列表。
Point2Ds	getBarrierPoints() 返回障碍结点的坐标列表。
int[]	getNodes() 返回分析时途经结点 ID 的集合。
Point2Ds	getPoints() 返回分析时途经点的集合。
double	getServiceBufferRadius() 返回服务区缓冲半径。
ServiceType	getServiceType() 返回服务区类型。
java.lang.String	getTurnWeightField() 返回转向权值字段。
int[][]	getUCross() 返回U型道路禁行限制。
java.lang.String	getWeightName() 返回权值字段信息的名称。
boolean	isEdgesReturn() 返回分析结果中是否包含途经弧段集合。
boolean	isNodesReturn() 返回分析结果中是否包含途经结点的集合。
boolean	isPathGuidesReturn() 返回分析结果中是否包含行驶导引集合。
boolean	isRoutesReturn() 返回分析结果中是否包含路由（GeoLineM）对象的集合。
boolean	isStopIndexesReturn() 返回分析结果中是否要包含站点索引的集合。
void	setBarrierEdges(int[] value) 设置障碍弧段 ID 列表。
void	setBarrierNodes(int[] value) 设置障碍结点 ID 列表。
void	setBarrierPoints(Point2Ds value) 设置障碍结点的坐标列表。
void	setEdgesReturn(boolean value) 设置分析结果中是否包含途经弧段的集合。
void	setNodes(int[] value) 设置分析时途经结点 ID 的集合。
void	setNodesReturn(boolean value) 设置分析结果中是否包含结点的集合。
void	setPathGuidesReturn(boolean value) 设置分析结果中是否包含行驶导引集合。
void	setPoints(Point2Ds value) 设置分析时途经点的集合。
void	setRoutesReturn(boolean value) 设置分析结果中是否包含路由（GeoLineM）对象的集合。
void	setServiceBufferRadius(double radius) 设置服务区缓冲半径。
void	setServiceType(ServiceType value) 设置服务区类型。
void	setStopIndexesReturn(boolean value) 设置分析结果中是否要包含站点索引的集合。
void	setTurnWeightField(java.lang.String value) 设置转向权值字段。
void	setUCross(int[][] value) 设置U型道路禁行限制。
void	setWeightName(java.lang.String value) 设置权值字段信息的名称，即交通网络分析环境设置（TransportationAnalystSetting）中的权值字段信息集合（WeightFieldInfos）中的某一个权值字段信息对象（WeightFieldInfo）的 getName() 方法的返回值。

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

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

构造方法详细信息

TransportationAnalystParameter

public TransportationAnalystParameter()

构造一个新的 TransportationAnalystParameter 对象。

TransportationAnalystParameter

public TransportationAnalystParameter(TransportationAnalystParameter transportationAnalystParameter)

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

参数：

transportationAnalystParameter - 指定的 TransportationAnalystParameter 对象。

方法详细信息

getWeightName

public java.lang.String getWeightName()

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

返回：

权值字段信息的名字标识。

默认值:

默认值为一个空字符串。

setWeightName

public void setWeightName(java.lang.String value)

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

参数：

value - 权值字段信息的名字标识。

getNodes

public int[] getNodes()

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

返回：

途经结点 ID 的集合。

默认值:

默认值为 null。

setNodes

public void setNodes(int[] value)

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

参数：

value - 途经结点 ID 的集合。

getPoints

public Point2Ds getPoints()

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

返回：

途经点的集合。

默认值:

默认值为 null。

setPoints

public void setPoints(Point2Ds value)

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

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

参数：

value - 途经点的集合。

getBarrierNodes

public int[] getBarrierNodes()

返回障碍结点 ID 列表。

返回：

障碍结点 ID 列表。

默认值:

默认值为 null。

setBarrierNodes

public void setBarrierNodes(int[] value)

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

参数：

value - 障碍结点 ID 列表。

getBarrierEdges

public int[] getBarrierEdges()

返回障碍弧段 ID 列表。

返回：

障碍弧段 ID 列表。

默认值:

默认值为 null。

setBarrierEdges

public void setBarrierEdges(int[] value)

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

参数：

value - 障碍弧段 ID 列表。

getBarrierPoints

public Point2Ds getBarrierPoints()

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

返回：

障碍结点的坐标集合。

setBarrierPoints

public void setBarrierPoints(Point2Ds value)

设置障碍结点的坐标列表。可选。指定的障碍点可以不在网络上（既不在弧段上也不在结点上），分析时将根据距离容限（setTolerance）把障碍点归结到最近的网络上。目前支持最佳路径分析、最近设施查找、旅行商分析和物流配送分析。

参数：

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

getTurnWeightField

public java.lang.String getTurnWeightField()

返回转向权值字段。

请参见 setTurnWeightField 方法的介绍。

返回：

转向权值字段。

默认值:

默认值为一个空字符串。

setTurnWeightField

public void setTurnWeightField(java.lang.String value)

设置转向权值字段。可选。

转向权值字段即转向表中表示转弯耗费的字段。此处指定的字段必须是在交通网络分析环境（TransportationAnalystSetting）中设置的转向权值字段集合（setTurnWeightFields）中的一个。

关于转向表及转向耗费的相关介绍，NetworkBuilder 类的 createTurnBuilder 方法。

参数：

value - 转向权值字段。

isNodesReturn

public boolean isNodesReturn()

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

返回：

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

默认值:

默认值为 false。

setNodesReturn

public void setNodesReturn(boolean value)

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

参数：

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

isEdgesReturn

public boolean isEdgesReturn()

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

返回：

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

默认值:

默认值为 false。

setEdgesReturn

public void setEdgesReturn(boolean value)

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

参数：

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

isPathGuidesReturn

public boolean isPathGuidesReturn()

返回分析结果中是否包含行驶导引集合。

返回：

一个布尔值，表示分析结果中是否包含行驶导引集合。true 表示分析结果中包含行驶导引集合，false 表示不包含。

默认值:

默认值为 false。

setPathGuidesReturn

public void setPathGuidesReturn(boolean value)

设置分析结果中是否包含行驶导引集合。

注意：必须将该方法设置为 true，并且通过 TransportationAnalystSetting 类的 setEdgeNameField 方法设置了弧段名称字段，分析结果中才会包含行驶导引集合，否则将不会返回行驶导引，但不影响分析结果中其他内容的获取。

参数：

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

isRoutesReturn

public boolean isRoutesReturn()

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

返回：

一个布尔值，表示分析结果中是否包含路由对象的集合。true 表示分析结果中包含路由结合，false 表示不包含。

默认值:

默认值为 false。

setRoutesReturn

public void setRoutesReturn(boolean value)

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

参数：

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

isStopIndexesReturn

public boolean isStopIndexesReturn()

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

返回：

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

默认值:

默认值为 false。

setStopIndexesReturn

public void setStopIndexesReturn(boolean value)

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

参数：

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

dispose

public void dispose()

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

getUCross

public int[][] getUCross()

返回U型道路禁行限制。

返回：

U型道路禁行限制。

setUCross

public void setUCross(int[][] value)

设置U型道路禁行限制。该禁行限制针对相邻的3个弧段而设计的，表示在一次分析中，结果道路不能顺次的经过这3条弧段。该设置为二维数组，第一维表示有多少组禁行限制，第二维表示每一组禁行限制的弧段ID（注意每一组禁行限制弧段ID数必须等于3，不等于3的限制是不起作用的）。每一组的3个弧段ID必须是相邻的弧段。

参数：

value - U型道路禁行限制。

getServiceType

public ServiceType getServiceType()

返回服务区类型。

返回：

服务区类型。默认值为ServiceType.SIMPLEAREA。

setServiceType

public void setServiceType(ServiceType value)

设置服务区类型。该设置用在服务区分析时，根据服务区类型的不同构造出不同服务区面，默认值为ServiceType.SIMPLEAREA。

参数：

value - 服务区类型。

getServiceBufferRadius

public double getServiceBufferRadius()

返回服务区缓冲半径。

返回：

服务区缓冲半径。默认单位为米。

setServiceBufferRadius

public void setServiceBufferRadius(double radius)

设置服务区缓冲半径。

参数：

radius - 服务区缓冲半径。