yocto_magnetometer.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_magnetometer.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindMagnetometer(), the high-level API for Magnetometer 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_MAGNETOMETER_H
#define YOCTO_MAGNETOMETER_H

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

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

typedef void (*YMagnetometerValueCallback)(YMagnetometer *func, const string& functionValue);
class YMeasure; // forward declaration
typedef void (*YMagnetometerTimedReportCallback)(YMagnetometer *func, YMeasure measure);
#define Y_BANDWIDTH_INVALID             (YAPI_INVALID_INT)
#define Y_XVALUE_INVALID                (YAPI_INVALID_DOUBLE)
#define Y_YVALUE_INVALID                (YAPI_INVALID_DOUBLE)
#define Y_ZVALUE_INVALID                (YAPI_INVALID_DOUBLE)
//--- (end of YMagnetometer definitions)

//--- (YMagnetometer declaration)
class YOCTO_CLASS_EXPORT YMagnetometer: public YSensor {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YMagnetometer declaration)
protected:
    //--- (YMagnetometer attributes)
    // Attributes (function value cache)
    int             _bandwidth;
    double          _xValue;
    double          _yValue;
    double          _zValue;
    YMagnetometerValueCallback _valueCallbackMagnetometer;
    YMagnetometerTimedReportCallback _timedReportCallbackMagnetometer;

    friend YMagnetometer *yFindMagnetometer(const string& func);
    friend YMagnetometer *yFirstMagnetometer(void);

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

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

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

    static const int BANDWIDTH_INVALID = YAPI_INVALID_INT;
    static const double XVALUE_INVALID;
    static const double YVALUE_INVALID;
    static const double ZVALUE_INVALID;

    int                 get_bandwidth(void);

    inline int          bandwidth(void)
    { return this->get_bandwidth(); }

    int             set_bandwidth(int newval);
    inline int      setBandwidth(int newval)
    { return this->set_bandwidth(newval); }

    double              get_xValue(void);

    inline double       xValue(void)
    { return this->get_xValue(); }

    double              get_yValue(void);

    inline double       yValue(void)
    { return this->get_yValue(); }

    double              get_zValue(void);

    inline double       zValue(void)
    { return this->get_zValue(); }

    static YMagnetometer* FindMagnetometer(string func);

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

    virtual int         _invokeValueCallback(string value);

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

    virtual int         _invokeTimedReportCallback(YMeasure value);


    inline static YMagnetometer* Find(string func)
    { return YMagnetometer::FindMagnetometer(func); }

           YMagnetometer   *nextMagnetometer(void);
    inline YMagnetometer   *next(void)
    { return this->nextMagnetometer();}

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

//--- (YMagnetometer functions declaration)

inline YMagnetometer* yFindMagnetometer(const string& func)
{ return YMagnetometer::FindMagnetometer(func);}
inline YMagnetometer* yFirstMagnetometer(void)
{ return YMagnetometer::FirstMagnetometer();}

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

#endif