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**起始版本：** 3.2 46 47**参数:** 48 49| 名称 | 描述 | 50| -------- | -------- | 51| data | 表示辅助数据类型。详情参考[GnssAuxiliaryData](_hdi_gnss.md#gnssauxiliarydata)。 | 52 53**返回：** 54 55返回0表示成功，返回负数表示失败。 56 57 58### DisableGnss() 59 60``` 61IGnssInterface::DisableGnss () 62``` 63 64**描述** 65 66去使能GNSS功能。 67 68**起始版本：** 3.2 69 70**返回：** 71 72返回0表示成功，返回负数表示失败。 73 74 75### EnableGnss() 76 77``` 78IGnssInterface::EnableGnss ([in] IGnssCallback callbackObj) 79``` 80 81**描述** 82 83使能GNSS功能，并设置回调函数。 84 85**起始版本：** 3.2 86 87**参数:** 88 89| 名称 | 描述 | 90| -------- | -------- | 91| callback | 表示GNSS回调函数。GNSS驱动通过此回调函数上报定位结果和卫星状态信息等。 详情参考[IGnssCallback](interface_i_gnss_callback.md). | 92 93**返回：** 94 95返回0表示成功，返回负数表示失败。 96 97 98### GetCachedGnssLocations() 99 100``` 101IGnssInterface::GetCachedGnssLocations () 102``` 103 104**描述** 105 106请求一次性获取GNSS缓存中的所有位置信息，并清空缓存buffer，缓存位置通过回调上报。 107 108**起始版本：** 3.2 109 110**返回：** 111 112返回0表示成功，返回负数表示失败。 113 114 115### GetCachedGnssLocationsSize() 116 117``` 118IGnssInterface::GetCachedGnssLocationsSize ([out] int size) 119``` 120 121**描述** 122 123获取GNSS缓存位置个数。 124 125**起始版本：** 3.2 126 127**参数:** 128 129| 名称 | 描述 | 130| -------- | -------- | 131| size | 表示GNSS缓存位置个数。 | 132 133**返回：** 134 135返回0表示成功，返回负数表示失败。 136 137 138### SetGnssConfigPara() 139 140``` 141IGnssInterface::SetGnssConfigPara ([in] struct GnssConfigPara para) 142``` 143 144**描述** 145 146设置GNSS配置参数。 147 148**起始版本：** 3.2 149 150**参数:** 151 152| 名称 | 描述 | 153| -------- | -------- | 154| para | 表示GNSS配置参数。包含基础的GNSS配置和GNSS缓存位置功能配置参数。详情参考[GnssConfigPara](_gnss_config_para.md)。 | 155 156**返回：** 157 158返回0表示成功，返回负数表示失败。 159 160 161### SetGnssReferenceInfo() 162 163``` 164IGnssInterface::SetGnssReferenceInfo ([in] struct GnssRefInfo refInfo) 165``` 166 167**描述** 168 169注入GNSS参考信息。 170 171**起始版本：** 3.2 172 173**参数:** 174 175| 名称 | 描述 | 176| -------- | -------- | 177| refInfo | 表示GNSS参考信息，包含参考时间和参考位置。详情参考[GnssRefInfo](_gnss_ref_info.md)。 | 178 179**返回：** 180 181返回0表示成功，返回负数表示失败。 182 183 184### SetPredictGnssData() 185 186``` 187IGnssInterface::SetPredictGnssData ([in] String data) 188``` 189 190**描述** 191 192注入PGNSS数据。 193 194**起始版本：** 3.2 195 196**参数:** 197 198| 名称 | 描述 | 199| -------- | -------- | 200| data | 表示PGNSS数据。 | 201 202**返回：** 203 204返回0表示成功，返回负数表示失败。 205 206 207### StartGnss() 208 209``` 210IGnssInterface::StartGnss ([in] enum GnssStartType type) 211``` 212 213**描述** 214 215启动导航功能。 216 217**起始版本：** 3.2 218 219**参数:** 220 221| 名称 | 描述 | 222| -------- | -------- | 223| type | 表示GNSS启动类型，该参数是为了区分正常的GNSS定位功能和GNSS缓存功能。 详情参考[GnssStartType](_hdi_gnss.md#gnssstarttype)。 | 224 225**返回：** 226 227返回0表示成功，返回负数表示失败。 228 229 230### StopGnss() 231 232``` 233IGnssInterface::StopGnss ([in] enum GnssStartType type) 234``` 235 236**描述** 237 238停止导航功能。 239 240**起始版本：** 3.2 241 242**参数:** 243 244| 名称 | 描述 | 245| -------- | -------- | 246| type | 表示GNSS启动类型，该参数为了区分正常的GNSS定位功能和GNSS缓存功能。 详情参考[GnssStartType](_hdi_gnss.md#gnssstarttype)。 | 247 248**返回：** 249 250返回0表示成功，返回负数表示失败。 251