yocto_gps.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_gps.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindGps(), the high-level API for Gps functions
 *
 * - - - - - - - - - License information: - - - - - - - - -
 *
 *  Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland.
 *
 *  Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual
 *  non-exclusive license to use, modify, copy and integrate this
 *  file into your software for the sole purpose of interfacing
 *  with Yoctopuce products.
 *
 *  You may reproduce and distribute copies of this file in
 *  source or object form, as long as the sole purpose of this
 *  code is to interface with Yoctopuce products. You must retain
 *  this notice in the distributed source file.
 *
 *  You should refer to Yoctopuce General Terms and Conditions
 *  for additional information regarding your rights and
 *  obligations.
 *
 *  THE SOFTWARE AND DOCUMENTATION ARE PROVIDED 'AS IS' WITHOUT
 *  WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
 *  WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO
 *  EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL,
 *  INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA,
 *  COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR
 *  SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT
 *  LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR
 *  CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE
 *  BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF
 *  WARRANTY, OR OTHERWISE.
 *
 *********************************************************************/


#ifndef YOCTO_GPS_H
#define YOCTO_GPS_H

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

//--- (YGps return codes)
//--- (end of YGps return codes)
//--- (YGps definitions)
class YGps; // forward declaration

typedef void (*YGpsValueCallback)(YGps *func, const string& functionValue);
#ifndef _Y_ISFIXED_ENUM
#define _Y_ISFIXED_ENUM
typedef enum {
    Y_ISFIXED_FALSE = 0,
    Y_ISFIXED_TRUE = 1,
    Y_ISFIXED_INVALID = -1,
} Y_ISFIXED_enum;
#endif
#ifndef _Y_COORDSYSTEM_ENUM
#define _Y_COORDSYSTEM_ENUM
typedef enum {
    Y_COORDSYSTEM_GPS_DMS = 0,
    Y_COORDSYSTEM_GPS_DM = 1,
    Y_COORDSYSTEM_GPS_D = 2,
    Y_COORDSYSTEM_INVALID = -1,
} Y_COORDSYSTEM_enum;
#endif
#define Y_SATCOUNT_INVALID              (YAPI_INVALID_LONG)
#define Y_LATITUDE_INVALID              (YAPI_INVALID_STRING)
#define Y_LONGITUDE_INVALID             (YAPI_INVALID_STRING)
#define Y_DILUTION_INVALID              (YAPI_INVALID_DOUBLE)
#define Y_ALTITUDE_INVALID              (YAPI_INVALID_DOUBLE)
#define Y_GROUNDSPEED_INVALID           (YAPI_INVALID_DOUBLE)
#define Y_DIRECTION_INVALID             (YAPI_INVALID_DOUBLE)
#define Y_UNIXTIME_INVALID              (YAPI_INVALID_LONG)
#define Y_DATETIME_INVALID              (YAPI_INVALID_STRING)
#define Y_UTCOFFSET_INVALID             (YAPI_INVALID_INT)
#define Y_COMMAND_INVALID               (YAPI_INVALID_STRING)
//--- (end of YGps definitions)

//--- (YGps declaration)
class YOCTO_CLASS_EXPORT YGps: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YGps declaration)
protected:
    //--- (YGps attributes)
    // Attributes (function value cache)
    Y_ISFIXED_enum  _isFixed;
    s64             _satCount;
    Y_COORDSYSTEM_enum _coordSystem;
    string          _latitude;
    string          _longitude;
    double          _dilution;
    double          _altitude;
    double          _groundSpeed;
    double          _direction;
    s64             _unixTime;
    string          _dateTime;
    int             _utcOffset;
    string          _command;
    YGpsValueCallback _valueCallbackGps;

    friend YGps *yFindGps(const string& func);
    friend YGps *yFirstGps(void);

    // Function-specific method for parsing of JSON output and caching result
    virtual int     _parseAttr(YJSONObject* json_val);

    // Constructor is protected, use yFindGps factory function to instantiate
    YGps(const string& func);
    //--- (end of YGps attributes)

