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

兴趣点( Poi )实体类 更多...

#import <MBPoiFavorite.h>

类 MBPoiFavorite 继承关系图:
MBObject MBReverseGeocode

构造函数

(void) - reset
 
(void) - updateFromPoiObject:
 
(nonnull MBPoiFavorite *) - clone
 
(void) - updatePoiObject:
 
- 构造函数 继承自 MBObject
(instancetype) - initWithHandle:
 
(void *) - getHandle
 

属性

NSInteger poiId
 唯一 ID 更多...
 
unsigned int type
 
MBPoint pos
 导航坐标(如公园的入口) 更多...
 
MBPoint displayPos
 
NSString *_Nonnull name
 Poi 名称 更多...
 
NSString *_Nonnull address
 地址 更多...
 
NSString *_Nullable phoneNumber
 电话 更多...
 
NSString *_Nullable regionName
 所在地区名 更多...
 
NSString *_Nullable typeName
 Poi 类型名称 更多...
 
NSInteger distance
 与搜索中心点的距离 更多...
 
NSInteger userData
 用户自定义 更多...
 
BOOL isValidate
 
NSString *_Nullable pid
 常用地址标识(如"家"、"常用地址1") 更多...
 
NSString *_Nullable displayName
 显示名称(由用户编辑而来) 更多...
 
NSString *_Nullable uid
 云同步后的 Poi 唯一标识 更多...
 
NSInteger editMode
 等待云同步的 Poi 状态标识(新增、删除、修改等) 更多...
 
NSInteger index
 常用地址/收藏索引 更多...
 
double useTime
 常用地址/收藏的新增时间戳 更多...
 

详细描述

兴趣点( Poi )实体类

函数文档

◆ clone()

- (nonnull MBPoiFavorite *) clone

返回一个所有属性值相同,但使用不同内存空间的 Poi 对象

返回
克隆后的 Poi 对象

◆ reset()

- (void) reset

重置该 Poi

重置后 Poi 对象的所有属性置为 0 或者 nil

◆ updateFromPoiObject:()

- (void) updateFromPoiObject: (nonnull MBPoiFavorite *)  poiObject

从指定的 Poi 对象中复制所有属性值

参数
poiObject作为复制来源的 Poi 对象

◆ updatePoiObject:()

- (void) updatePoiObject: (nonnull MBPoiFavorite *)  poiObject

将当前 Poi 对象的所有属性值复制给另一个 Poi 对象

参数
poiObject作为复制结果的 Poi 对象(需为合法创建的实例,其属性值会被改写)

属性说明

◆ address

- (NSString* _Nonnull) address
readwritenonatomiccopy

地址

◆ displayName

- (NSString* _Nullable) displayName
readwritenonatomiccopy

显示名称(由用户编辑而来)

◆ displayPos

- (MBPoint) displayPos
readwritenonatomicassign

显示坐标(如公园的中心点)

与导航坐标可能一致也可能不一致

◆ distance

- (NSInteger) distance
readwritenonatomicassign

与搜索中心点的距离

◆ editMode

- (NSInteger) editMode
readwritenonatomicassign

等待云同步的 Poi 状态标识(新增、删除、修改等)

◆ index

- (NSInteger) index
readwritenonatomicassign

常用地址/收藏索引

◆ isValidate

- (BOOL) isValidate
readnonatomicassign

Poi 是否有效

判断依据为:如果导航坐标的x或y有其一为0或INT_MAX,则 Poi 无效,反之 Poi 有效

◆ name

- (NSString* _Nonnull) name
readwritenonatomiccopy

Poi 名称

◆ phoneNumber

- (NSString* _Nullable) phoneNumber
readwritenonatomiccopy

电话

◆ pid

- (NSString* _Nullable) pid
readwritenonatomiccopy

常用地址标识(如"家"、"常用地址1")

◆ poiId

- (NSInteger) poiId
readwritenonatomicassign

唯一 ID

◆ pos

- (MBPoint) pos
readwritenonatomicassign

导航坐标(如公园的入口)

◆ regionName

- (NSString* _Nullable) regionName
readwritenonatomiccopy

所在地区名

◆ type

- (unsigned int) type
readwritenonatomicassign

Poi 类型码

0 表示该 MBPoiFavorite 无效

还有一种情况:客户端用 MBPoiFavorite 来存储路线详情时, type 也为 0

◆ typeName

- (NSString* _Nullable) typeName
readwritenonatomiccopy

Poi 类型名称

◆ uid

- (NSString* _Nullable) uid
readwritenonatomiccopy

云同步后的 Poi 唯一标识

◆ userData

- (NSInteger) userData
readwritenonatomicassign

用户自定义

◆ useTime

- (double) useTime
readwritenonatomicassign

常用地址/收藏的新增时间戳


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