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 对象构造一个与其完全相同的新对象。
 - 
方法概要所有方法 实例方法 具体方法 限定符和类型 方法和说明 voiddispose()释放对象所占用的资源。int[]getBarrierEdges()返回障碍弧段 ID 列表。int[]getBarrierNodes()返回障碍结点 ID 列表。Point2DsgetBarrierPoints()返回障碍结点的坐标列表。int[]getNodes()返回分析时途经结点 ID 的集合。Point2DsgetPoints()返回分析时途经点的集合。java.lang.StringgetTurnWeightField()返回转向权值字段。java.lang.StringgetWeightName()返回权值字段信息的名称。booleanisEdgesReturn()返回分析结果中是否包含途经弧段集合。booleanisNodesReturn()返回分析结果中是否包含途经结点的集合。booleanisPathGuidesReturn()返回分析结果中是否包含行驶导引集合。booleanisRoutesReturn()返回分析结果中是否包含路由(GeoLineM)对象的集合。booleanisStopIndexesReturn()返回分析结果中是否要包含站点索引的集合。voidsetBarrierEdges(int[] value)设置障碍弧段 ID 列表。voidsetBarrierNodes(int[] value)设置障碍结点 ID 列表。voidsetBarrierPoints(Point2Ds value)设置障碍结点的坐标列表。voidsetEdgesReturn(boolean value)设置分析结果中是否包含途经弧段的集合。voidsetNodes(int[] value)设置分析时途经结点 ID 的集合。voidsetNodesReturn(boolean value)设置分析结果中是否包含结点的集合。voidsetPathGuidesReturn(boolean value)设置分析结果中是否包含行驶导引集合。voidsetPoints(Point2Ds value)设置分析时途经点的集合。voidsetRoutesReturn(boolean value)设置分析结果中是否包含路由(GeoLineM)对象的集合。voidsetStopIndexesReturn(boolean value)设置分析结果中是否要包含站点索引的集合。voidsetTurnWeightField(java.lang.String value)设置转向权值字段。voidsetWeightName(java.lang.String value)设置权值字段信息的名称,即交通网络分析环境设置(TransportationAnalystSetting)中的权值字段信息集合(WeightFieldInfos)中的某一个权值字段信息对象(WeightFieldInfo)的getName()方法的返回值。
 
- 
- 
- 
构造器详细资料- 
TransportationAnalystParameterpublic TransportationAnalystParameter() 构造一个新的 TransportationAnalystParameter 对象。
 - 
TransportationAnalystParameterpublic TransportationAnalystParameter(TransportationAnalystParameter transportationAnalystParameter) 根据给定的 TransportationAnalystParameter 对象构造一个与其完全相同的新对象。- 参数:
- transportationAnalystParameter- 指定的 TransportationAnalystParameter 对象。
 
 
- 
 - 
方法详细资料- 
disposepublic void dispose() 释放对象所占用的资源。调用该方法之后,此对象不再可用。
 - 
isRoutesReturnpublic boolean isRoutesReturn() 返回分析结果中是否包含路由(GeoLineM)对象的集合。- 返回:
- 一个布尔值,表示分析结果中是否包含路由对象的集合。true 表示分析结果中包含路由结合,false 表示不包含。
- Default:
- 默认值为 false。
 
 - 
setRoutesReturnpublic void setRoutesReturn(boolean value) 设置分析结果中是否包含路由(GeoLineM)对象的集合。- 参数:
- value- 指定是否包含路由对象的集合。设置为 true,在分析成功后,可以从- TransportationAnalystResult对象的- getRoutes方法返回路由数组;为 false 则返回一个空的数组。
 
 - 
isNodesReturnpublic boolean isNodesReturn() 返回分析结果中是否包含途经结点的集合。- 返回:
- 一个布尔值,表示分析结果中是否包含途经结点的集合。true 表示分析结果中包含途经结点集合,false 表示不包含。
- Default:
- 默认值为 false。
 
 - 
setNodesReturnpublic void setNodesReturn(boolean value) 设置分析结果中是否包含结点的集合。- 参数:
- value- 指定分析结果中是否包含途经结点的集合。设置为 true,在分析成功后,可以从- TransportationAnalystResult对象的- getNodes方法返回途经结点数组;为 false 则返回一个空的数组。
 
 - 
isEdgesReturnpublic boolean isEdgesReturn() 返回分析结果中是否包含途经弧段集合。- 返回:
- 一个布尔值,表示分析结果中是否包含途经弧段集合。true 表示分析结果中包含途经弧段集合,false 表示不包含。
- Default:
- 默认值为 false。
 
 - 
setEdgesReturnpublic void setEdgesReturn(boolean value) 设置分析结果中是否包含途经弧段的集合。- 参数:
- value- 指定分析结果中是否包含经过弧段的集合。设置为 true,在分析成功后,可以从- TransportationAnalystResult对象的- getEdges方法返回途经弧段数组;为 false 则返回一个空的数组。
 
 - 
isPathGuidesReturnpublic boolean isPathGuidesReturn() 返回分析结果中是否包含行驶导引集合。- 返回:
- 一个布尔值,表示分析结果中是否包含行驶导引集合。true 表示分析结果中包含行驶导引集合,false 表示不包含。
- Default:
- 默认值为 false。
 
 - 
