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
42**起始版本：** 4.0
43
44**参数:**
45
46| 名称 | 描述 |
47| -------- | -------- |
48| req | 设置基站轨迹数据记录参数。详见[CellbatchingRequest](_cellbatching_request.md)。 |
49
50**返回：**
51
52如果操作成功，则返回0。
53
54如果操作失败，则返回负值。
55
56
57### FlushCellbatching()
58
59```
60ICellbatchingInterface::FlushCellbatching ()
61```
62**描述**
63
64上报缓存的基站轨迹数据。
65
66上报基站数据的个数与设备的缓存buffer大小、设备接收的基站数据个数有关。flush之后，底层缓存基站数据会被清空。
67
68**起始版本：** 4.0
69
70**返回：**
71
72如果操作成功，则返回0。
73
74如果操作失败，则返回负值。
75
76
77### RegisterCellbatchingCallback()
78
79```
80ICellbatchingInterface::RegisterCellbatchingCallback ([in] ICellbatchingCallback callbackObj)
81```
82**描述**
83
84注册回调函数。
85
86用户在开启基站轨迹数据记录功能前，需要先注册该回调函数。当应用主动获取基站轨迹数据时，会通过回调函数进行上报。
87
88**起始版本：** 4.0
89
90**参数:**
91
92| 名称 | 描述 |
93| -------- | -------- |
94| callbackObj | 要注册的回调函数，只需成功订阅一次，无需重复订阅。详见[ICellbatchingCallback](interface_i_cellbatching_callback.md)。 |
95
96**返回：**
97
98如果注册回调函数成功，则返回0。
99
100如果注册回调函数失败，则返回负值。
101
102
103### UnregisterCellbatchingCallback()
104
105```
106ICellbatchingInterface::UnregisterCellbatchingCallback ([in] ICellbatchingCallback callbackObj)
107```
108**描述**
109
110取消注册回调函数。
111
112取消之前注册的回调函数。当应用不需要使用基站轨迹数据记录功能，或需要更换回调函数时，需要取消注册回调函数。
113
114**起始版本：** 4.0
115
116**参数:**
117
118| 名称 | 描述 |
119| -------- | -------- |
120| callbackObj | 要取消注册的回调函数，只需成功取消订阅一次，无需重复取消订阅。详见[ICellbatchingCallback](interface_i_cellbatching_callback.md)。 |
121
122**返回：**
123
124如果取消注册回调函数成功，则返回0。
125
126如果取消注册回调函数失败，则返回负值。
127