com.supermap.analyst.networkanalyst
类 MultiTransportationAnalystParameter

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

public class MultiTransportationAnalystParameter
extends java.lang.Object

多路网数据集分析参数设置类。

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

构造方法摘要

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

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

方法摘要

void	dispose() 释放该对象所占用的资源。
MultiTransportationAnalystPoint[]	getPoints() 返回分析时途经点的集合。
java.lang.String	getTurnWeightField() 返回转向权值字段。
java.lang.String	getWeightName() 返回权值字段信息的名称。
boolean	isEdgesReturn() 返回分析结果中是否包含途经弧段集合。
boolean	isNodesReturn() 返回分析结果中是否包含途经结点的集合。
boolean	isPathGuidesReturn() 返回分析结果中是否包含行驶导引集合。
boolean	isRoutesReturn() 返回分析结果中是否包含路由（GeoLineM）对象的集合。
boolean	isStopIndexesReturn() 返回分析结果中是否要包含站点索引的集合。
void	setEdgesReturn(boolean value) 设置分析结果中是否包含途经弧段的集合。
void	setNodesReturn(boolean value) 设置分析结果中是否包含结点的集合。
void	setPathGuidesReturn(boolean value) 设置分析结果中是否包含行驶导引集合。
void	setPoints(MultiTransportationAnalystPoint[] value) 设置分析时途经点的集合。
void	setRoutesReturn(boolean value) 设置分析结果中是否包含路由（GeoLineM）对象的集合。
void	setStopIndexesReturn(boolean value) 设置分析结果中是否要包含站点索引的集合。
void	setTurnWeightField(java.lang.String value) 设置转向权值字段。
void	setWeightName(java.lang.String value) 设置权值字段信息的名称，即多网络分析环境设置（MultiTransportationAnalystSetting）中的权值字段信息集合（WeightFieldInfos）中的某一个权值字段信息对象（WeightFieldInfo）的 getName() 方法的返回值。

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

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

构造方法详细信息

MultiTransportationAnalystParameter

public MultiTransportationAnalystParameter()

构造一个新的MultiTransportationAnalystParameter 对象。

MultiTransportationAnalystParameter

public MultiTransportationAnalystParameter(MultiTransportationAnalystParameter transportationAnalystParameter)

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

参数：

MultiTransportationAnalystParameter - 给定的多路网分析参数对象。

方法详细信息

dispose

public void dispose()

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

isRoutesReturn

public boolean isRoutesReturn()

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

返回：

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

默认值:

默认值为 false。

setRoutesReturn

public void setRoutesReturn(boolean value)

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

参数：

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

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，并且通过 MultiTransportationAnalystSetting 类的 setEdgeNameField 方法设置了弧段名称字段，分析结果中才会包含行驶导引集合，否则将不会返回行驶导引，但不影响分析结果中其他内容的获取。

参数：

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

isStopIndexesReturn

public boolean isStopIndexesReturn()

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

返回：

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

默认值:

默认值为 false。

setStopIndexesReturn

public void setStopIndexesReturn(boolean value)

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

参数：

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

getPoints

public MultiTransportationAnalystPoint[] getPoints()

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

返回：

途经点的集合。

默认值:

默认值为 null。

setPoints

public void setPoints(MultiTransportationAnalystPoint[] value)

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

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

参数：

value - 途经点的集合。

getWeightName

public java.lang.String getWeightName()

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

返回：

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

默认值:

默认值为一个空字符串。

setWeightName

public void setWeightName(java.lang.String value)

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

参数：

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

getTurnWeightField

public java.lang.String getTurnWeightField()

返回转向权值字段。

返回：

转向权值字段。

默认值:

默认值为一个空字符串。

setTurnWeightField

public void setTurnWeightField(java.lang.String value)

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

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

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

参数：

value - 转向权值字段。