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