GpsTracker (JNaviCore SDK Documentation)

java.lang.Object
- com.mapbar.mapdal.GpsTracker

public final class GpsTracker
extends java.lang.Object

嵌套类概要

嵌套类
限定符和类型类和说明

class GpsTracker.GPSEvent

static interface GpsTracker.GPSEventHandler

class GpsTracker.SwitchChoice

嵌套类
限定符和类型	类和说明
`class`	`GpsTracker.GPSEvent`
`static interface`	`GpsTracker.GPSEventHandler`
`class`	`GpsTracker.SwitchChoice`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`cleanup()` 清理GPS资源
`void`	`enableGps(boolean enable)` 开启/关闭GPS引擎
`void`	`enableGpsDebugMode(boolean enable)` 启用/不启用gpsDebug模式
`void`	`enableSpeedZeroPolicy(boolean enable)` GPS速度为零时，是否交给引擎处理
`MapbarGpsInfo`	`getGpsInfo()` 获取引擎端返回的GPS Info
`static GpsTracker`	`getInstance()` 获取单例类的实例
`int`	`getSwitchChoice()` 获取当前切路选择
`void`	`init(android.location.LocationManager locationManager, boolean useJNaviCoreImp, boolean isDebugMode)` 初始化`GpsTracker`
`boolean`	`isEnableGpsDebugMode()` 是否启动了gpsDebug模式
`boolean`	`isGpsEnabled()` GPS引擎是否开启
`boolean`	`isGpsProviderEnabled()` 判断当前设备的GPS模块是否已经开启
`boolean`	`isSpeedZeroPolicyEnabled()` 判断当前是否开启引擎处理GPS速度为零的策略
`boolean`	`isUsingExperienceAccuracy()` 是否使用经验值替代GPS设备给出的精度值，默认为使用设备给出的经验值，即，返回false
`void`	`onLocationChanged(android.location.Location location)` 当前地理坐标位置发生变化时，通过此方法通知引擎此方法应当在初始化`GpsTracker`使用非JNaviCore引擎GPS实现时调用,即， `init(LocationManager, boolean, boolean)` 第二个参数传false。
`void`	`onSatelliteStatusChanged(java.util.ArrayList<MapbarGpsSatellite> satellites)` 定位卫星状态变化发生变化时，通过此方法通知引擎。
`void`	`onSatelliteStatusChanged(java.lang.Iterable<android.location.GpsSatellite> satellites)` 定位卫星状态变化发生变化时，通过此方法通知引擎一般在`GpsStatus.Listener#onGpsStatusChanged(int)`的事件 `GpsStatus.GPS_EVENT_SATELLITE_STATUS`中，获取卫星状态信息，然后传给引擎。
`void`	`registerGpsTrackerListener(GpsTracker.GPSEventHandler handler, java.lang.Object data)` 注册GPS事件回调函数，用来监听GPS相关信息
`void`	`setSignalLostDelay(int delay)` 设置GPS丢星时，引擎播报丢星的延迟时间默认：10000ms
`boolean`	`setSwitchChoice(int choice)` 手动切路（主辅路以及高架桥上桥下切换）
`boolean`	`startLogging(java.lang.String filename)` 开始记录GPS轨迹
`boolean`	`stopLogging()` 结束GPS log记录
`void`	`unregisterGpsTrackerListener()` 移除GPS信号监听
`void`	`useExperienceAccuracy(boolean useExperienceAccuracy)` 使用经验值替代GPS设备给出的精度值，默认为使用设备给出精度值

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getInstance
```
public static GpsTracker getInstance()
```
    获取单例类的实例
    
    返回:
    
    该单例类GpsTracker的实例
  - init