public:
    ~YGps();
    //--- (YGps accessors declaration)

    static const Y_ISFIXED_enum ISFIXED_FALSE = Y_ISFIXED_FALSE;
    static const Y_ISFIXED_enum ISFIXED_TRUE = Y_ISFIXED_TRUE;
    static const Y_ISFIXED_enum ISFIXED_INVALID = Y_ISFIXED_INVALID;
    static const s64 SATCOUNT_INVALID = YAPI_INVALID_LONG;
    static const Y_COORDSYSTEM_enum COORDSYSTEM_GPS_DMS = Y_COORDSYSTEM_GPS_DMS;
    static const Y_COORDSYSTEM_enum COORDSYSTEM_GPS_DM = Y_COORDSYSTEM_GPS_DM;
    static const Y_COORDSYSTEM_enum COORDSYSTEM_GPS_D = Y_COORDSYSTEM_GPS_D;
    static const Y_COORDSYSTEM_enum COORDSYSTEM_INVALID = Y_COORDSYSTEM_INVALID;
    static const string LATITUDE_INVALID;
    static const string LONGITUDE_INVALID;
    static const double DILUTION_INVALID;
    static const double ALTITUDE_INVALID;
    static const double GROUNDSPEED_INVALID;
    static const double DIRECTION_INVALID;
    static const s64 UNIXTIME_INVALID = YAPI_INVALID_LONG;
    static const string DATETIME_INVALID;
    static const int UTCOFFSET_INVALID = YAPI_INVALID_INT;
    static const string COMMAND_INVALID;

    Y_ISFIXED_enum      get_isFixed(void);

    inline Y_ISFIXED_enum isFixed(void)
    { return this->get_isFixed(); }

    s64                 get_satCount(void);

    inline s64          satCount(void)
    { return this->get_satCount(); }

    Y_COORDSYSTEM_enum  get_coordSystem(void);

    inline Y_COORDSYSTEM_enum coordSystem(void)
    { return this->get_coordSystem(); }

    int             set_coordSystem(Y_COORDSYSTEM_enum newval);
    inline int      setCoordSystem(Y_COORDSYSTEM_enum newval)
    { return this->set_coordSystem(newval); }

    string              get_latitude(void);

    inline string       latitude(void)
    { return this->get_latitude(); }

    string              get_longitude(void);

    inline string       longitude(void)
    { return this->get_longitude(); }

    double              get_dilution(void);

    inline double       dilution(void)
    { return this->get_dilution(); }

    double              get_altitude(void);

    inline double       altitude(void)
    { return this->get_altitude(); }

    double              get_groundSpeed(void);

    inline double       groundSpeed(void)
    { return this->get_groundSpeed(); }

    double              get_direction(void);

    inline double       direction(void)
    { return this->get_direction(); }

    s64                 get_unixTime(void);

    inline s64          unixTime(void)
    { return this->get_unixTime(); }

    string              get_dateTime(void);

    inline string       dateTime(void)
    { return this->get_dateTime(); }

    int                 get_utcOffset(void);

    inline int          utcOffset(void)
    { return this->get_utcOffset(); }

    int             set_utcOffset(int newval);
    inline int      setUtcOffset(int newval)
    { return this->set_utcOffset(newval); }

    string              get_command(void);

    inline string       command(void)
    { return this->get_command(); }

    int             set_command(const string& newval);
    inline int      setCommand(const string& newval)
    { return this->set_command(newval); }

    static YGps*        FindGps(string func);

    virtual int         registerValueCallback(YGpsValueCallback callback);
    using YFunction::registerValueCallback;

    virtual int         _invokeValueCallback(string value);


    inline static YGps* Find(string func)
    { return YGps::FindGps(func); }

           YGps            *nextGps(void);
    inline YGps            *next(void)
    { return this->nextGps();}

           static YGps* FirstGps(void);
    inline static YGps* First(void)
    { return YGps::FirstGps();}
#ifdef __BORLANDC__
#pragma option pop
#endif
    //--- (end of YGps accessors declaration)
};

//--- (YGps functions declaration)

inline YGps* yFindGps(const string& func)
{ return YGps::FindGps(func);}
inline YGps* yFirstGps(void)
{ return YGps::FirstGps();}

//--- (end of YGps functions declaration)

#endif