RoutePlan (JNaviCore SDK Documentation)

java.lang.Object
- com.mapbar.navi.RoutePlan

```
public class RoutePlan
extends java.lang.Object
```
路线规划方案
用来设置路线的起点、终点、途径点、规避信息等规划信息，用于算路

嵌套类概要

嵌套类
限定符和类型	类和说明
`class`	`RoutePlan.ErrorCode`
`class`	`RoutePlan.Rule` 路线规划规则 recommended -- 系统推荐方式 shortest -- 最短路线方式 fastest -- 高速优先方式 economic -- 花费最少方式 walk -- 步行算路

构造器概要

构造器
构造器和说明
`RoutePlan()` 构造函数，初始化数据成员
`RoutePlan(RoutePlan plan)` 复制构造函数
`RoutePlan(java.lang.String path)` 通过file来构造RoutePlan

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addDestination(PoiFavorite fav)` 添加目的地点第一次调用，添加起点第二次调用，添加终点第三次调用，添加终点，但第二次调用时候产生的终点变为途径点依次类推
`boolean`	`addWayPoint(PoiFavorite fav)` 添加途经点，顺序添加，途经点最多只能有三个
`void`	`clearDestinations()` 清楚所有目标点
`void`	`enablePhysicalRestriction(boolean enabled)` 是否开启物理限行，默认情况下关闭
`void`	`enableRegulationCondition(boolean enabled)` 启用政策限行条件开启情况下有效。
`void`	`enableTimeCondition(boolean enabled)` 启用时间限行条件开启情况下有效。
`boolean`	`equals(java.lang.Object obj)`
`int`	`getAvoidRoadType()` 获取要避让的路段类型获取后的类型需要使用位与的方式来的到具体的避让类型
`PoiFavorite`	`getDestination(int index)` 根据索引值获取当前路线规划中的POI信息
`int`	`getDestinationNum()` 获取目的点数组中的点个数
`int`	`getOrigionOrientation()` 返回路线规划起点方向角
`long`	`getRoutePlan()`
`int`	`getRule()` 获取当前路线规划规则
`boolean`	`getUseTmc()` 算路时是否使用TMC
`VehicleInfo`	`getVehicleInfo()` 获取当前设置的机动车信息
`int`	`getWayPointNumber()` 获取途经点数量
`boolean`	`hasDestinationPoint()` 判断是否包含终点
`int`	`hashCode()`
`boolean`	`hasStartPoint()` 判断是否包含起点
`void`	`insertDestination(int index, PoiFavorite fav)` 在指定索引的位置插入POI点插入之后，此索引位置以后的点都向后移动
`boolean`	`isPhysicalRestrictionEnabled()` 当前routePlan是否开启了物理限行
`boolean`	`isRegulationConditionEnabled()` 当前是否启用政策限行条件
`boolean`	`isTimeConditionEnabled()` 当前是否启用时间限行条件
`boolean`	`load(java.lang.String fileName)` 载入上次保存的路径
`void`	`removeAllWayPoint()` 移除所有途经点
`void`	`removeDestination(int index)` 删除指定索引值的目标POI点
`boolean`	`removeWayPoint(int index)` 移除指定索引的途经点对象
`boolean`	`save(java.lang.String fileName)` 保存路线规划文件
`void`	`setAvoidRoadType(int avoid)` 设置`RoutePlan`中要避让的路段类型`NaviSession.AvoidRoadType`: 缺省值是`NaviSession.AvoidRoadType.none` 如果不设置，则算路时以`NaviSession`中的设置为准如果设置了，则算路时忽略`NaviSession`中的设置，以`RoutePlan`中的设置为准。
`void`	`setDestination(int index, PoiFavorite fav)` 设置路线规划中的指定索引值的POI点信息，用于算路使用此方法将覆盖原本索引值所在的POI点信息
`boolean`	`setEndPoint(PoiFavorite fav)` 设置终点
`void`	`setOrigionOrientation(short ori)` 设置路线规划起点方向角
`void`	`setRule(int rule)` 设置路线规划规则
`void`	`setStartPoint(PoiFavorite fav)` 设置起点
`void`	`setUseTmc(boolean use)` 设置是否使用TMC算路, 缺省值为false。
`void`	`setVehicleInfo(VehicleInfo info)` 设置机动车信息，默认设置不限制机动车条件
`boolean`	`setWayPoint(int index, PoiFavorite fav)` 设置途经点，使用此方法将替换原本设置过的途经点，途经点最多只能有三个
`void`	`swapDestinations(int index1, int index2)` 交换指定索引的两个目标点
`void`	`updateStartPointByGps()` 通过GPS更新起点坐标
`int`	`verify(int index)` 验证当前坐标点是否有效

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - RoutePlan
```
public RoutePlan()
```
    构造函数，初始化数据成员
  - RoutePlan
```
public RoutePlan(java.lang.String path)
```
    通过file来构造RoutePlan
    
    参数:
    
    path - 文件绝对路劲
  - RoutePlan
```
public RoutePlan(RoutePlan plan)
```
    复制构造函数
    
    参数:
    
    plan - 会进行拷贝#copy(RoutePlan)
- 方法详细资料
  - enablePhysicalRestriction
```
public void enablePhysicalRestriction(boolean enabled)
```
    是否开启物理限行，默认情况下关闭
    
    参数:
    
    enabled -
  - isPhysicalRestrictionEnabled
```
public boolean isPhysicalRestrictionEnabled()
```
    当前routePlan是否开启了物理限行
    
    返回:
    
    true 开启/false 未开启
  - enableTimeCondition
```
public void enableTimeCondition(boolean enabled)
```
    启用时间限行条件开启情况下有效。默认情况下是开启的。
    
    参数:
    
    enabled - true 启用/false 不启用
  - isTimeConditionEnabled
```
public boolean isTimeConditionEnabled()
```
    当前是否启用时间限行条件
    
    返回:
    
    true 启用/false 未启用
  - enableRegulationCondition
```
public void enableRegulationCondition(boolean enabled)
```
    启用政策限行条件开启情况下有效。默认情况下是开启的。
    
    参数:
    
    enabled - true 启用/false 不启用
  - isRegulationConditionEnabled
```
public boolean isRegulationConditionEnabled()
```
    当前是否启用政策限行条件
    
    返回:
    
    true 启用/false 未启用
  - getRoutePlan
```
public long getRoutePlan()
```
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - setOrigionOrientation
```
public void setOrigionOrientation(short ori)
```
    设置路线规划起点方向角
    
    参数:
    
    ori - 起点方向角
  - getOrigionOrientation
```
public int getOrigionOrientation()
```
    返回路线规划起点方向角
    
    返回:
    
    当前起点的方向角
  - setRule
```
public void setRule(int rule)
```
    设置路线规划规则
    
    参数:
    
    rule - 具体的路线规划规则
    
    另请参阅:
    
    RoutePlan.Rule
  - getRule
```
public int getRule()
```
    获取当前路线规划规则
    
    返回:
    
    当前的路线规划规则RoutePlan.Rule
  - setAvoidRoadType
```
public void setAvoidRoadType(int avoid)
```
    设置RoutePlan中要避让的路段类型NaviSession.AvoidRoadType:
    缺省值是NaviSession.AvoidRoadType.none
    如果不设置，则算路时以NaviSession中的设置为准
    如果设置了，则算路时忽略NaviSession中的设置，以RoutePlan中的设置为准。
    只是使用位或操作来同时设置多种避让类型。
    
    参数:
    
    avoid - 避让类型NaviSession.AvoidRoadType
    
    另请参阅:
    
    NaviSession.AvoidRoadType
  - setUseTmc
```
public void setUseTmc(boolean use)
```
    设置是否使用TMC算路, 缺省值为false。使用tmc算路即使用避让拥堵进行算路。
    
    参数:
    
    use - 为true表示使用TMC算路, false不使用TMC
    
    Notice:
    
    仅在在线算路中有效
  - getUseTmc
```
public boolean getUseTmc()
```
    算路时是否使用TMC
    
    返回:
    
    true表示使用了TMC算路, false表示没有使用TMC算路
    
    Notice:
    
    仅在在线算路中有效
  - getAvoidRoadType
```
public int getAvoidRoadType()
```
    获取要避让的路段类型
    获取后的类型需要使用位与的方式来的到具体的避让类型
    
    返回:
    
    避让的路段类型NaviSession.AvoidRoadType
  - getDestinationNum
```
public int getDestinationNum()
```
    获取目的点数组中的点个数
    
    返回:
    
    当前路线规划方式中目的点个数
  - getDestination
```
public PoiFavorite getDestination(int index)
```
    根据索引值获取当前路线规划中的POI信息
    
    参数:
    
    index - 索引值
    
    返回:
    
    指定索引值的目POI点信息
  - setDestination
```
public void setDestination(int index,
                           PoiFavorite fav)