```
public void init(android.location.LocationManager locationManager,
                 boolean useJNaviCoreImp,
                 boolean isDebugMode)
          throws java.lang.Exception
```
    初始化GpsTracker
    
    参数:
    
    locationManager - 系统提供的定位管理系统
    
    useJNaviCoreImp - 是否使用JNaviCore内部实现的GPS定位。引擎内部是允许客户端控制定位逻辑的，并提供了相应的控制接口
    
    isDebugMode - 是否使用调试模式打开GPS
    
    抛出:
    
    java.lang.Exception
    
    另请参阅:
    
    cleanup()
    
    Notice:
    
    当使用导航引擎时，不需要手动初始化 init(LocationManager, boolean, boolean) ，导航引擎内部会初始化GpsTracker
  - cleanup
```
public void cleanup()
```
    清理GPS资源
    
    另请参阅:
    
    init(LocationManager, boolean, boolean)
  - startLogging
```
public boolean startLogging(java.lang.String filename)
```
    开始记录GPS轨迹
    
    参数:
    
    filename - 记录GPS轨迹的文件路径
  - stopLogging
```
public boolean stopLogging()
```
    结束GPS log记录
    
    返回:
    
    结束并保存成功返回true，否则返回false
  - setSwitchChoice
```
public boolean setSwitchChoice(int choice)
```
    手动切路（主辅路以及高架桥上桥下切换）
    
    参数:
    
    choice - 切路选择,GpsTracker.SwitchChoice
    
    返回:
    
    设置成功true/失败false
  - getSwitchChoice
```
public int getSwitchChoice()
```
    获取当前切路选择
    
    返回:
    
    当前切路选择GpsTracker.SwitchChoice 未初始化或者当前无切路选择返回 SwitchChoice.none
  - registerGpsTrackerListener
```
public void registerGpsTrackerListener(GpsTracker.GPSEventHandler handler,
                                       java.lang.Object data)
```
    注册GPS事件回调函数，用来监听GPS相关信息
    
    参数:
    
    handler -
    
    data -
  - unregisterGpsTrackerListener
```
public void unregisterGpsTrackerListener()
```
    移除GPS信号监听
  - isGpsProviderEnabled
```
public boolean isGpsProviderEnabled()
```
    判断当前设备的GPS模块是否已经开启
    
    返回:
    
    当前设备的GPS模块是否打开
    
    Notice:
    
    提示：此部分功能可以完全由客户端自行实现，这里只是提供了一个简单的封装
    需要注意的是，如果在初始化时，选择了不使用JNaviCore引擎内部实现的GPS，那么此方法将总是返回false，即，此方法不可用。
  - onLocationChanged
```
public void onLocationChanged(android.location.Location location)
```
    当前地理坐标位置发生变化时，通过此方法通知引擎
    此方法应当在初始化GpsTracker使用非JNaviCore引擎GPS实现时调用,即， init(LocationManager, boolean, boolean) 第二个参数传false。此时GPS坐标系采用的是84坐标系，其他情况下采用的是02坐标系
    
    参数:
    
    location - 变化后的地理坐标位置
  - onSatelliteStatusChanged
```
public void onSatelliteStatusChanged(java.lang.Iterable<android.location.GpsSatellite> satellites)
```
    定位卫星状态变化发生变化时，通过此方法通知引擎
    一般在GpsStatus.Listener#onGpsStatusChanged(int)的事件 GpsStatus.GPS_EVENT_SATELLITE_STATUS中，获取卫星状态信息，然后传给引擎。
    示例代码：
```
 
 mLocationManager.addGpsStatusListener(new GpsStatus.Listener() {
 
        @Override
        public void onGpsStatusChanged(int event) {
                switch (event) {
                case GpsStatus.GPS_EVENT_SATELLITE_STATUS:
                        GpsStatus status = mLocationManager.getGpsStatus(null);
                        GpsTracker.getInstance().onSatelliteStatusChanged(status.getSatellites());
                        break;
                default:
                        break;
                }
        }
 });
 
```
    参数:
    
    satellites - 卫星信息
    
    Notice:
    
    此方法应当在初始化GpsTracker 使用非JNaviCore引擎GPS实现时调用,即， init(LocationManager, boolean, boolean) 第二个参数传false。
  - onSatelliteStatusChanged
