Map Doc  1.0
iOS-引擎SDK-开放平台
MBRouteBase类 参考

#import <MBRouteBase.h>

类 MBRouteBase 继承关系图:

构造函数

(instancetype) - initWithRouteBase:
 
(void *) - getRouteBase
 
(MBRouteType- getType
 
(NSInteger) - getLength
 
(NSString *) - getDescription
 
(BOOL) - hasToll
 
(NSInteger) - getTollCharge
 
(BOOL) - hasSailing
 
(NSInteger) - getEstimatedTime
 
(MBRoutePlan *) - getPlan
 
(int) - getStartDirection
 
(MBRect- getBoundingBox
 
(MBPoint- getFirstShapePoint
 
(MBPoint- getLastShapePoint
 
(void) - setDirectionsFlag:
 
(NSInteger) - getCurrentIndexInDescriptions:
 
(NSInteger) - getDescriptionNumber
 
(MBRouteDescriptionItem *) - getDescriptionItem:curDistance:
 
(NSInteger) - getSegmentNumber
 
(BOOL) - isEqualRouteBase:
 
(MBPoint *) - getSegmentFinePoints:withPointNum:
 
(NSInteger) - getTmcSections:pixels:tmcStates:
 
(NSInteger) - getTmcSections:outPixels:outTmcStates:
 
(NSInteger) - getDescriptionItemTmcSection:rates:tmcStates:
 
(void) - enableTmcColors:
 
(BOOL) - isTmcColorsEnabled
 
(void) - updateTmc
 
(NSString *) - getTmcTime
 
(MBTmcState- getSegmentTmc:
 
(NSInteger) - getTrafficLightNumber
 
(void *) - handle
 
(RouteArrowData *) - getArrowPointsByIndex:
 
(MBRerouteReaseon- getRerouteReason
 
(BOOL) - hasSegmentTrafficLight:
 
(NSInteger) - getNavInfoId:
 
(NSString *) - getRoadNameWithDescriptionIndex:
 

属性

MBRouteTmcStyle style
 

详细描述

路线的基本信息

函数文档

◆ enableTmcColors:()

- (void) enableTmcColors: (BOOL)  enable

是否打开Tmc蚯蚓路,默认:false,不显示TMC信息。

参数
enableYES打开,NO关闭。

◆ getArrowPointsByIndex:()

- (RouteArrowData *) getArrowPointsByIndex: (NSInteger)  index

获取转向箭头数据

参数
index箭头索引
返回
箭头数据
自从
4.9.x

◆ getBoundingBox()

- (MBRect) getBoundingBox

获取当前路线的包络盒

返回
当前路线包络盒

◆ getCurrentIndexInDescriptions:()

- (NSInteger) getCurrentIndexInDescriptions: (int)  curDistance

返回当前车所在路线上的位置所对应的路线详情下标,只有 GPS 定位有效

参数
curDistance当前路线起点距离车的距离
返回
当前所在位置位于路线详情中的下标

◆ getDescription()

- (NSString *) getDescription

获取当前路线的描述信息

返回
返回路线的描述信息

◆ getDescriptionItem:curDistance:()

- (MBRouteDescriptionItem*) getDescriptionItem: (NSInteger)  index
curDistance: (NSInteger)  curDistance 

获取路线说明实例

参数
index指定要获取的第index个路线说明,包含途经点,MBRouteBase getDescriptionNumber
curDistance但前车所在路线上的位置,若不用此参数,则设置为2147483647,即 int 最大值
返回
路线说明实例,如果存在则返回 MBRouteDescriptionItem类型实例,如果不存在,返回nil

◆ getDescriptionItemTmcSection:rates:tmcStates:()

- (NSInteger) getDescriptionItemTmcSection: (NSInteger)  index
rates: (NSMutableArray *)  rates
tmcStates: (NSMutableArray *)  tmcStates 

获取指定索引路段的描述信息

参数
index路段所以
rates路况比例
tmcStatesTMC路段描述
返回
rates 的个数
自从
4.10.x

◆ getDescriptionNumber()

- (NSInteger) getDescriptionNumber

返回路线详情中路线说明的个数,区别于Segment(路段)个数。

返回
路线说明的个数

◆ getEstimatedTime()

- (NSInteger) getEstimatedTime

路线全程所需时间,单位:秒

返回
全程所需时间

◆ getFirstShapePoint()

- (MBPoint) getFirstShapePoint

获取路线上的第一个形状点

返回
路线上的第一个形状点

◆ getLastShapePoint()

- (MBPoint) getLastShapePoint

获取路线上最后一个形状点

返回
路线上最后一个形状点

◆ getLength()

- (NSInteger) getLength

获取当前路线长度,单位:米

返回
返回路线长度

◆ getNavInfoId:()

- (NSInteger) getNavInfoId: (NSInteger)  index

获取路线结果中的路段四维Id

◆ getPlan()

- (MBRoutePlan *) getPlan

获取路线规划对象

返回
MBRoutePlan 当前道路的路线规划对象

◆ getRerouteReason()

- (MBRerouteReaseon) getRerouteReason

返回TMC重算路的原因

返回
指定的路线。

◆ getRoadNameWithDescriptionIndex:()

- (NSString *) getRoadNameWithDescriptionIndex: (NSInteger)  index

◆ getRouteBase()

- (void *) getRouteBase

获取路线

返回
base 路线

◆ getSegmentFinePoints:withPointNum:()

- (MBPoint *) getSegmentFinePoints: (NSInteger)  index
withPointNum: (NSInteger *)  num 

获取路段的形状点

参数
index路段索引
numNSInteger 指针,用于得到返回的 MBPoint 数组的个数
返回
MBPoint 数组,即该路段的点的集合,同时用参数指针得到个数
自从
4.9.x

◆ getSegmentNumber()

- (NSInteger) getSegmentNumber

获取当前路线共有多少个路段

返回
路线个数
自从
4.9.x

◆ getSegmentTmc:()

- (MBTmcState) getSegmentTmc: (int)  index

获取路线上指定路段的路况信息

参数
index路段索引
返回
Tmc状态
自从
4.9.x

◆ getStartDirection()

- (int) getStartDirection

路线的开始方向,单位:度

返回
起始路线方向

◆ getTmcSections:outPixels:outTmcStates:()

- (NSInteger) getTmcSections: (NSInteger)  maxSection
outPixels: (UInt32 *)  pixels
outTmcStates: (UInt8 *)  tmcStates 

◆ getTmcSections:pixels:tmcStates:()

- (NSInteger) getTmcSections: (NSInteger)  maxSection
pixels: (NSMutableArray *)  pixels
tmcStates: (NSMutableArray *)  tmcStates 

获取 TMC 柱状图,需联网

参数
maxSection柱状图的长度(以像素为单位),这个值也是pixels和states这两个数组的最大长度
pixels每个值表示一个区间,每个区间的起点是上一个区间的终点或0,比如:pixels[1] = 10,pixels[2] = 30,则柱状图中第10个像素到第29个像素用state[2]的状态填充
tmcStates每个区间对应的tmc状态
返回
实际返回的区间个数
自从
4.10.x

◆ getTmcTime()

- (NSString *) getTmcTime

获取TMC信息更新时间字符串

返回
时间字符串

◆ getTollCharge()

- (NSInteger) getTollCharge

获取收费金额

返回
金额(元)

◆ getTrafficLightNumber()

- (NSInteger) getTrafficLightNumber

返回路线上的红绿灯数量

返回
红绿灯数量
自从
5.1.x

◆ getType()

- (MBRouteType) getType

获取当前路线类型为在线还是离线

返回
返回MBRouteType类型的结果

◆ handle()

- (void *) handle

导出handle

◆ hasSailing()

- (BOOL) hasSailing

获取当前路线是否有轮渡

返回
返回判断值YES表示有

◆ hasSegmentTrafficLight:()

- (BOOL) hasSegmentTrafficLight: (NSInteger)  index

指定路段是否存在红绿灯

参数
index路段索引
返回
YES 表示有
自从
5.0.x

◆ hasToll()

- (BOOL) hasToll

获取当前路线是否有收费

返回
返回判断值YES表示有

◆ initWithRouteBase:()

- (instancetype) initWithRouteBase: (void *)  base

初始化路线查询方案

参数
base路线
返回
self

◆ isEqualRouteBase:()

- (BOOL) isEqualRouteBase: (MBRouteBase *)  route

比较是否同一条路径

参数
route待验证路径
返回
是否相同,True 表示同一条路径
自从
4.9.x

◆ isTmcColorsEnabled()

- (BOOL) isTmcColorsEnabled

Tmc蚯蚓路状态

返回
YES打开,NO关闭。

◆ setDirectionsFlag:()

- (void) setDirectionsFlag: (MBDirectionsFlag flag

设置路线详情的显示方式

参数
flag参见 MBDirectionsFlag
自从
4.9.x

◆ updateTmc()

- (void) updateTmc

更新Tmc。

属性说明

◆ style

- (MBRouteTmcStyle) style
readwritenonatomicassign

获取实时路况(TMC)模式样式,默认:MBTmcRouteDrawStyle_normal


该类的文档由以下文件生成: