yocto_altitude.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_altitude.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindAltitude(), the high-level API for Altitude 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_ALTITUDE_H
#define YOCTO_ALTITUDE_H

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

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

typedef void (*YAltitudeValueCallback)(YAltitude *func, const string& functionValue);
class YMeasure; // forward declaration
typedef void (*YAltitudeTimedReportCallback)(YAltitude *func, YMeasure measure);
#define Y_QNH_INVALID                   (YAPI_INVALID_DOUBLE)
#define Y_TECHNOLOGY_INVALID            (YAPI_INVALID_STRING)
//--- (end of YAltitude definitions)

//--- (YAltitude declaration)
class YOCTO_CLASS_EXPORT YAltitude: public YSensor {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YAltitude declaration)
protected:
    //--- (YAltitude attributes)
    // Attributes (function value cache)
    double          _qnh;
    string          _technology;
    YAltitudeValueCallback _valueCallbackAltitude;
    YAltitudeTimedReportCallback _timedReportCallbackAltitude;

    friend YAltitude *yFindAltitude(const string& func);
    friend YAltitude *yFirstAltitude(void);

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

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

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

    static const double QNH_INVALID;
    static const string TECHNOLOGY_INVALID;

    int             set_currentValue(double newval);
    inline int      setCurrentValue(double newval)
    { return this->set_currentValue(newval); }

    int             set_qnh(double newval);
    inline int      setQnh(double newval)
    { return this->set_qnh(newval); }

    double              get_qnh(void);

    inline double       qnh(void)
    { return this->get_qnh(); }

    string              get_technology(void);

    inline string       technology(void)
    { return this->get_technology(); }

    static YAltitude*   FindAltitude(string func);

    virtual int         registerValueCallback(YAltitudeValueCallback callback);
    using YSensor::registerValueCallback;

    virtual int         _invokeValueCallback(string value);

    virtual int         registerTimedReportCallback(YAltitudeTimedReportCallback callback);
    using YSensor::registerTimedReportCallback;

    virtual int         _invokeTimedReportCallback(YMeasure value);


    inline static YAltitude* Find(string func)
    { return YAltitude::FindAltitude(func); }

           YAltitude       *nextAltitude(void);
    inline YAltitude       *next(void)
    { return this->nextAltitude();}

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

//--- (YAltitude functions declaration)

inline YAltitude* yFindAltitude(const string& func)
{ return YAltitude::FindAltitude(func);}
inline YAltitude* yFirstAltitude(void)
{ return YAltitude::FirstAltitude();}

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

#endif