setPathGuidesReturnpublic void setPathGuidesReturn(boolean value) 设置分析结果中是否包含行驶导引集合。注意:必须将该方法设置为 true,并且通过 TransportationAnalystSetting 类的 setEdgeNameField方法设置了弧段名称字段,分析结果中才会包含行驶导引集合,否则将不会返回行驶导引,但不影响分析结果中其他内容的获取。- 参数:
- value- 指定分析结果中是否包含行驶导引集合。设置为 true,在分析成功后,可以从- TransportationAnalystResult对象的- getPathGuides方法返回行驶导引数组;为 false 则返回一个空的数组。
 
 - 
isStopIndexesReturnpublic boolean isStopIndexesReturn() 返回分析结果中是否要包含站点索引的集合。- 返回:
- 一个布尔值,表示分析结果中是否要包含站点索引的集合。true 表示分析结果中包含站点索引集合,false 表示不包含。
- Default:
- 默认值为 false。
 
 - 
setStopIndexesReturnpublic void setStopIndexesReturn(boolean value) 设置分析结果中是否要包含站点索引的集合。- 参数:
- value- 指定分析结果中是否要包含站点索引的集合。设置为 true,在分析成功后,可以从- TransportationAnalystResult对象的- getStopIndexes方法返回站点索引数组;为 false 则返回一个空的数组。
 
 - 
getNodespublic int[] getNodes() 返回分析时途经结点 ID 的集合。- 返回:
- 途经结点 ID 的集合。
- Default:
- 默认值为 null。
 
 - 
setNodespublic void setNodes(int[] value) 设置分析时途经结点 ID 的集合。必设,但与setPoints方法互斥,如果同时设置,则只有分析前最后的设置有效。例如,先指定了结点集合,又指定了坐标点集合,然后分析,此时只对坐标点进行分析。- 参数:
- value- 途经结点 ID 的集合。
 
 - 
getPointspublic Point2Ds getPoints() 返回分析时途经点的集合。- 返回:
- 途经点的集合。
- Default:
- 默认值为 null。
 
 - 
setPointspublic void setPoints(Point2Ds value) 设置分析时途经点的集合。必设,但与setNodes方法互斥,如果同时设置,则只有分析前最后的设置有效。例如,先指定了结点集合,又指定了坐标点集合,然后分析,此时只对坐标点进行分析。注意:如果设置的途经点集合中的点不在网络数据集的范围内,则该点不会参与分析。 - 参数:
- value- 途经点的集合。
 
 - 
getWeightNamepublic java.lang.String getWeightName() 返回权值字段信息的名称。- 返回:
- 权值字段信息的名字标识。
- Default:
- 默认值为一个空字符串。
 
 - 
setWeightNamepublic void setWeightName(java.lang.String value) 设置权值字段信息的名称,即交通网络分析环境设置(TransportationAnalystSetting)中的权值字段信息集合(WeightFieldInfos)中的某一个权值字段信息对象(WeightFieldInfo)的getName()方法的返回值。 分析时,如果未设置,则默认使用权值字段信息集合中的第一个权值字段信息对象的名称。- 参数:
- value- 权值字段信息的名字标识。
 
 - 
getBarrierNodespublic int[] getBarrierNodes() 返回障碍结点 ID 列表。- 返回:
- 障碍结点 ID 列表。
- Default:
- 默认值为 null。
 
 - 
setBarrierNodespublic void setBarrierNodes(int[] value) 设置障碍结点 ID 列表。可选。此处指定的障碍结点与交通网络分析环境(TransportationAnalystSetting)中指定的障碍结点共同作用于交通网络分析。- 参数:
- value- 障碍结点 ID 列表。
 
 - 
getBarrierEdgespublic int[] getBarrierEdges() 返回障碍弧段 ID 列表。- 返回:
- 障碍弧段 ID 列表。
- Default:
- 默认值为 null。
 
 - 
setBarrierEdgespublic void setBarrierEdges(int[] value) 设置障碍弧段 ID 列表。可选。此处指定的障碍弧段与交通网络分析环境(TransportationAnalystSetting)中指定的障碍弧段共同作用于交通网络分析。- 参数:
- value- 障碍弧段 ID 列表。
 
 - 
getBarrierPointspublic Point2Ds getBarrierPoints() 返回障碍结点的坐标列表。- 返回:
- 障碍结点的坐标集合。
 
 - 
setBarrierPointspublic void setBarrierPoints(Point2Ds value) 设置障碍结点的坐标列表。可选。指定的障碍点可以不在网络上(既不在弧段上也不在结点上),分析时将根据距离容限(setTolerance)把障碍点归结到最近的网络上。目前支持最佳路径分析、最近设施查找、旅行商分析和物流配送分析。- 参数:
- value- 障碍结点的坐标集合。
 
 - 
getTurnWeightFieldpublic java.lang.String getTurnWeightField() 返回转向权值字段。请参见 setTurnWeightField方法的介绍。- 返回:
- 转向权值字段。
- Default:
- 默认值为一个空字符串。
 
 - 
setTurnWeightFieldpublic void setTurnWeightField(java.lang.String value) 设置转向权值字段。可选。转向权值字段即转向表中表示转弯耗费的字段。此处指定的字段必须是在交通网络分析环境( TransportationAnalystSetting)中设置的转向权值字段集合(setTurnWeightFields)中的一个。关于转向表及转向耗费的相关介绍,请参阅SuperMap iDesktop帮助文档的网络分析相关介绍。 - 参数:
- value- 转向权值字段。
 
 
- 
 
-