```
    设置路线规划中的指定索引值的POI点信息，用于算路
    使用此方法将覆盖原本索引值所在的POI点信息
    
    参数:
    
    index - 索引值
    
    fav - 需要指定的POI信息
  - insertDestination
```
public void insertDestination(int index,
                              PoiFavorite fav)
```
    在指定索引的位置插入POI点
    插入之后，此索引位置以后的点都向后移动
    
    参数:
    
    index - 索引值
    
    fav - 待插入的POI点
  - addDestination
```
public void addDestination(PoiFavorite fav)
```
    添加目的地点
    第一次调用，添加起点
    第二次调用，添加终点
    第三次调用，添加终点，但第二次调用时候产生的终点变为途径点
    依次类推
    
    参数:
    
    fav - 待添加的POI
  - removeDestination
```
public void removeDestination(int index)
```
    删除指定索引值的目标POI点
    
    参数:
    
    index - 索引值
  - clearDestinations
```
public void clearDestinations()
```
    清楚所有目标点
  - swapDestinations
```
public void swapDestinations(int index1,
                             int index2)
```
    交换指定索引的两个目标点
    
    参数:
    
    index1 - 索引值1
    
    index2 - 索引值2
  - verify
```
public int verify(int index)
```
    验证当前坐标点是否有效
    
    参数:
    
    index - 点的下标
    
    返回:
    
    错误枚举RoutePlan.ErrorCode
    
    另请参阅:
    
    RoutePlan.ErrorCode
  - updateStartPointByGps
```
public void updateStartPointByGps()
```
    通过GPS更新起点坐标
  - save
```
public boolean save(java.lang.String fileName)
```
    保存路线规划文件
    
    参数:
    
    fileName - 文件路径
    
    返回:
    
    保存成功返回true，否则返回false
  - setVehicleInfo
```
public void setVehicleInfo(VehicleInfo info)
```
    设置机动车信息，默认设置不限制机动车条件
    
    另请参阅:
    
    设置为true开启条件限行后，机动车条件才会影响算路结果，默认为false不开启
  - getVehicleInfo
```
public VehicleInfo getVehicleInfo()
```
    获取当前设置的机动车信息
  - load
```
public boolean load(java.lang.String fileName)
```
    载入上次保存的路径
    
    参数:
    
    fileName - 文件路径
    
    返回:
    
    载入成功返回true，否则返回false
  - setStartPoint
```
public void setStartPoint(PoiFavorite fav)
```
    设置起点
    
    参数:
    
    fav - 起点的Poi对象
    
    另请参阅:
    
    PoiFavorite
  - setEndPoint
```
public boolean setEndPoint(PoiFavorite fav)
```
    设置终点
    
    参数:
    
    fav - 终点Poi对象
    
    返回:
    
    是否正确设置终点，true为正确设置终点，可以导航，false为设置错误，一般起点未设置的问题
    
    另请参阅:
    
    PoiFavorite
  - addWayPoint
```
public boolean addWayPoint(PoiFavorite fav)
```
    添加途经点，顺序添加，途经点最多只能有三个
    
    参数:
    
    fav - 途经点Poi对象
    
    返回:
    
    如果设置成功返回true，否则返回false
    失败的原因一般是没有设置起点终点，或者途经点个数超过了3个
  - setWayPoint
```
public boolean setWayPoint(int index,
                           PoiFavorite fav)
