Summary: Ctors | Methods | Inherited Methods | [Expand All]

public class

CarRouteSearchOptions

extends RouteSearchOptions

java.lang.Object
↳	RouteSearchOptions
	↳	com.tencent.map.navi.car.CarRouteSearchOptions

Class Overview

路线规划策略类

Summary

Public Constructors
	CarRouteSearchOptions()

Public Methods
CarRouteSearchOptions	avoidCongestion(boolean avoidCongestion) 设置是否躲避拥堵
CarRouteSearchOptions	avoidHighway(boolean avoidHighway) 设置是否避开高速公路
CarRouteSearchOptions	avoidToll(boolean avoidToll) 设置是否避开收费站
static CarRouteSearchOptions	create() 创建驾车导航的默认算路配置类.可以配置是否避开收费站、是否不走高速、是否躲避拥堵、接送客场景、起点路段类型。默认情况下配置类的策略为：不避开收费站，走高速，不躲避拥堵，接客场景，起点路段类型无提示。
List<List<LatLng>>	getAvoidAreaList() 返回避让区域数组
String	getInitialNaviSessionID() 获取用于导航的行前乘客选路的session id。
String	getInitialRouteID() 获取用于导航的行前乘客选路的路线id。
String	getLicenseNumber() 返回车牌号
int	getNaviScene() 返回接送客场景
TruckRouteSearchParams	getTruckRouteSearchParams() 返回货车参数
String	getUserID() 获取乘客ID。
boolean	isAvoidCongestionEnabled() 返回是否躲避拥堵
boolean	isAvoidHighwayEnabled() 返回是否不走高速公路
boolean	isAvoidTollEnabled() 返回是否避开收费站
boolean	isBigRoad() 驾车路线规划参数: 是否优先大路, 默认值NO.
boolean	isHighway() 驾车路线规划参数: 是否优先高速。
boolean	isShortTime() 驾车路线规划参数: 是否优先出时间短的路线, 默认为NO.
CarRouteSearchOptions	licenseNumber(String licenseNumber) 设置车牌号
CarRouteSearchOptions	naviScene(int naviScene) 设置接送客场景
CarRouteSearchOptions	preLocations(List<GpsLocation> preLocations) 设置前序点
void	setAngle(float angle) 设置算路初始角度。设置为0-360。
int	setAvoidAreaList(List<List<LatLng>> avoidAreaList) 设置避让区域数组。支持最多32个避让区域，每个区域最多可有9个顶点。需为凸多边形，顶点逆时针排列。如果数据不合法，则避让策略不生效。注意：如果起终点在避让区域内，则算路失败，错误码2005
CarRouteSearchOptions	setBigRoad(boolean bigRoad) 设置驾车路线规划参数: 是否优先大路, 默认值NO.
CarRouteSearchOptions	setHighway(boolean highway) 设置驾车路线规划参数: 是否优先高速。
CarRouteSearchOptions	setInitialNaviSessionID(String initialNaviSessionID) 设置用于导航的行前乘客选路的session id。可在webservice api的路径规划接口中获得.
CarRouteSearchOptions	setInitialRouteID(String initialRouteID) 设置用于导航的行前乘客选路的路线id。可在webservice api的路径规划接口中获得.
void	setPrice(float priceOfKm, float priceOfMinute) 当routeTraticeType为2时，设置价格
CarRouteSearchOptions	setRouteSearchRetryTimes(int routeSearchRetryTimes) 首次驾车路线规划失败重试次数，默认为0次，取值范围为0～5
void	setRouteTraticeType(int type) 设置路线规划后多条路线的排序策略
CarRouteSearchOptions	setShortTime(boolean shortTime) 设置驾车路线规划参数: 是否优先出时间短的路线, 默认为NO.
CarRouteSearchOptions	setUserID(String userID) 设置乘客ID，用于个性化引导点。
CarRouteSearchOptions	startRoadType(int roadType) 设置起点路段类型
CarRouteSearchOptions	truckRouteSearchParams(TruckRouteSearchParams truckRouteSearchParams) 如果是货车导航，请设置货车参数。

[Expand]

Inherited Methods

From class java.lang.Object

Public Constructors

public CarRouteSearchOptions ()

Public Methods

