RouteBase (JNaviCore SDK Documentation)

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

```
public class RouteBase
extends java.lang.Object
```
路线对象
通过此对象可以获取路线相关信息

嵌套类概要

嵌套类
限定符和类型类和说明

class RouteBase.TmcStyle
路线的TMC样式

class RouteBase.Type

嵌套类
限定符和类型	类和说明
`class`	`RouteBase.TmcStyle` 路线的TMC样式
`class`	`RouteBase.Type`

字段概要

字段
限定符和类型字段和说明

static int NO_USE_CURRENT_DISTANCE

字段
限定符和类型	字段和说明
`static int`	`NO_USE_CURRENT_DISTANCE`

构造器概要

构造器
构造器和说明

RouteBase(long p)

构造器
构造器和说明
`RouteBase(long p)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`int`	`_getSegmentIndexByDistance(int distance)` 根据到起点的距离获取路段下标
`static void`	`addReferenceInfo(int key, java.lang.String referenceInfo)` 添加RouteBase的引用者信息，内部调试用，外部使用者不要调用
`boolean`	`avoidSegmentsByDescription(int index)` 设置指定路线详情里的路段，只针对离线算路
`void`	`enableTmcColors(boolean enable)` 设置是否在绘制的道路上显示TMC信息默认：false，不显示TMC信息。
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String[]`	`getAvoidFailedRoadNames()` 获取避让失败的道路名称，只针对离线算路
`android.graphics.Rect`	`getBoundingBox()` 获取当前路线的包络盒
`int`	`getCurrentIndexInDescriptions(int curDistance)` 返回当前车所在路线上的位置所对应的路线详情下标
`java.lang.String`	`getDescription()` 获取该路线的简短描述，可直接使用，一般给出的时路线中经过的主要路段名称，如果没有，则返回空。
`TmcSections`	`getDescriptionItemTmcSection(int index)` 获取路线上指定路段的路况信息
`long`	`getDSegmentIdByIndex(int index)` 通过路段下标获取路段的DSegmentId，在线算路后，如果离在线数据的GUID不同，则不能使用在线数据中获取的路线id
`int`	`getEstimatedTime()` 路线全程所需时间，单位：秒
`android.graphics.Point`	`getFirstShapePoint()` 获取路线上的第一个形状点
`android.graphics.Point`	`getLastShapePoint()` 获取路线上最后一个形状点
`int`	`getLength()` 获取当前路线长度，单位：米
`int`	`getLengthByTmcState(int state)` 获取道路中指定tmc状态的路段长度，单位：米
`long[]`	`getNaviInfoIds()` 获取道路上所有路段的四维Id
`long`	`getNavInfoId(int index)` 获取指定路段上的四维Id。
`int`	`getOnlineEta()` 获取服务器算出来的路线时间，单位：秒
`RoutePlan`	`getPlan()` 获取路线规划对象
`RestrictionInfo`	`getRestrictionInfo(int index)` 获取某一路段的限行信息
`int[]`	`getRestrictionSegmentIndex(int creepDistance)` 获取当前位置向前延伸creepDistance距离，其中有限行信息路段的路段下标index
`android.graphics.Point[]`	`getRestrictionSegmentPoint(int creepDistance)` 获取当前位置向前延伸creepDistance距离，其中有限行信息路段的坐标数组，坐标为对应路段的首个形状点
`long`	`getRouteBase()`
`java.lang.String`	`getRouteTrait(int index)` 获取路线标签
`SegmentAttributes`	`getSegmentAttributes(int index)` 获取对应index下的segment的详细信息
`int`	`getSegmentEndDistance(int index)` 获取指定路段终点到起点距离，单位：m
`android.graphics.Point[]`	`getSegmentFinePoints(int index)` 获取Segment的形状点配合`getSegmentNumber()`一起使用，可以通过形状点绘制路线但是不推荐使用，因为性能较低，如果使用图吧地图，可以通过 `RouteOverlay.RouteOverlay(RouteBase)`构造路线
`android.graphics.Point`	`getSegmentFirstPoint(int index)` 获取指定index路段的首个形状点坐标
`android.graphics.Point`	`getSegmentLastPoint(int index)` 获取指定index路段的尾端形状点坐标
`int`	`getSegmentLength(int index)` 获取路段长度
`int`	`getSegmentNumber()` 获取当前路线共有多少个Segment 配合`getSegmentFinePoints(int)`一起使用，可以通过形状点绘制路线但是不推荐使用，因为性能较低，如果使用图吧地图，可以通过 `RouteOverlay.RouteOverlay(RouteBase)`构造路线
`int`	`getSegmentStartDistance(int index)` 获取指定路段起点到起点距离，单位：m
`int`	`getSegmentTmc(int index)` 获取路线上指定路段的路况信息
`int`	`getStartDirection()` 路线的开始方向，单位：度
`TmcSections`	`getTmcBar(int maxPixelNum)` 获取路况条信息段
`byte[]`	`getTmcStates()` 获取路段上的所有TMC信息
`int`	`getTmcStyle()` 获取实时路况(TMC)模式样式默认：`RouteBase.TmcStyle.normal`
`DateTime`	`getTmcTime()` 获取TMC信息更新时间字符串
`TollStation[]`	`getTollStations()` 获取路线上所有的收费站信息
`int`	`getToolCharge()` 路线全程收费信息
`int`	`getTrafficLightNumber()` 获取道路上红绿灯数量
`int`	`getTraitNumber()` 获取路线标签数量
`int`	`getType()` 获取当前路线类型为在线还是离线
`boolean`	`hasBrokenRestrictions()` 获取算出来的路，有没有到打破限行规则
`int`	`hashCode()`
`boolean`	`hasHighWay()` 判断该路线是否有高速路或快速路
`boolean`	`hasSailingRoute()` 判断该路线是否含有轮渡
`boolean`	`hasToll()` 判断该路线是否有收费路段
`boolean`	`isTmcColorsEnabled()` 返回当前是否开启了显示道路TMC的功能
`static void`	`printReferenceInfos()` 输出引用者信息，检索词：routeBaseReferenceInfo
`void`	`release()` 销毁RouteBase，一般用于打断对离线数据的引用，防止离线数据不能及时安装和删除
`static void`	`releaseAll()` 释放所有创建过的RouteBase
`static void`	`removeReferenceInfo(int key)` 删除RouteBase的引用者信息，内部调试用，外部使用者不要调用
`void`	`setTmcStyle(int style)` 设置实时路况(TMC)模式下的路线样式
`boolean`	`testPoint(android.graphics.Point position, int range)` 测试指定的经纬度坐标是否在路线上一个点是否在线上的判断一般需要一个阈值，所以需要给出一个合适的检测范围，也就是说，在如果测试点距离路线的距离在此范围内(包含范围边界)，则表示在路线上，反之则不再路线上。
`byte[]`	`toJson()` 将路线保存成json格式[离线]

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

