An extension of original API for working with GPS devices.

GPSProviderImplBase.h

Committer:
apalmieri
Date:
2017-06-19
Revision:
10:013af7b8c22a
Parent:
8:47fa213225c3

File content as of revision 10:013af7b8c22a:

/* mbed Microcontroller Library
 * Copyright (c) 2006-2014 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __GPS_PROVIDER_INSTANCE_BASE_H__
#define __GPS_PROVIDER_INSTANCE_BASE_H__

#include "GPSProvider.h"
#include "GPSGeofence.h"

class GPSProviderImplBase {
public:
    virtual bool setPowerMode(GPSProvider::PowerMode_t power) = 0;
    virtual void reset(void)   = 0;
    virtual void start(void)   = 0;
    virtual void stop(void)    = 0;
    virtual void process(void) = 0;
    virtual void lpmGetImmediateLocation(void) = 0;
    virtual uint32_t ioctl(uint32_t command, void *arg) = 0;

    virtual bool haveDeviceInfo(void) const {
        return (deviceInfo != NULL);
    }
    virtual const char *getDeviceInfo(void) const {
        return deviceInfo;
    }
    virtual bool locationAvailable(void) const {
        return lastLocation.valid;
    }
    virtual const GPSProvider::LocationUpdateParams_t *getLastLocation(void) const {
        return (lastLocation.valid) ? &lastLocation : NULL;
    }
    virtual void onLocationUpdate(GPSProvider::LocationUpdateCallback_t callback) {
        locationCallback = callback;
    }
    // [ST-GNSS] - Geofencing API
    virtual bool isGeofencingSupported(void) const { 
        return false; /* Requesting action from porters: override this API if this capability is supported. */ 
    }
    // [ST-GNSS] - Geofencing API
    virtual void onGeofencesTrigger(GPSProvider::GeofencesTriggerCallback_t callback) {
        geofencesTriggerCallback = callback;
    }

protected:
    GPSProvider::LocationUpdateParams_t     lastLocation;
    const char                              *deviceInfo;
    GPSProvider::LocationUpdateCallback_t   locationCallback;
    // [ST-GNSS] - Geofencing API
    GPSGeofence                             **geofences;
    // [ST-GNSS] - Geofencing API
    GPSProvider::GeofencesTriggerCallback_t geofencesTriggerCallback; 
};

#endif /* __GPS_PROVIDER_INSTANCE_BASE_H__ */