yocto_latitude.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_latitude.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindLatitude(), the high-level API for Latitude 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_LATITUDE_H
#define YOCTO_LATITUDE_H

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

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

typedef void (*YLatitudeValueCallback)(YLatitude *func, const string& functionValue);
class YMeasure; // forward declaration
typedef void (*YLatitudeTimedReportCallback)(YLatitude *func, YMeasure measure);
//--- (end of YLatitude definitions)

//--- (YLatitude declaration)
class YOCTO_CLASS_EXPORT YLatitude: public YSensor {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YLatitude declaration)
protected:
    //--- (YLatitude attributes)
    // Attributes (function value cache)
    YLatitudeValueCallback _valueCallbackLatitude;
    YLatitudeTimedReportCallback _timedReportCallbackLatitude;

    friend YLatitude *yFindLatitude(const string& func);
    friend YLatitude *yFirstLatitude(void);

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

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


    static YLatitude*   FindLatitude(string func);

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

    virtual int         _invokeValueCallback(string value);

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

    virtual int         _invokeTimedReportCallback(YMeasure value);


    inline static YLatitude* Find(string func)
    { return YLatitude::FindLatitude(func); }

           YLatitude       *nextLatitude(void);
    inline YLatitude       *next(void)
    { return this->nextLatitude();}

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

//--- (YLatitude functions declaration)

inline YLatitude* yFindLatitude(const string& func)
{ return YLatitude::FindLatitude(func);}
inline YLatitude* yFirstLatitude(void)
{ return YLatitude::FirstLatitude();}

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

#endif