• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ICellbatchingInterface
2
3
4## 概述
5
6定义对基站轨迹数据记录模块进行基本操作的接口。
7
8接口包含注册回调函数,取消注册回调函数,使能和去使能基站轨迹数据记录,主动获取基站轨迹数据。
9
10**起始版本:** 4.0
11
12**相关模块:**[HdiLpfenceCellbatching](_hdi_lpfence_cellbatching.md)
13
14
15## 汇总
16
17
18### Public 成员函数
19
20| 名称 | 描述 |
21| -------- | -------- |
22| [RegisterCellbatchingCallback](#registercellbatchingcallback) ([in] [ICellbatchingCallback](interface_i_cellbatching_callback.md) callbackObj) | 注册回调函数。  |
23| [UnregisterCellbatchingCallback](#unregistercellbatchingcallback) ([in] [ICellbatchingCallback](interface_i_cellbatching_callback.md) callbackObj) | 取消注册回调函数。  |
24| [CellbatchingSwitch](#cellbatchingswitch) ([in] struct [CellbatchingRequest](_cellbatching_request.md) req) | 打开/关闭基站轨迹数据记录。  |
25| [FlushCellbatching](#flushcellbatching) () | 上报缓存的基站轨迹数据。  |
26
27
28## 成员函数说明
29
30
31### CellbatchingSwitch()
32
33```
34ICellbatchingInterface::CellbatchingSwitch ([in] struct CellbatchingRequest req)
35```
36**描述**
37打开/关闭基站轨迹数据记录。
38
39功能打开后,会将设备接收到的基站数据进行缓存,若接收到的基站数据与上一次接收的数据相同,则不会进行此次的数据缓存。
40
41**起始版本:** 4.0
42
43**参数:**
44
45| 名称 | 描述 |
46| -------- | -------- |
47| req | 设置基站轨迹数据记录参数。详见[CellbatchingRequest](_cellbatching_request.md)。 |
48
49**返回:**
50
51如果操作成功,则返回0。
52
53如果操作失败,则返回负值。
54
55
56### FlushCellbatching()
57
58```
59ICellbatchingInterface::FlushCellbatching ()
60```
61**描述**
62上报缓存的基站轨迹数据。
63
64上报基站数据的个数与设备的缓存buffer大小、设备接收的基站数据个数有关。flush之后,底层缓存基站数据会被清空。
65
66**起始版本:** 4.0
67
68**返回:**
69
70如果操作成功,则返回0。
71
72如果操作失败,则返回负值。
73
74
75### RegisterCellbatchingCallback()
76
77```
78ICellbatchingInterface::RegisterCellbatchingCallback ([in] ICellbatchingCallback callbackObj)
79```
80**描述**
81注册回调函数。
82
83用户在开启基站轨迹数据记录功能前,需要先注册该回调函数。当应用主动获取基站轨迹数据时,会通过回调函数进行上报。
84
85**起始版本:** 4.0
86
87**参数:**
88
89| 名称 | 描述 |
90| -------- | -------- |
91| callbackObj | 要注册的回调函数,只需成功订阅一次,无需重复订阅。详见[ICellbatchingCallback](interface_i_cellbatching_callback.md)。 |
92
93**返回:**
94
95如果注册回调函数成功,则返回0。
96
97如果注册回调函数失败,则返回负值。
98
99
100### UnregisterCellbatchingCallback()
101
102```
103ICellbatchingInterface::UnregisterCellbatchingCallback ([in] ICellbatchingCallback callbackObj)
104```
105**描述**
106取消注册回调函数。
107
108取消之前注册的回调函数。当应用不需要使用基站轨迹数据记录功能,或需要更换回调函数时,需要取消注册回调函数。
109
110**起始版本:** 4.0
111
112**参数:**
113
114| 名称 | 描述 |
115| -------- | -------- |
116| callbackObj | 要取消注册的回调函数,只需成功取消订阅一次,无需重复取消订阅。详见[ICellbatchingCallback](interface_i_cellbatching_callback.md)。 |
117
118**返回:**
119
120如果取消注册回调函数成功,则返回0。
121
122如果取消注册回调函数失败,则返回负值。
123