public CarRouteSearchOptions avoidCongestion (boolean avoidCongestion)

设置是否躲避拥堵

Parameters

avoidCongestion	true: 躲避拥堵 false:不躲避拥堵默认为：false

Returns

已设置是否躲避拥堵的算路配置类

public CarRouteSearchOptions avoidHighway (boolean avoidHighway)

设置是否避开高速公路

Parameters

avoidHighway	true: 不走高速 false:走高速默认为：false

Returns

已设置是否不走高速公路的算路配置类

public CarRouteSearchOptions avoidToll (boolean avoidToll)

设置是否避开收费站

Parameters

avoidToll	true: 避开收费站 false:不避开收费站默认为：false

Returns

已设置是否避开收费章的算路配置类

public static CarRouteSearchOptions create ()

创建驾车导航的默认算路配置类.可以配置是否避开收费站、是否不走高速、是否躲避拥堵、接送客场景、起点路段类型。默认情况下配置类的策略为：不避开收费站，走高速，不躲避拥堵，接客场景，起点路段类型无提示。

Returns

默认算路配置类

public List<List<LatLng>> getAvoidAreaList ()

返回避让区域数组

Returns

避让区域数组

public String getInitialNaviSessionID ()

获取用于导航的行前乘客选路的session id。

Returns

用于导航的session id

public String getInitialRouteID ()

获取用于导航的行前乘客选路的路线id。

Returns

用于导航的路线ID

public String getLicenseNumber ()

返回车牌号

Returns

车牌号

public int getNaviScene ()

返回接送客场景

Returns

接送客场景 1：接客 2：送客

public TruckRouteSearchParams getTruckRouteSearchParams ()

返回货车参数

Returns

货车参数

public String getUserID ()

获取乘客ID。

Returns

乘客唯一标识

public boolean isAvoidCongestionEnabled ()

返回是否躲避拥堵

Returns

是否躲避拥堵 true：躲避拥堵 false：不躲避拥堵

public boolean isAvoidHighwayEnabled ()

返回是否不走高速公路

Returns

是否不走高速公路 true：不走高速公路 false：可以走高速公路

public boolean isAvoidTollEnabled ()

返回是否避开收费站

Returns

是否避开收费站 true：避开收费站 false：不避开收费站

public boolean isBigRoad ()

驾车路线规划参数: 是否优先大路, 默认值NO.

Returns

是否优先大路

public boolean isHighway ()

驾车路线规划参数: 是否优先高速。

Returns

是否优先高速

public boolean isShortTime ()

驾车路线规划参数: 是否优先出时间短的路线, 默认为NO.

Returns

是否优先出时间短的路线

public CarRouteSearchOptions licenseNumber (String licenseNumber)

设置车牌号

Parameters

licenseNumber	车牌号

Returns

已设置车牌号的算路配置类

public CarRouteSearchOptions naviScene (int naviScene)

设置接送客场景

Parameters

naviScene	1: 接客 2: 送客默认为：0

Returns

已设置接送客场景的算路配置类

public CarRouteSearchOptions preLocations (List<GpsLocation> preLocations)

设置前序点

Parameters

preLocations	前序点数组，可提高路线规划准确性。最多传50个，非必须。前序点里的字段经纬度，角度，精度，速度，时间戳为必传字段

Returns

算路配置类

public void setAngle (float angle)

设置算路初始角度。设置为0-360。

Parameters

angle	算路角度

public int setAvoidAreaList (List<List<LatLng>> avoidAreaList)

设置避让区域数组。支持最多32个避让区域，每个区域最多可有9个顶点。需为凸多边形，顶点逆时针排列。如果数据不合法，则避让策略不生效。注意：如果起终点在避让区域内，则算路失败，错误码2005

Parameters

avoidAreaList	外层容器代表：避让区域集合，内层容器代表：每个避让区域的逆时针顶点集合

Returns

错误码。0: 正确;1: 避让区域超过32个；2: 设置区域的顶点超过9个

public CarRouteSearchOptions setBigRoad (boolean bigRoad)

设置驾车路线规划参数: 是否优先大路, 默认值NO.

Returns

是否优先大路

public CarRouteSearchOptions setHighway (boolean highway)

设置驾车路线规划参数: 是否优先高速。

