yocto_power.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_power.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindPower(), the high-level API for Power 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_POWER_H
#define YOCTO_POWER_H

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

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

typedef void (*YPowerValueCallback)(YPower *func, const string& functionValue);
class YMeasure; // forward declaration
typedef void (*YPowerTimedReportCallback)(YPower *func, YMeasure measure);
#define Y_COSPHI_INVALID                (YAPI_INVALID_DOUBLE)
#define Y_METER_INVALID                 (YAPI_INVALID_DOUBLE)
#define Y_METERTIMER_INVALID            (YAPI_INVALID_UINT)
//--- (end of YPower definitions)

//--- (YPower declaration)
class YOCTO_CLASS_EXPORT YPower: public YSensor {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YPower declaration)
protected:
    //--- (YPower attributes)
    // Attributes (function value cache)
    double          _cosPhi;
    double          _meter;
    int             _meterTimer;
    YPowerValueCallback _valueCallbackPower;
    YPowerTimedReportCallback _timedReportCallbackPower;

    friend YPower *yFindPower(const string& func);
    friend YPower *yFirstPower(void);

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

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

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

    static const double COSPHI_INVALID;
    static const double METER_INVALID;
    static const int METERTIMER_INVALID = YAPI_INVALID_UINT;

    double              get_cosPhi(void);

    inline double       cosPhi(void)
    { return this->get_cosPhi(); }

    int             set_meter(double newval);
    inline int      setMeter(double newval)
    { return this->set_meter(newval); }

    double              get_meter(void);

    inline double       meter(void)
    { return this->get_meter(); }

    int                 get_meterTimer(void);

    inline int          meterTimer(void)
    { return this->get_meterTimer(); }

    static YPower*      FindPower(string func);

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

    virtual int         _invokeValueCallback(string value);

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

    virtual int         _invokeTimedReportCallback(YMeasure value);

    virtual int         reset(void);


    inline static YPower* Find(string func)
    { return YPower::FindPower(func); }

           YPower          *nextPower(void);
    inline YPower          *next(void)
    { return this->nextPower();}

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

//--- (YPower functions declaration)

inline YPower* yFindPower(const string& func)
{ return YPower::FindPower(func);}
inline YPower* yFirstPower(void)
{ return YPower::FirstPower();}

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

#endif