yocto_quadraturedecoder.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_quadraturedecoder.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindQuadratureDecoder(), the high-level API for QuadratureDecoder 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_QUADRATUREDECODER_H
#define YOCTO_QUADRATUREDECODER_H

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

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

typedef void (*YQuadratureDecoderValueCallback)(YQuadratureDecoder *func, const string& functionValue);
class YMeasure; // forward declaration
typedef void (*YQuadratureDecoderTimedReportCallback)(YQuadratureDecoder *func, YMeasure measure);
#ifndef _Y_DECODING_ENUM
#define _Y_DECODING_ENUM
typedef enum {
    Y_DECODING_OFF = 0,
    Y_DECODING_ON = 1,
    Y_DECODING_INVALID = -1,
} Y_DECODING_enum;
#endif
#define Y_SPEED_INVALID                 (YAPI_INVALID_DOUBLE)
//--- (end of YQuadratureDecoder definitions)

//--- (YQuadratureDecoder declaration)
class YOCTO_CLASS_EXPORT YQuadratureDecoder: public YSensor {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YQuadratureDecoder declaration)
protected:
    //--- (YQuadratureDecoder attributes)
    // Attributes (function value cache)
    double          _speed;
    Y_DECODING_enum _decoding;
    YQuadratureDecoderValueCallback _valueCallbackQuadratureDecoder;
    YQuadratureDecoderTimedReportCallback _timedReportCallbackQuadratureDecoder;

    friend YQuadratureDecoder *yFindQuadratureDecoder(const string& func);
    friend YQuadratureDecoder *yFirstQuadratureDecoder(void);

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

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

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

    static const double SPEED_INVALID;
    static const Y_DECODING_enum DECODING_OFF = Y_DECODING_OFF;
    static const Y_DECODING_enum DECODING_ON = Y_DECODING_ON;
    static const Y_DECODING_enum DECODING_INVALID = Y_DECODING_INVALID;

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

    double              get_speed(void);

    inline double       speed(void)
    { return this->get_speed(); }

    Y_DECODING_enum     get_decoding(void);

    inline Y_DECODING_enum decoding(void)
    { return this->get_decoding(); }

    int             set_decoding(Y_DECODING_enum newval);
    inline int      setDecoding(Y_DECODING_enum newval)
    { return this->set_decoding(newval); }

    static YQuadratureDecoder* FindQuadratureDecoder(string func);

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

    virtual int         _invokeValueCallback(string value);

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

    virtual int         _invokeTimedReportCallback(YMeasure value);


    inline static YQuadratureDecoder* Find(string func)
    { return YQuadratureDecoder::FindQuadratureDecoder(func); }

           YQuadratureDecoder *nextQuadratureDecoder(void);
    inline YQuadratureDecoder *next(void)
    { return this->nextQuadratureDecoder();}

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

//--- (YQuadratureDecoder functions declaration)

inline YQuadratureDecoder* yFindQuadratureDecoder(const string& func)
{ return YQuadratureDecoder::FindQuadratureDecoder(func);}
inline YQuadratureDecoder* yFirstQuadratureDecoder(void)
{ return YQuadratureDecoder::FirstQuadratureDecoder();}

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

#endif