1# IGnssInterface 2 3 4## 概述 5 6声明GNSS模块提供的接口函数，包括启动GNSS芯片、启动导航、设置GNSS工作模式、注入参考信息、 删除辅助数据、注入PGNSS数据、获取GNSS缓存位置个数、获取所有缓存位置。 7 8**起始版本：** 3.2 9 10**相关模块：**[HdiGnss](_hdi_gnss.md) 11 12 13## 汇总 14 15 16### Public 成员函数 17 18| 名称 | 描述 | 19| -------- | -------- | 20| [SetGnssConfigPara](#setgnssconfigpara) ([in] struct [GnssConfigPara](_gnss_config_para.md) para) | 设置GNSS配置参数。 | 21| [EnableGnss](#enablegnss) ([in] [IGnssCallback](interface_i_gnss_callback.md) callbackObj) | 使能GNSS功能，并设置回调函数。 | 22| [DisableGnss](#disablegnss) () | 去使能GNSS功能。 | 23| [StartGnss](#startgnss) ([in] enum GnssStartType type) | 启动导航功能。 | 24| [StopGnss](#stopgnss) ([in] enum GnssStartType type) | 停止导航功能。 | 25| [SetGnssReferenceInfo](#setgnssreferenceinfo) ([in] struct [GnssRefInfo](_gnss_ref_info.md) refInfo) | 注入GNSS参考信息。 | 26| [DeleteAuxiliaryData](#deleteauxiliarydata) ([in] enum GnssAuxiliaryData data) | 删除指定的辅助数据。 | 27| [SetPredictGnssData](#setpredictgnssdata) ([in] String data) | 注入PGNSS数据。 | 28| [GetCachedGnssLocationsSize](#getcachedgnsslocationssize) ([out] int size) | 获取GNSS缓存位置个数。 | 29| [GetCachedGnssLocations](#getcachedgnsslocations) () | 请求一次性获取GNSS缓存中的所有位置信息，并清空缓存buffer，缓存位置通过回调上报。 | 30 31 32## 成员函数说明 33 34 35### DeleteAuxiliaryData() 36 37``` 38IGnssInterface::DeleteAuxiliaryData ([in] enum GnssAuxiliaryData data) 39``` 40 41**描述** 42 43 44删除指定的辅助数据。 45 46**起始版本：** 3.2 47 48**参数:** 49 50| 名称 | 描述 | 51| -------- | -------- | 52| data | 表示辅助数据类型。详情参考[GnssAuxiliaryData](_hdi_gnss.md#gnssauxiliarydata)。 | 53 54**返回：** 55 56返回0表示成功，返回负数表示失败。 57 58 59### DisableGnss() 60 61``` 62IGnssInterface::DisableGnss () 63``` 64 65**描述** 66 67 68去使能GNSS功能。 69 70**起始版本：** 3.2 71 72**返回：** 73 74返回0表示成功，返回负数表示失败。 75 76 77### EnableGnss() 78 79``` 80IGnssInterface::EnableGnss ([in] IGnssCallback callbackObj) 81``` 82 83**描述** 84 85 86使能GNSS功能，并设置回调函数。 87 88**起始版本：** 3.2 89 90**参数:** 91 92| 名称 | 描述 | 93| -------- | -------- | 94| callback | 表示GNSS回调函数。GNSS驱动通过此回调函数上报定位结果和卫星状态信息等。 详情参考[IGnssCallback](interface_i_gnss_callback.md). | 95 96**返回：** 97 98返回0表示成功，返回负数表示失败。 99 100 101### GetCachedGnssLocations() 102 103``` 104IGnssInterface::GetCachedGnssLocations () 105``` 106 107**描述** 108 109 110请求一次性获取GNSS缓存中的所有位置信息，并清空缓存buffer，缓存位置通过回调上报。 111 112**起始版本：** 3.2 113 114**返回：** 115 116返回0表示成功，返回负数表示失败。 117 118 119### GetCachedGnssLocationsSize() 120 121``` 122IGnssInterface::GetCachedGnssLocationsSize ([out] int size) 123``` 124 125**描述** 126 127 128获取GNSS缓存位置个数。 129 130**起始版本：** 3.2 131 132**参数:** 133 134| 名称 | 描述 | 135| -------- | -------- | 136| size | 表示GNSS缓存位置个数。 | 137 138**返回：** 139 140返回0表示成功，返回负数表示失败。 141 142 143### SetGnssConfigPara() 144 145``` 146IGnssInterface::SetGnssConfigPara ([in] struct GnssConfigPara para) 147``` 148 149**描述** 150 151 152设置GNSS配置参数。 153 154**起始版本：** 3.2 155 156**参数:** 157 158| 名称 | 描述 | 159| -------- | -------- | 160| para | 表示GNSS配置参数。包含基础的GNSS配置和GNSS缓存位置功能配置参数。详情参考[GnssConfigPara](_gnss_config_para.md)。 | 161 162**返回：** 163 164返回0表示成功，返回负数表示失败。 165 166 167### SetGnssReferenceInfo() 168 169``` 170IGnssInterface::SetGnssReferenceInfo ([in] struct GnssRefInfo refInfo) 171``` 172 173**描述** 174 175 176注入GNSS参考信息。 177 178**起始版本：** 3.2 179 180**参数:** 181 182| 名称 | 描述 | 183| -------- | -------- | 184| refInfo | 表示GNSS参考信息，包含参考时间和参考位置。详情参考[GnssRefInfo](_gnss_ref_info.md)。 | 185 186**返回：** 187 188返回0表示成功，返回负数表示失败。 189 190 191### SetPredictGnssData() 192 193``` 194IGnssInterface::SetPredictGnssData ([in] String data) 195``` 196 197**描述** 198 199 200注入PGNSS数据。 201 202**起始版本：** 3.2 203 204**参数:** 205 206| 名称 | 描述 | 207| -------- | -------- | 208| data | 表示PGNSS数据。 | 209 210**返回：** 211 212返回0表示成功，返回负数表示失败。 213 214 215### StartGnss() 216 217``` 218IGnssInterface::StartGnss ([in] enum GnssStartType type) 219``` 220 221**描述** 222 223 224启动导航功能。 225 226**起始版本：** 3.2 227 228**参数:** 229 230| 名称 | 描述 | 231| -------- | -------- | 232| type | 表示GNSS启动类型，该参数是为了区分正常的GNSS定位功能和GNSS缓存功能。 详情参考[GnssStartType](_hdi_gnss.md#gnssstarttype)。 | 233 234**返回：** 235 236返回0表示成功，返回负数表示失败。 237 238 239### StopGnss() 240 241``` 242IGnssInterface::StopGnss ([in] enum GnssStartType type) 243``` 244 245**描述** 246 247 248停止导航功能。 249 250**起始版本：** 3.2 251 252**参数:** 253 254| 名称 | 描述 | 255| -------- | -------- | 256| type | 表示GNSS启动类型，该参数为了区分正常的GNSS定位功能和GNSS缓存功能。 详情参考[GnssStartType](_hdi_gnss.md#gnssstarttype)。 | 257 258**返回：** 259 260返回0表示成功，返回负数表示失败。 261