Returns

是否优先高速

public CarRouteSearchOptions setInitialNaviSessionID (String initialNaviSessionID)

设置用于导航的行前乘客选路的session id。

可在webservice api的路径规划接口中获得.

Returns

用于导航的session id

public CarRouteSearchOptions setInitialRouteID (String initialRouteID)

设置用于导航的行前乘客选路的路线id。

可在webservice api的路径规划接口中获得.

Parameters

initialRouteID	用于导航的路线ID

public void setPrice (float priceOfKm, float priceOfMinute)

当routeTraticeType为2时，设置价格

Parameters

priceOfKm	每公里价格
priceOfMinute	每分钟价格

public CarRouteSearchOptions setRouteSearchRetryTimes (int routeSearchRetryTimes)

首次驾车路线规划失败重试次数，默认为0次，取值范围为0～5

public void setRouteTraticeType (int type)

设置路线规划后多条路线的排序策略

Parameters

type	路线规划策略，0：默认 1：距离优先 2：价格优先

public CarRouteSearchOptions setShortTime (boolean shortTime)

设置驾车路线规划参数: 是否优先出时间短的路线, 默认为NO.

Returns

是否优先出时间短的路线

public CarRouteSearchOptions setUserID (String userID)

设置乘客ID，用于个性化引导点。

Parameters

userID	乘客唯一标识

public CarRouteSearchOptions startRoadType (int roadType)

设置起点路段类型

Parameters

roadType	提示信息类型。参见 `StartRoadType`，默认为无详细类型。

Returns

已设置起点路段类型的算路配置类

public CarRouteSearchOptions truckRouteSearchParams (TruckRouteSearchParams truckRouteSearchParams)

如果是货车导航，请设置货车参数。

Classes

Enums

CarRouteSearchOptions

Class Overview

Summary

Public Constructors

public CarRouteSearchOptions ()

Public Methods

public CarRouteSearchOptions avoidCongestion (boolean avoidCongestion)

Parameters

Returns

public CarRouteSearchOptions avoidHighway (boolean avoidHighway)

Parameters

Returns

public CarRouteSearchOptions avoidToll (boolean avoidToll)

Parameters

Returns

public static CarRouteSearchOptions create ()

Returns

public List<List<LatLng>> getAvoidAreaList ()

Returns

public String getInitialNaviSessionID ()

Returns

public String getInitialRouteID ()

Returns

public String getLicenseNumber ()

Returns

public int getNaviScene ()

Returns

public TruckRouteSearchParams getTruckRouteSearchParams ()

Returns

public String getUserID ()

Returns

public boolean isAvoidCongestionEnabled ()

Returns

public boolean isAvoidHighwayEnabled ()

Returns

public boolean isAvoidTollEnabled ()

Returns

public boolean isBigRoad ()

Returns

public boolean isHighway ()

Returns

public boolean isShortTime ()

Returns

public CarRouteSearchOptions licenseNumber (String licenseNumber)

Parameters

Returns

public CarRouteSearchOptions naviScene (int naviScene)

Parameters

Returns

public CarRouteSearchOptions preLocations (List<GpsLocation> preLocations)

Parameters

Returns

public void setAngle (float angle)

Parameters

public int setAvoidAreaList (List<List<LatLng>> avoidAreaList)

Parameters

Returns

public CarRouteSearchOptions setBigRoad (boolean bigRoad)

Returns

public CarRouteSearchOptions setHighway (boolean highway)

Returns

public CarRouteSearchOptions setInitialNaviSessionID (String initialNaviSessionID)

Returns

public CarRouteSearchOptions setInitialRouteID (String initialRouteID)

Parameters

public void setPrice (float priceOfKm, float priceOfMinute)

Parameters

public CarRouteSearchOptions setRouteSearchRetryTimes (int routeSearchRetryTimes)

public void setRouteTraticeType (int type)

Parameters

public CarRouteSearchOptions setShortTime (boolean shortTime)

Returns

public CarRouteSearchOptions setUserID (String userID)

Parameters

public CarRouteSearchOptions startRoadType (int roadType)

Parameters

Returns

public CarRouteSearchOptions truckRouteSearchParams (TruckRouteSearchParams truckRouteSearchParams)