```
public void onSatelliteStatusChanged(java.util.ArrayList<MapbarGpsSatellite> satellites)
```
    定位卫星状态变化发生变化时，通过此方法通知引擎。此接口功能与onSatelliteStatusChanged(Iterable) 一致，主要是为了支持无法通过android标准的API获取卫星信息的设置
    
    参数:
    
    satellites - 卫星信息
    
    另请参阅:
    
    onSatelliteStatusChanged(Iterable)
  - enableGps
```
public void enableGps(boolean enable)
```
    开启/关闭GPS引擎
    
    参数:
    
    enable - true表示开启，false表示关闭
    
    另请参阅:
    
    isGpsEnabled()
  - isGpsEnabled
```
public boolean isGpsEnabled()
```
    GPS引擎是否开启
    
    返回:
    
    true表示已经开启，false标识已经关闭
    
    另请参阅:
    
    enableGps(boolean)
  - enableSpeedZeroPolicy
```
public void enableSpeedZeroPolicy(boolean enable)
```
    GPS速度为零时，是否交给引擎处理
    
    参数:
    
    enable - true为开启引擎策略，false为不开启
  - isSpeedZeroPolicyEnabled
```
public boolean isSpeedZeroPolicyEnabled()
```
    判断当前是否开启引擎处理GPS速度为零的策略
    
    返回:
    
    true为开启，false为关闭
  - setSignalLostDelay
```
public void setSignalLostDelay(int delay)
```
    设置GPS丢星时，引擎播报丢星的延迟时间
    默认：10000ms
    
    参数:
    
    delay - 延迟时间，单位：ms
    
    另请参阅:
    
    isGpsProviderEnabled()
  - useExperienceAccuracy
```
public void useExperienceAccuracy(boolean useExperienceAccuracy)
```
    使用经验值替代GPS设备给出的精度值，默认为使用设备给出精度值
    
    参数:
    
    useExperienceAccuracy - true表示使用经验值，false表示使用GPS设备给出的值
    
    另请参阅:
    
    isUsingExperienceAccuracy()
  - isUsingExperienceAccuracy
```
public boolean isUsingExperienceAccuracy()
```
    是否使用经验值替代GPS设备给出的精度值，默认为使用设备给出的经验值，即，返回false
    
    返回:
    
    true表示正在使用经验值，否则返回false
    
    另请参阅:
    
    useExperienceAccuracy(boolean)
  - getGpsInfo
```
public MapbarGpsInfo getGpsInfo()
```
    获取引擎端返回的GPS Info
    
    返回:
    
    引擎回调的GPS信息MapbarGpsInfo
  - enableGpsDebugMode
```
public void enableGpsDebugMode(boolean enable)
```
    启用/不启用gpsDebug模式
    
    参数:
    
    enable - true为启动，false为不启用
  - isEnableGpsDebugMode
```
public boolean isEnableGpsDebugMode()
```
    是否启动了gpsDebug模式
    
    返回:
    
    true为启动，false为不启用

类 GpsTracker

嵌套类概要

方法概要

从类继承的方法 java.lang.Object

方法详细资料

getInstance

init

cleanup

startLogging

stopLogging

setSwitchChoice

getSwitchChoice

registerGpsTrackerListener

unregisterGpsTrackerListener

isGpsProviderEnabled

onLocationChanged

onSatelliteStatusChanged

onSatelliteStatusChanged

enableGps

isGpsEnabled

enableSpeedZeroPolicy

isSpeedZeroPolicyEnabled

setSignalLostDelay

useExperienceAccuracy

isUsingExperienceAccuracy

getGpsInfo

enableGpsDebugMode

isEnableGpsDebugMode