- 字段详细资料
  - NO_USE_CURRENT_DISTANCE
```
public static final int NO_USE_CURRENT_DISTANCE
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - RouteBase
```
public RouteBase(long p)
```
- 方法详细资料
  - getRouteBase
```
public long getRouteBase()
```
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - getDSegmentIdByIndex
```
public long getDSegmentIdByIndex(int index)
```
    通过路段下标获取路段的DSegmentId，在线算路后，如果离在线数据的GUID不同，则不能使用在线数据中获取的路线id
    
    返回:
    
    路段的DSegmentId
  - getType
```
public int getType()
```
    获取当前路线类型为在线还是离线
    
    返回:
    
    返回RouteBase.Type类型的结果
    
    另请参阅:
    
    RouteBase.Type
  - getLength
```
public int getLength()
```
    获取当前路线长度，单位：米
    
    返回:
    
    返回路线长度
  - getEstimatedTime
```
public int getEstimatedTime()
```
    路线全程所需时间，单位：秒
    
    返回:
    
    全程所需时间
  - getToolCharge
```
public int getToolCharge()
```
    路线全程收费信息
    
    返回:
    
    路线全程收费(单位:元)
  - getPlan
```
public RoutePlan getPlan()
```
    获取路线规划对象
    
    返回:
    
    当前道路的路线规划对象
  - getStartDirection
```
public int getStartDirection()
```
    路线的开始方向，单位：度
    
    返回:
    
    起始路线方向
  - getBoundingBox
```
public android.graphics.Rect getBoundingBox()
```
    获取当前路线的包络盒
    
    返回:
    
    当前路线包络盒
  - getFirstShapePoint
```
public android.graphics.Point getFirstShapePoint()
```
    获取路线上的第一个形状点
    
    返回:
    
    路线上的第一个形状点
  - getLastShapePoint
```
public android.graphics.Point getLastShapePoint()
```
    获取路线上最后一个形状点
    
    返回:
    
    路线上最后一个形状点
  - getCurrentIndexInDescriptions
```
public int getCurrentIndexInDescriptions(int curDistance)
```
    返回当前车所在路线上的位置所对应的路线详情下标
    
    参数:
    
    curDistance - 当前车所在路线上的位置
    
    返回:
    
    当前所在位置位于路线详情中的下标
  - getDescriptionItemTmcSection
```
public TmcSections getDescriptionItemTmcSection(int index)
```
    获取路线上指定路段的路况信息
    参数:
    
    index - 路段索引，非负整数
    
    返回:
    
    路况信息TmcSections.State
    
    另请参阅:
    
    TmcSections.State, getSegmentNumber()
    
    Notice:
    
    注意：当前仅支持在线算路，离线算路总是返回数据未采集状态，关于返回的状态请参看 TmcSections。
    
    Example:
    // 获取路段数 RouteBase rb = NaviSession.getInstance().getRoute(); int number = rb.getDescriptionNumber(); // 路段描述数组，用于保存路段描述信息 RouteDescriptionItem rdis = new ArrayList<RouteDescriptionItem>(); for (int i = 0; i < number; i++) { RouteDescriptionItem rd = rb.getDescriptionItem(i, RouteBase.NO_USE_CURRENT_DISTANCE); rdis.add(rd); } // 获取TMC信息 TmcSections sections = mRouteBase.getDescriptionItemTmcSection(position); if (sections != null) { Logger.d("[RouteDetail]", "sections.length = " + sections.length); }
  - getTmcTime
```
public DateTime getTmcTime()
```
    获取TMC信息更新时间字符串
    
    返回:
    
    如果路线上不带有TMC信息，那么将返回null或返回的DateTime 的所有字段为0，可以利用此方法来判断路线上是否有TMC信息
  - getTmcBar
```
public TmcSections getTmcBar(int maxPixelNum)
```
    获取路况条信息段
    
    参数:
    
    maxPixelNum - 路况条绘制时的大小，单位：像素
    
    返回:
    
    返回路况条描述信息段TmcSections
    
    从以下版本开始:
    
    4.10.x
  - getSegmentNumber
```
public int getSegmentNumber()
```
    获取当前路线共有多少个Segment
    配合getSegmentFinePoints(int)一起使用，可以通过形状点绘制路线
    但是不推荐使用，因为性能较低，如果使用图吧地图，可以通过 RouteOverlay.RouteOverlay(RouteBase)构造路线
    
    返回:
    
    路线上Segment的个数
    
    另请参阅:
    
    getSegmentFinePoints(int)
  - getSegmentFinePoints
```
public android.graphics.Point[] getSegmentFinePoints(int index)
```
    获取Segment的形状点
    配合getSegmentNumber()一起使用，可以通过形状点绘制路线
    但是不推荐使用，因为性能较低，如果使用图吧地图，可以通过 RouteOverlay.RouteOverlay(RouteBase)构造路线
    
    参数:
    
    index - Segment索引
    
    返回:
    
    返回点的数组
    
    另请参阅:
    
    getSegmentNumber()
  - getRestrictionInfo
```
public RestrictionInfo getRestrictionInfo(int index)
```
    获取某一路段的限行信息
    
    参数:
    
    index - 路段在当前routeBase中的index值
    
    返回:
    
    路段限行信息
  - getSegmentLength
```
public int getSegmentLength(int index)
```
    获取路段长度
    
    参数:
    
    index - 路段segment索引
    
    返回:
    
    路段长度
  - hasSailingRoute
```
public boolean hasSailingRoute()
```
    判断该路线是否含有轮渡
    
    返回:
    
    如果有返回true，否则返回false
  - hasToll
```
public boolean hasToll()
```
    判断该路线是否有收费路段
    
    返回:
    
    如果有返回true，否则返回false
  - hasHighWay
```
public boolean hasHighWay()
```
    判断该路线是否有高速路或快速路
    
    返回:
    
    如果有返回true，否则返回false
  - getDescription
```
public java.lang.String getDescription()
```
    获取该路线的简短描述，可直接使用，一般给出的时路线中经过的主要路段名称，如果没有，则返回空。
    
    返回:
    
    描述字符串，直接显示即可
  - enableTmcColors
```
public void enableTmcColors(boolean enable)
```
    设置是否在绘制的道路上显示TMC信息
    默认：false，不显示TMC信息。显示蚯蚓路tmc需要同时确认开启
    
    参数:
    
    enable - true开启路线TMC显示，false关闭路线TMC显示
    
    另请参阅:
    
    RouteOverlay#enableTmcColors(boolean)
  - isTmcColorsEnabled
```
public boolean isTmcColorsEnabled()
```
    返回当前是否开启了显示道路TMC的功能
    
    返回:
    
    是否开启路线TMC显示
  - setTmcStyle
```
public void setTmcStyle(int style)
```
    设置实时路况(TMC)模式下的路线样式
    
    参数:
    
    style - 样式，RouteBase.TmcStyle
  - getTmcStyle
```
public int getTmcStyle()
```
    获取实时路况(TMC)模式样式
    默认：RouteBase.TmcStyle.normal
    
    返回:
    
    TMC样式
  - _getSegmentIndexByDistance
```
public int _getSegmentIndexByDistance(int distance)
```
    根据到起点的距离获取路段下标
    
    参数:
    
    distance - 到起点的距离，单位：米
    
    返回:
    
    路段下标
    
    Notice:
    
    仅限引擎内部调用
  - testPoint
```
public boolean testPoint(android.graphics.Point position,
                         int range)
