com.tencent.lbssearch.object.param

## 类 DrivingParam

- java.lang.Object
- - com.tencent.lbssearch.object.param.RoutePlanningParam
  - - com.tencent.lbssearch.object.param.DrivingParam

- 所有已实现的接口:
    ParamObject

      public class DrivingParam
      extends RoutePlanningParam

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `static class` | `DrivingParam.CarType` 车辆类型
    `static class` | `DrivingParam.Policy` 驾车路径规划的策略类型
    `static class` | `DrivingParam.Preference` 驾车路径规划的单项偏好参数
    `static class` | `DrivingParam.RoadType`
    `static class` | `DrivingParam.Travel` 轨迹

    - ### 从类继承的嵌套类/接口 com.tencent.lbssearch.object.param.RoutePlanningParam

      `RoutePlanningParam.DrivingPolicy, RoutePlanningParam.TransitPolicy`

  - ### 构造器概要

    构造器
    构造器和说明
    `DrivingParam()`
    `DrivingParam(LatLng from, LatLng to)`

  - ### 方法概要

    所有方法 实例方法 具体方法 已过时的方法
    限定符和类型 | 方法和说明
    --- | ---
    `DrivingParam` | `accuracy(int accuracy)` [from辅助参数]定位精度，单位：米，取 > 0数值，默认5。
    `DrivingParam` | `addWayPoint(LatLng l)` 增加一个途经点,最多30个，如果多余30则不作任何操作。
    `DrivingParam` | `addWayPoints(java.lang.Iterable<LatLng> ls)` 增加多个途经点
    `com.tencent.lbssearch.object.RequestParams` | `buildParameters()` 构造参数
    `DrivingParam` | `cache(boolean enable)` 是否开启算路缓存
    `DrivingParam` | `departureTime(long timeStamp)` 设置ETD时间(预计出发时间)
    `DrivingParam` | `fromPOI(java.lang.String fromPOI)` 起点POI ID，传入后，优先级高于from（坐标）
    `DrivingParam` | `fromTravel(DrivingParam.Travel travel)` 起点轨迹： 在真实的场景中，易受各种环境及设备精度影响，导致定位点产生误差，传入起点前段轨迹，可有效提升准确度。
    `java.lang.Class<DrivingResultObject>` | `getResultClass()`
    `java.lang.String` | `getUrl()`
    `DrivingParam` | `heading(int heading)` [from辅助参数]在起点位置时的车头方向，数值型，取值范围0至360（0度代表正北，顺时针一周360度） 传入车头方向，对于车辆所在道路的判断非常重要，直接影响路线计算的效果
    `DrivingParam` | `policy(DrivingParam.Policy policy, DrivingParam.Preference... preferences)` 设置驾车规划策略
    `DrivingParam` | `policy(RoutePlanningParam.DrivingPolicy policy)` 已过时。 建议使用 `policy(Policy, Preference...)`
    `DrivingParam` | `roadType(DrivingParam.RoadType roadType)` [from辅助参数] 起点道路类型，可选值请使用 `DrivingParam.RoadType`
    `DrivingParam` | `setAvoidPolygons(java.util.List<java.util.List<LatLng>> avoidPolygons)` 避让区域：支持32个避让区域，每个区域最多可有9个顶点（如果是四边形则有4个坐标点，如果是五边形则有5个坐标点） 参数格式： 纬度在前，经度在后，用半角逗号 “,” 分隔，小数点后不超过6位，各经纬度之间用半角分号 “;” 分隔。
    `DrivingParam` | `setCarNumber(java.lang.String carNumber)` 车牌号，填入后，路线引擎会根据车牌对限行区域进行避让，不填则不不考虑限行问题
    `DrivingParam` | `setCarType(DrivingParam.CarType carType)` 设置车类型，默认`DrivingParam.CarType.DEF` 代表油车，`DrivingParam.CarType.NEW_ENERGY`表示新能源
    `DrivingParam` | `setExtraFields(java.lang.String... extraFields)` 设置扩张字段
    `DrivingParam` | `setMultRoute(int multRoute)` 是否返回多方案，取值： 0 [默认]仅返回一条路线方案 1 返回多方案（最多可返回三条方案供用户备选）
    `void` | `setMultyPlan(boolean isMultyPlan)` 已过时。 已废弃
    `DrivingParam` | `setNoStep(int noStep)` 不返回路线引导信息，可使回包数据量更小
    `DrivingParam` | `speed(int speed)` [from辅助参数]速度，单位：米/秒，默认3。
    `DrivingParam` | `toPOI(java.lang.String toPOI)` 终点POI ID（可通过腾讯位置服务地点搜索服务得到），当目的地为较大园区、小区时，会以引导点做为终点（如出入口等），体验更优。
    `DrivingParam` | `trafficSpeed(boolean enable)` 设置是否返回路况配速信息

    - ### 从类继承的方法 com.tencent.lbssearch.object.param.RoutePlanningParam

      `checkParams, from, locationToParamsString, to`

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

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### DrivingParam

          public DrivingParam()

    - #### DrivingParam

          public DrivingParam(LatLng from,
                              LatLng to)

  - ### 方法详细资料

    - #### fromTravel

          public DrivingParam fromTravel(DrivingParam.Travel travel)

      起点轨迹： 在真实的场景中，易受各种环境及设备精度影响，导致定位点产生误差，传入起点前段轨迹，可有效提升准确度。 优先级：高于from参数
      参数:
        `travel` -
      返回:

    - #### fromPOI

          public DrivingParam fromPOI(java.lang.String fromPOI)

      起点POI ID，传入后，优先级高于from（坐标）
      参数:
        `fromPOI` -
      返回:

    - #### toPOI

          public DrivingParam toPOI(java.lang.String toPOI)

      从类复制的说明: `RoutePlanningParam`
      终点POI ID（可通过腾讯位置服务地点搜索服务得到），当目的地为较大园区、小区时，会以引导点做为终点（如出入口等），体验更优。 该参数优先级高于to（坐标），但是当目的地无引导点数据或POI ID失效时，仍会使用to（坐标）作为终点
      覆盖:
        `toPOI` 在类中 `RoutePlanningParam`
      返回:

    - #### heading

          public DrivingParam heading(int heading)

      [from辅助参数]在起点位置时的车头方向，数值型，取值范围0至360（0度代表正北，顺时针一周360度） 传入车头方向，对于车辆所在道路的判断非常重要，直接影响路线计算的效果
      参数:
        `heading` -
      返回:

    - #### speed

          public DrivingParam speed(int speed)

      [from辅助参数]速度，单位：米/秒，默认3。 当速度低于1.39米/秒时，heading将被忽略
      参数:
        `speed` -
      返回:

    - #### accuracy

          public DrivingParam accuracy(int accuracy)

      [from辅助参数]定位精度，单位：米，取 > 0数值，默认5。 当定位精度 > 30米时heading参数将被忽略
      参数:
        `accuracy` -
      返回:

    - #### roadType

          public DrivingParam roadType(DrivingParam.RoadType roadType)

      [from辅助参数] 起点道路类型，可选值请使用 `DrivingParam.RoadType`
      参数:
        `roadType` - 道路类型
      返回:

    - #### setMultyPlan

          public void setMultyPlan(boolean isMultyPlan)

      已过时。 已废弃
      设置是否返回多方案
      参数:
        `isMultyPlan` -

    - #### trafficSpeed

          public DrivingParam trafficSpeed(boolean enable)

      设置是否返回路况配速信息
      参数:
        `enable` -

    - #### policy

          public DrivingParam policy(DrivingParam.Policy policy,
                                     DrivingParam.Preference... preferences)

      设置驾车规划策略
      参数:
        `policy` -
        `preferences` -
      返回:

    - #### policy

          public DrivingParam policy(RoutePlanningParam.DrivingPolicy policy)

      已过时。 建议使用 `policy(Policy, Preference...)`
      设置驾车规划策略
      参数:
        `policy` -
      返回:

    - #### addWayPoint

          public DrivingParam addWayPoint(LatLng l)

      增加一个途经点,最多30个，如果多余30则不作任何操作。
      参数:
        `l` -
      返回:

    - #### addWayPoints

          public DrivingParam addWayPoints(java.lang.Iterable<LatLng> ls)

      增加多个途经点
      参数:
        `ls` -
      返回:

    - #### setCarNumber

          public DrivingParam setCarNumber(java.lang.String carNumber)

      车牌号，填入后，路线引擎会根据车牌对限行区域进行避让，不填则不不考虑限行问题
      参数:
        `carNumber` -

    - #### setCarType

          public DrivingParam setCarType(DrivingParam.CarType carType)

      设置车类型，默认`DrivingParam.CarType.DEF` 代表油车，`DrivingParam.CarType.NEW_ENERGY`表示新能源
      参数:
        `carType` - 车类型

    - #### setNoStep

          public DrivingParam setNoStep(int noStep)

      不返回路线引导信息，可使回包数据量更小
      参数:
        `noStep` - 取值：0[默认]返回路线引导信息 1不返回

    - #### setAvoidPolygons

          public DrivingParam setAvoidPolygons(java.util.List<java.util.List<LatLng>> avoidPolygons)

      避让区域：支持32个避让区域，每个区域最多可有9个顶点（如果是四边形则有4个坐标点，如果是五边形则有5个坐标点） 参数格式： 纬度在前，经度在后，用半角逗号 “,” 分隔，小数点后不超过6位，各经纬度之间用半角分号 “;” 分隔。各区域多边形间，用竖线符号分隔 “|”
      参数:
        `avoidPolygons` -
      返回:

    - #### setMultRoute

          public DrivingParam setMultRoute(int multRoute)

      是否返回多方案，取值： 0 [默认]仅返回一条路线方案 1 返回多方案（最多可返回三条方案供用户备选）
      参数:
        `multRoute` -

    - #### setExtraFields

          public DrivingParam setExtraFields(java.lang.String... extraFields)

      设置扩张字段
      参数:
        `extraFields` - 扩张字段

    - #### cache

          public DrivingParam cache(boolean enable)

      是否开启算路缓存
      参数:
        `enable` - 开关

    - #### departureTime

          public DrivingParam departureTime(long timeStamp)

      设置ETD时间(预计出发时间)
      参数:
        `timeStamp` - 表示未来秒级时间戳（10位）

    - #### buildParameters

          public com.tencent.lbssearch.object.RequestParams buildParameters()

      从接口复制的说明: `ParamObject`
      构造参数
      指定者:
        `buildParameters` 在接口中 `ParamObject`
      覆盖:
        `buildParameters` 在类中 `RoutePlanningParam`

    - #### getUrl

          public java.lang.String getUrl()

      指定者:
        `getUrl` 在类中 `RoutePlanningParam`

    - #### getResultClass

          public java.lang.Class<DrivingResultObject> getResultClass()

      指定者:
        `getResultClass` 在类中 `RoutePlanningParam`