com.supermap.analyst.networkanalyst
类 VRPAnalystParameter
- java.lang.Object
-
- com.supermap.data.InternalHandle
-
- com.supermap.data.InternalHandleDisposable
-
- com.supermap.analyst.networkanalyst.VRPAnalystParameter
-
- 所有已实现的接口:
- IDisposable
public class VRPAnalystParameter extends com.supermap.data.InternalHandleDisposable物流配送分析参数设置类。
该类主要用来对物流配送分析的参数进行设置。通过交通网络分析参数设置类可以设置障碍边、障碍点、权值字段信息的名字标识、转向权值字段,还可以对分析结果进行一些设置,即在分析结果中是否包含分析途经的以下内容:结点集合,弧段集合,路由对象集合以及站点集合。
-
-
构造器概要
构造器 构造器和说明 VRPAnalystParameter()构造一个新的 VRPAnalystParameter 对象。VRPAnalystParameter(VRPAnalystParameter analystParameter)根据给定的 VRPAnalystParameter 对象构造一个与其完全相同的新对象。
-
方法概要
所有方法 实例方法 具体方法 限定符和类型 方法和说明 voiddispose()释放对象所占用的资源。AnalystTypegetAnalystType()返回物流分析中的分析模式。int[]getBarrierEdges()返回障碍弧段 ID 列表。int[]getBarrierNodes()返回障碍结点 ID 列表。Point2DsgetBarrierPoints()返回障碍结点的坐标列表。intgetRouteCount()返回一次分析中派出车辆数目值。StringgetTimeWeight()返回时间字段信息的名称。StringgetTurnWeightField()返回转向权值字段。VRPDirectionTypegetVRPDirectionType()返回物流分析路线的类型。StringgetWeightName()返回权值字段信息的名称。booleanisEdgesReturn()返回分析结果中是否包含途经弧段集合。booleanisNodesReturn()返回分析结果中是否包含途经结点的集合。booleanisPathGuidesReturn()返回分析结果中是否包含行驶导引集合。booleanisRoutesReturn()返回分析结果中是否包含路由(GeoLineM)对象的集合。booleanisStopIndexesReturn()返回分析结果中是否要包含站点索引的集合。voidsetAnalystType(AnalystType value)设置物流分析模式,包括LEASTCOST最小耗费模式(默认值)、AVERAGECOST平均耗费模式、AREAANALYST区域分析模式。voidsetBarrierEdges(int[] value)设置障碍弧段 ID 列表。voidsetBarrierNodes(int[] value)设置障碍结点 ID 列表。voidsetBarrierPoints(Point2Ds value)设置障碍结点的坐标列表。voidsetEdgesReturn(boolean value)设置分析结果中是否包含途经弧段的集合。voidsetNodesReturn(boolean value)设置分析结果中是否包含结点的集合。voidsetPathGuidesReturn(boolean value)设置分析结果中是否包含行驶导引集合。voidsetRouteCount(int value)设置一次分析中派出车辆数目值。voidsetRoutesReturn(boolean value)设置分析结果中是否包含路由(GeoLineM)对象的集合。voidsetStopIndexesReturn(boolean value)设置分析结果中是否要包含站点索引的集合。voidsetTimeWeight(String value)设置时间字段信息的名称。voidsetTurnWeightField(String value)设置转向权值字段。voidsetVRPDirectionType(VRPDirectionType value)设置物流分析路线的类型,包括ROUNDROUTE从中心点出发并回到中心点(默认值)、STARTBYCENTER从中心点出发但不回到中心点、ENDBYCENTER不从中心点出发但回到中心点。voidsetWeightName(String value)设置权值字段信息的名称,即交通网络分析环境设置(TransportationAnalystSetting)中的权值字段信息集合(WeightFieldInfos)中的某一个权值字段信息对象(WeightFieldInfo)的getName()方法的返回值。
-
-
-
构造器详细资料
-
VRPAnalystParameter
public VRPAnalystParameter()
构造一个新的 VRPAnalystParameter 对象。
-
VRPAnalystParameter
public VRPAnalystParameter(VRPAnalystParameter analystParameter)
根据给定的 VRPAnalystParameter 对象构造一个与其完全相同的新对象。- 参数:
analystParameter- 指定的 VRPAnalystParameter 对象。
-
-
方法详细资料
-
dispose
public void dispose()
释放对象所占用的资源。调用该方法之后,此对象不再可用。
-
isRoutesReturn
public boolean isRoutesReturn()
返回分析结果中是否包含路由(GeoLineM)对象的集合。- 返回:
- 一个布尔值,表示分析结果中是否包含路由对象的集合。true 表示分析结果中包含路由结合,false 表示不包含。
- 默认值:
- 默认值为 false。
-
setRoutesReturn
public void setRoutesReturn(boolean value)
设置分析结果中是否包含路由(GeoLineM)对象的集合。- 参数:
value- 指定是否包含路由对象的集合。设置为 true,在分析成功后,可以从VRPAnalystResult对象的getRoutes方法返回路由数组;为 false 则返回一个空的数组。
-
isNodesReturn
public boolean isNodesReturn()
返回分析结果中是否包含途经结点的集合。- 返回:
- 一个布尔值,表示分析结果中是否包含途经结点的集合。true 表示分析结果中包含途经结点集合,false 表示不包含。
- 默认值:
- 默认值为 false。
-
setNodesReturn
public void setNodesReturn(boolean value)
设置分析结果中是否包含结点的集合。- 参数:
value- 指定分析结果中是否包含途经结点的集合。设置为 true,在分析成功后,可以从VRPAnalystResult对象的getNodes方法返回途经结点数组;为 false 则返回一个空的数组。
-
isEdgesReturn
public boolean isEdgesReturn()
返回分析结果中是否包含途经弧段集合。- 返回:
- 一个布尔值,表示分析结果中是否包含途经弧段集合。true 表示分析结果中包含途经弧段集合,false 表示不包含。
- 默认值:
- 默认值为 false。
-
setEdgesReturn
public void setEdgesReturn(boolean value)
设置分析结果中是否包含途经弧段的集合。- 参数:
value- 指定分析结果中是否包含经过弧段的集合。设置为 true,在分析成功后,可以从VRPAnalystResult对象的getEdges方法返回途经弧段数组;为 false 则返回一个空的数组。
-
isPathGuidesReturn
public boolean isPathGuidesReturn()
返回分析结果中是否包含行驶导引集合。- 返回:
- 一个布尔值,表示分析结果中是否包含行驶导引集合。true 表示分析结果中包含行驶导引集合,false 表示不包含。
- 默认值:
- 默认值为 false。
-
setPathGuidesReturn
public void setPathGuidesReturn(boolean value)
设置分析结果中是否包含行驶导引集合。注意:必须将该方法设置为 true,并且通过 TransportationAnalystSetting 类的
setEdgeNameField方法设置了弧段名称字段,分析结果中才会包含行驶导引集合,否则将不会返回行驶导引,但不影响分析结果中其他内容的获取。- 参数:
value- 指定分析结果中是否包含行驶导引集合。设置为 true,在分析成功后,可以从VRPAnalystResult对象的getPathGuides方法返回行驶导引数组;为 false 则返回一个空的数组。
-
isStopIndexesReturn
public boolean isStopIndexesReturn()
返回分析结果中是否要包含站点索引的集合。- 返回:
- 一个布尔值,表示分析结果中是否要包含站点索引的集合。true 表示分析结果中包含站点索引集合,false 表示不包含。
- 默认值:
- 默认值为 false。
-
setStopIndexesReturn
public void setStopIndexesReturn(boolean value)
设置分析结果中是否要包含站点索引的集合。- 参数:
value- 指定分析结果中是否要包含站点索引的集合。设置为 true,在分析成功后,可以从VRPAnalystResult对象的getStopIndexes方法返回站点索引数组;为 false 则返回一个空的数组。
-
getWeightName
public String getWeightName()
返回权值字段信息的名称。- 返回:
- 权值字段信息的名字标识。
- 默认值:
- 默认值为一个空字符串。
-
setWeightName
public void setWeightName(String value)
设置权值字段信息的名称,即交通网络分析环境设置(TransportationAnalystSetting)中的权值字段信息集合(WeightFieldInfos)中的某一个权值字段信息对象(WeightFieldInfo)的getName()方法的返回值。 分析时,如果未设置,则默认使用权值字段信息集合中的第一个权值字段信息对象的名称。- 参数:
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。
-
getBarrierPoints
public Point2Ds getBarrierPoints()
返回障碍结点的坐标列表。- 返回:
- 障碍结点的坐标集合。
-
setBarrierPoints
public void setBarrierPoints(Point2Ds value)
设置障碍结点的坐标列表。可选。指定的障碍点可以不在网络上(既不在弧段上也不在结点上),分析时将根据距离容限(setTolerance)把障碍点归结到最近的网络上。目前支持最佳路径分析、最近设施查找、旅行商分析和物流配送分析。- 参数:
value- 障碍结点的坐标集合。
-
setBarrierEdges
public void setBarrierEdges(int[] value)
设置障碍弧段 ID 列表。可选。此处指定的障碍弧段与交通网络分析环境(TransportationAnalystSetting)中指定的障碍弧段共同作用于交通网络分析。- 参数:
value- 障碍弧段 ID 列表。
-
getTurnWeightField
public String getTurnWeightField()
返回转向权值字段。请参见
setTurnWeightField方法的介绍。- 返回:
- 转向权值字段。
- 默认值:
- 默认值为一个空字符串。
-
setTurnWeightField
public void setTurnWeightField(String value)
设置转向权值字段。可选。转向权值字段即转向表中表示转弯耗费的字段。此处指定的字段必须是在交通网络分析环境(
TransportationAnalystSetting)中设置的转向权值字段集合(setTurnWeightFields)中的一个。关于转向表及转向耗费的相关介绍,NetworkBuilder 类的
createTurnBuilder方法。- 参数:
value- 转向权值字段。
-
getAnalystType
public AnalystType getAnalystType()
返回物流分析中的分析模式。- 返回:
- 物流分析分析模式。
-
setAnalystType
public void setAnalystType(AnalystType value)
设置物流分析模式,包括LEASTCOST最小耗费模式(默认值)、AVERAGECOST平均耗费模式、AREAANALYST区域分析模式。- 参数:
value- 指定物流分析模式。- 默认值:
- 默认值为 LEASTCOST。
-
getVRPDirectionType
public VRPDirectionType getVRPDirectionType()
返回物流分析路线的类型。- 返回:
- 物流分析路线的类型。
-
setVRPDirectionType
public void setVRPDirectionType(VRPDirectionType value)
设置物流分析路线的类型,包括ROUNDROUTE从中心点出发并回到中心点(默认值)、STARTBYCENTER从中心点出发但不回到中心点、ENDBYCENTER不从中心点出发但回到中心点。- 参数:
value- 物流分析路线的类型。- 默认值:
- 默认值为 ROUNDROUTE。
-
getTimeWeight
public String getTimeWeight()
返回时间字段信息的名称。- 返回:
- 时间字段信息的名称。
-
setTimeWeight
public void setTimeWeight(String value)
设置时间字段信息的名称。时间字段信息的名称。此处指定的字段必须是在交通网络分析环境(
TransportationAnalystSetting)中设置的转向权值字段集合(setTurnWeightFields)中的一个。分析时,如果未设置,则本次分析不使用时间耗费。- 参数:
value- 时间字段信息的名称。
-
getRouteCount
public int getRouteCount()
返回一次分析中派出车辆数目值。- 返回:
- 派出车辆数目。
-
setRouteCount
public void setRouteCount(int value)
设置一次分析中派出车辆数目值。按要求设置,此分析中以车辆数为前提得到线路数,线路数与实际派出车辆数相同;若不设置此参数,默认派出车辆数不会超过可以提供的车辆总数N(vehicleInfo[N])。- 参数:
value- 派出车辆数目。
-
-
Copyright © 2021–2025 SuperMap. All rights reserved.