```
    测试指定的经纬度坐标是否在路线上
    一个点是否在线上的判断一般需要一个阈值，所以需要给出一个合适的检测范围，也就是说，在如果测试点距离路线的距离在此范围内(包含范围边界)，则表示在路线上，反之则不再路线上。
    
    参数:
    
    position - 点的经纬度坐标
    
    range - 指定的距离阈值范围，单位：米(近似)。
    
    返回:
    
    如果此点距离路线的最小距离在阈值范围内，则表示点在路线上，返回true，反之，返回false
  - getTmcStates
```
public byte[] getTmcStates()
```
    获取路段上的所有TMC信息
    
    返回:
    
    tmc状态数组，大小为getSegmentNumber()
  - toJson
```
public byte[] toJson()
```
    将路线保存成json格式[离线]
    
    返回:
    
    json格式的字符串
  - getNavInfoId
```
public long getNavInfoId(int index)
```
    获取指定路段上的四维Id。
    
    参数:
    
    index - 路段索引
    
    返回:
    
    0表示失败，非0值表示有效的四维路段Id。
    
    另请参阅:
    
    getNaviInfoIds()
    
    Notice:
    
    该接口目前仅对在线路线有效，且使用前需要确保初始化 NaviSession的参数中 NaviSessionParams.needNavInfoId
  - getNaviInfoIds
```
public long[] getNaviInfoIds()
```
    获取道路上所有路段的四维Id
    
    返回:
    
    四维Id集合，值为0表示失败，非0表示有效的四维路段Id。数组长度和getSegmentNumber() 一致。RouteBase无效时返回null。
    
    另请参阅:
    
    getNavInfoId(int)
    
    Notice:
    
    该接口目前仅对在线路线有效，且使用前需要确保初始化 NaviSession的参数中 NaviSessionParams.needNavInfoId
  - getTrafficLightNumber
```
public int getTrafficLightNumber()
```
    获取道路上红绿灯数量
    
    返回:
    
    红绿灯数量
    
    另请参阅:
    
    #getSegmentTrafficLight(int)
  - getLengthByTmcState
```
public int getLengthByTmcState(int state)
```
    获取道路中指定tmc状态的路段长度，单位：米
    
    参数:
    
    state - tmc状态TmcSections.State
    
    返回:
    
    指定tmc状态的路段长度
    
    Notice:
    
    在NaviSession.Event.routeTmcUpdated回调中，路线上的tmc状态可能发生变化，需要重新获取长度
  - avoidSegmentsByDescription
```
public boolean avoidSegmentsByDescription(int index)
```
    设置指定路线详情里的路段，只针对离线算路
    
    参数:
    
    index - 路线详情索引
    
    返回:
    
    设置避让成功返回 true,失败返回false
    
    Notice:
    
    设置避让路段前要考虑调用AvoidanceManager.clearAvoidedSegments() 清空之前设置的避让路段，否则之前设置的避让路段将一直有效
  - getAvoidFailedRoadNames
```
public java.lang.String[] getAvoidFailedRoadNames()
```
    获取避让失败的道路名称，只针对离线算路
    
    返回:
    
    返回道路名称数组，数组可能为null或者长度为0
  - getSegmentTmc
```
public int getSegmentTmc(int index)
```
    获取路线上指定路段的路况信息
    
    参数:
    
    index - 路线详情索引
    
    返回:
    
    如果路线上没有 TMC 则始终返回 TmcSections.State.none。该路段上的路况信息。含义同TmcSections.State
  - getRestrictionSegmentPoint
```
public android.graphics.Point[] getRestrictionSegmentPoint(int creepDistance)
```
    获取当前位置向前延伸creepDistance距离，其中有限行信息路段的坐标数组，坐标为对应路段的首个形状点
    
    参数:
    
    creepDistance - 延伸距离,单位：m
    
    返回:
    
    有限行信息路段形状点数组
  - getRestrictionSegmentIndex
```
public int[] getRestrictionSegmentIndex(int creepDistance)
```
    获取当前位置向前延伸creepDistance距离，其中有限行信息路段的路段下标index
    
    参数:
    
    creepDistance - 延伸距离，单位:m
    
    返回:
    
    有限行信息路段形状点数组
  - getSegmentFirstPoint
```
public android.graphics.Point getSegmentFirstPoint(int index)
```
    获取指定index路段的首个形状点坐标
    
    参数:
    
    index -
    
    返回:
  - getSegmentLastPoint
```
public android.graphics.Point getSegmentLastPoint(int index)
```
    获取指定index路段的尾端形状点坐标
    
    参数:
    
    index -
    
    返回:
  - getSegmentStartDistance
```
public int getSegmentStartDistance(int index)
```
    获取指定路段起点到起点距离，单位：m
    
    参数:
    
    index -
    
    返回:
  - getSegmentEndDistance
```
public int getSegmentEndDistance(int index)
```
    获取指定路段终点到起点距离，单位：m
    
    参数:
    
    index -
    
    返回:
  - hasBrokenRestrictions
```
public boolean hasBrokenRestrictions()
```
    获取算出来的路，有没有到打破限行规则
    
    返回:
    
    算出来的路，有没有到打破限行规则
  - getSegmentAttributes
```
public SegmentAttributes getSegmentAttributes(int index)
```
    获取对应index下的segment的详细信息
    
    参数:
    
    index - segment的index值
    
    返回:
    
    segment的详细信息，见SegmentAttributes
  - getTollStations
```
public TollStation[] getTollStations()
```
    获取路线上所有的收费站信息
    
    返回:
    
    路线上所有的收费站信息
  - getOnlineEta
```
public int getOnlineEta()
```
    获取服务器算出来的路线时间，单位：秒
    
    返回:
    
    服务器算出来的路线时间
  - release
```
public void release()
```
    销毁RouteBase，一般用于打断对离线数据的引用，防止离线数据不能及时安装和删除
  - releaseAll
```
public static void releaseAll()
```
    释放所有创建过的RouteBase
  - addReferenceInfo
```
public static void addReferenceInfo(int key,
                                    java.lang.String referenceInfo)