```
    设置途经点，使用此方法将替换原本设置过的途经点，途经点最多只能有三个
    
    参数:
    
    index - 途经点所在下标，取值范围：[0, 2]
    
    fav - 途经点Poi对象
    
    返回:
    
    如果设置成功则返回true，否则返回false
    一般失败的原因是没有设置终点或起点，或者设置的索引超过了2
  - getWayPointNumber
```
public int getWayPointNumber()
```
    获取途经点数量
    
    返回:
    
    途经点数量
  - removeWayPoint
```
public boolean removeWayPoint(int index)
```
    移除指定索引的途经点对象
    参数:
    
    index - 途经点索引
    
    返回:
    
    如果移除成功，返回true，否则返回false
    一般来说，移除失败主要是索引值不对
    
    Notice:
    
    需要注意一点，如果此时又多个途径点，那么移除第一个之后，原来的第二个途径点就变成了第一个途径点，第三个途径点就变成了第二个途径点，依次前移。
    
    Example:
    // e.g. 通过循环的方式删除所有途径点 RoutePlan rp = RouteBase.getPlan(); if (rp != null) { int wayPointNumber = rp.getWayPointNumber(); for (int i = 0; i < wayPointNumber; i++) { // 每次移除第一个途径点，3次之后，所有途径点都移除 // 此方法仅演示说明removeWayPoint的用法和注意事项 // 如果真的要删除所有途径点应该使用RoutePlan.removeAllWayPoint rp.removeWayPoint(0); } }
  - removeAllWayPoint
```
public void removeAllWayPoint()
```
    移除所有途经点
  - hasStartPoint
```
public boolean hasStartPoint()
```
    判断是否包含起点
    
    返回:
    
    包含起点时返回true，否则返回false
  - hasDestinationPoint
```
public boolean hasDestinationPoint()
```
    判断是否包含终点
    
    返回:
    
    包含终点时返回true，否则返回false

类 RoutePlan

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

RoutePlan

RoutePlan

RoutePlan

方法详细资料

enablePhysicalRestriction

isPhysicalRestrictionEnabled

enableTimeCondition

isTimeConditionEnabled

enableRegulationCondition

isRegulationConditionEnabled

getRoutePlan

hashCode

equals

setOrigionOrientation

getOrigionOrientation

setRule

getRule

setAvoidRoadType

setUseTmc

getUseTmc

getAvoidRoadType

getDestinationNum

getDestination

setDestination

insertDestination

addDestination

removeDestination

clearDestinations

swapDestinations

verify

updateStartPointByGps

save

setVehicleInfo

getVehicleInfo

load

setStartPoint

setEndPoint

addWayPoint

setWayPoint

getWayPointNumber

removeWayPoint

removeAllWayPoint

hasStartPoint

hasDestinationPoint