yocto_currentloopoutput.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_currentloopoutput.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindCurrentLoopOutput(), the high-level API for CurrentLoopOutput 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_CURRENTLOOPOUTPUT_H
#define YOCTO_CURRENTLOOPOUTPUT_H

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

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

typedef void (*YCurrentLoopOutputValueCallback)(YCurrentLoopOutput *func, const string& functionValue);
#ifndef _Y_LOOPPOWER_ENUM
#define _Y_LOOPPOWER_ENUM
typedef enum {
    Y_LOOPPOWER_NOPWR = 0,
    Y_LOOPPOWER_LOWPWR = 1,
    Y_LOOPPOWER_POWEROK = 2,
    Y_LOOPPOWER_INVALID = -1,
} Y_LOOPPOWER_enum;
#endif
#define Y_CURRENT_INVALID               (YAPI_INVALID_DOUBLE)
#define Y_CURRENTTRANSITION_INVALID     (YAPI_INVALID_STRING)
#define Y_CURRENTATSTARTUP_INVALID      (YAPI_INVALID_DOUBLE)
//--- (end of YCurrentLoopOutput definitions)

//--- (YCurrentLoopOutput declaration)
class YOCTO_CLASS_EXPORT YCurrentLoopOutput: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YCurrentLoopOutput declaration)
protected:
    //--- (YCurrentLoopOutput attributes)
    // Attributes (function value cache)
    double          _current;
    string          _currentTransition;
    double          _currentAtStartUp;
    Y_LOOPPOWER_enum _loopPower;
    YCurrentLoopOutputValueCallback _valueCallbackCurrentLoopOutput;

    friend YCurrentLoopOutput *yFindCurrentLoopOutput(const string& func);
    friend YCurrentLoopOutput *yFirstCurrentLoopOutput(void);

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

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

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

    static const double CURRENT_INVALID;
    static const string CURRENTTRANSITION_INVALID;
    static const double CURRENTATSTARTUP_INVALID;
    static const Y_LOOPPOWER_enum LOOPPOWER_NOPWR = Y_LOOPPOWER_NOPWR;
    static const Y_LOOPPOWER_enum LOOPPOWER_LOWPWR = Y_LOOPPOWER_LOWPWR;
    static const Y_LOOPPOWER_enum LOOPPOWER_POWEROK = Y_LOOPPOWER_POWEROK;
    static const Y_LOOPPOWER_enum LOOPPOWER_INVALID = Y_LOOPPOWER_INVALID;

    int             set_current(double newval);
    inline int      setCurrent(double newval)
    { return this->set_current(newval); }

    double              get_current(void);

    inline double       current(void)
    { return this->get_current(); }

    string              get_currentTransition(void);

    inline string       currentTransition(void)
    { return this->get_currentTransition(); }

    int             set_currentTransition(const string& newval);
    inline int      setCurrentTransition(const string& newval)
    { return this->set_currentTransition(newval); }

    int             set_currentAtStartUp(double newval);
    inline int      setCurrentAtStartUp(double newval)
    { return this->set_currentAtStartUp(newval); }

    double              get_currentAtStartUp(void);

    inline double       currentAtStartUp(void)
    { return this->get_currentAtStartUp(); }

    Y_LOOPPOWER_enum    get_loopPower(void);

    inline Y_LOOPPOWER_enum loopPower(void)
    { return this->get_loopPower(); }

    static YCurrentLoopOutput* FindCurrentLoopOutput(string func);

    virtual int         registerValueCallback(YCurrentLoopOutputValueCallback callback);
    using YFunction::registerValueCallback;

    virtual int         _invokeValueCallback(string value);

    virtual int         currentMove(double mA_target,int ms_duration);


    inline static YCurrentLoopOutput* Find(string func)
    { return YCurrentLoopOutput::FindCurrentLoopOutput(func); }

           YCurrentLoopOutput *nextCurrentLoopOutput(void);
    inline YCurrentLoopOutput *next(void)
    { return this->nextCurrentLoopOutput();}

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

//--- (YCurrentLoopOutput functions declaration)

inline YCurrentLoopOutput* yFindCurrentLoopOutput(const string& func)
{ return YCurrentLoopOutput::FindCurrentLoopOutput(func);}
inline YCurrentLoopOutput* yFirstCurrentLoopOutput(void)
{ return YCurrentLoopOutput::FirstCurrentLoopOutput();}

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

#endif