```
    添加RouteBase的引用者信息，内部调试用，外部使用者不要调用
    
    参数:
    
    key -
    
    referenceInfo -
  - removeReferenceInfo
```
public static void removeReferenceInfo(int key)
```
    删除RouteBase的引用者信息，内部调试用，外部使用者不要调用
    
    参数:
    
    key -
  - printReferenceInfos
```
public static void printReferenceInfos()
```
    输出引用者信息，检索词：routeBaseReferenceInfo
  - getTraitNumber
```
public int getTraitNumber()
```
    获取路线标签数量
    
    返回:
  - getRouteTrait
```
public java.lang.String getRouteTrait(int index)
```
    获取路线标签
    
    参数:
    
    index -
    
    返回:

类 RouteBase

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

NO_USE_CURRENT_DISTANCE

构造器详细资料

RouteBase

方法详细资料

getRouteBase

hashCode

equals

getDSegmentIdByIndex

getType

getLength

getEstimatedTime

getToolCharge

getPlan

getStartDirection

getBoundingBox

getFirstShapePoint

getLastShapePoint

getCurrentIndexInDescriptions

getDescriptionItemTmcSection

getTmcTime

getTmcBar

getSegmentNumber

getSegmentFinePoints

getRestrictionInfo

getSegmentLength

hasSailingRoute

hasToll

hasHighWay

getDescription

enableTmcColors

isTmcColorsEnabled

setTmcStyle

getTmcStyle

_getSegmentIndexByDistance

testPoint

getTmcStates

toJson

getNavInfoId

getNaviInfoIds

getTrafficLightNumber

getLengthByTmcState

avoidSegmentsByDescription

getAvoidFailedRoadNames

getSegmentTmc

getRestrictionSegmentPoint

getRestrictionSegmentIndex

getSegmentFirstPoint

getSegmentLastPoint

getSegmentStartDistance

getSegmentEndDistance

hasBrokenRestrictions

getSegmentAttributes

getTollStations

getOnlineEta

release

releaseAll

addReferenceInfo

removeReferenceInfo

printReferenceInfos

getTraitNumber

getRouteTrait