Map Doc  1.0
iOS-引擎SDK-开放平台
MBNaviSession.h 文件参考
#import <Foundation/Foundation.h>
#import "MBNaviBaseTypes.h"
#import "MBEngine.h"

浏览源代码.

class  MBNaviSession
 

类型定义

typedef void(^ LiaoNingRouteRequest) (MBRouteRequest *req, void *userdata)
 
typedef void(^ LiaoNingRouteResponse) (NSString *response, void *userdata)
 
typedef void(* MBRouteResponseCallback) (const char *response, size_t responseLength, void *userdata)
 用以拦截在线算路服务器响应数据的回调函数形式,响应数据不可修改。 更多...
 
typedef void(* MBRouteRequestCallback) (MBRouteRequest *request, void *userdata)
 用以拦截在线算路请求的回调函数形式,允许使用者修改请求数据。 更多...
 

枚举

enum  MBCameraDataState { MBCameraDataState_none = 0, MBCameraDataState_vip = 1, MBCameraDataState_normal = 2 }
 
enum  MBTRouterError {
  MBERouterError_None = 0, MBERouterError_OriDestTooNear = 1, MBERouterError_SetOriFailed = 2, MBERouterError_SetDestFailed = 3,
  MBERouterError_ComputeFailed = 4, MBERouterError_MissingSubfiles = 5, MBERouterError_NotEnoughMemory = 6, MBERouterError_NetworkError = 7,
  MBERouterError_oriNoData = 8, MBERouterError_destNoData = 9, MBERouterError_waypointNoData = 10, MBERouterError_oriAuthError = 11,
  MBERouterError_destAuthError = 12, MBERouterError_waypointAuthError = 13, MBERouterError_illegalCall = 14, MBERouterError_oriGuidMismatch = 15,
  MBERouterError_destGuidMismatch = 16, MBERouterError_waypointGuidMismatch = 17, MBERouterError_baseDataInvalidOrMissing = 18, MBERouterError_resultTooShort = 19
}
 
enum  MBAvoidUTurnMode { MBAvoidUTurnMode_disable = 0, MBAvoidUTurnMode_auto, MBAvoidUTurnMode_always }
 
enum  MBNaviSessionNaviStartVoiceMode { MBNaviSessionNaviStartVoiceMode_detailed = 0, MBNaviSessionNaviStartVoiceMode_brief = 1, MBNaviSessionNaviStartVoiceMode_pnd = 2 }
 
enum  MBNaviSessionRouteMethod { MBNaviSessionRouteMethod_single, MBNaviSessionRouteMethod_multipleRule, MBNaviSessionRouteMethod_multipleResult }
 

函数

typedef NS_OPTIONS (NSUInteger, MBTmcRequest)
 

类型定义说明

◆ LiaoNingRouteRequest

typedef void(^ LiaoNingRouteRequest) (MBRouteRequest *req, void *userdata)

◆ LiaoNingRouteResponse

typedef void(^ LiaoNingRouteResponse) (NSString *response, void *userdata)

◆ MBRouteRequestCallback

typedef void(* MBRouteRequestCallback) (MBRouteRequest *request, void *userdata)

用以拦截在线算路请求的回调函数形式,允许使用者修改请求数据。

参数
[in,out]request算路请求,其中包括: url:允许回调中做原位修改,以 \0 标识结束; postData:若传入值为NULL,则由回调函数使用malloc分配空间并赋值, 若不为NULL,则回调函数中要追加数据需要使用 realloc 扩展空间并赋值, 由引擎负责释放空间,客户端不需要关注; postDataLength:postData长度。 [in] userdata userdata,客户端设置回调函数时传入。

◆ MBRouteResponseCallback

typedef void(* MBRouteResponseCallback) (const char *response, size_t responseLength, void *userdata)

用以拦截在线算路服务器响应数据的回调函数形式,响应数据不可修改。

参数
[in]response服务器响应数据。(不可修改) [in] responseLength 服务器响应数据长度 [in] userdata userdata,客户端设置回调函数时传入。

枚举类型说明

◆ MBAvoidUTurnMode

防止掉头设置

枚举值
MBAvoidUTurnMode_disable 
MBAvoidUTurnMode_auto 
MBAvoidUTurnMode_always 

◆ MBCameraDataState

初始化引擎后,已加载的电子眼数据状态

枚举值
MBCameraDataState_none 
MBCameraDataState_vip 
MBCameraDataState_normal 

◆ MBNaviSessionNaviStartVoiceMode

导航开始时的语音播报模式,分为详细模式和简洁模式

枚举值
MBNaviSessionNaviStartVoiceMode_detailed 

详细模式

MBNaviSessionNaviStartVoiceMode_brief 

简洁模式

MBNaviSessionNaviStartVoiceMode_pnd 

PND 模式

◆ MBNaviSessionRouteMethod

控制算路方式

枚举值
MBNaviSessionRouteMethod_single 
MBNaviSessionRouteMethod_multipleRule 

算一条路

MBNaviSessionRouteMethod_multipleResult 

用“系统推荐”、“距离优先”、“高速优先”、“避让收费” 4种规则算出4条路线结果(其中可能有相同结果),此时路线计划(RoutePlan)中的算路规则字段会被忽略。

MBRoutePlan 中的规则,尝试算多条路线结果(最终结果可能是1条~3条)

◆ MBTRouterError

算路失败后返回的错误类型

枚举值
MBERouterError_None 
MBERouterError_OriDestTooNear 

起点终点距离太近

MBERouterError_SetOriFailed 

设置起点失败,常见的原因是起点离道路很远,或者没有算路数据文件(.red)

MBERouterError_SetDestFailed 

设置终点失败,常见的原因是终点离道路很远

MBERouterError_ComputeFailed 

路线计算失败。如果是在线算路,则错误码会以字符串形式保存在 additionalMessage 中。

MBERouterError_MissingSubfiles 

某些省份的数据不存在或没有授权,省份的名称保存在 additionalMessage 中。

MBERouterError_NotEnoughMemory 

内存不足。

MBERouterError_NetworkError 

网络出错。在线算路时网络链接出错或服务器出错。

MBERouterError_oriNoData 

起点所在位置没有数据

MBERouterError_destNoData 

终点所在位置没有数据

MBERouterError_waypointNoData 

途经点所在位置没有数据

MBERouterError_oriAuthError 

起点所在位置数据授权错误

MBERouterError_destAuthError 

终点所在位置数据授权错误

MBERouterError_waypointAuthError 

途经点所在位置数据授权错误

MBERouterError_illegalCall 

不合理的调用接口导致的错误,如不支持步行离线算路的引擎中,调用离线步行

MBERouterError_oriGuidMismatch 

起点所在位置数据与基础数据(base.dat)不匹配

MBERouterError_destGuidMismatch 

终点所在位置数据与基础数据(base.dat)不匹配

MBERouterError_waypointGuidMismatch 

途经点所在位置数据与基础数据(base.dat)不匹配

MBERouterError_baseDataInvalidOrMissing 

基础数据(base.dat)无效或不存在

MBERouterError_resultTooShort 

路线结果过短(长度为0)

函数说明

◆ NS_OPTIONS()

typedef NS_OPTIONS ( NSUInteger  ,
MBTmcRequest   
)