yocto_voltageoutput.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_voltageoutput.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindVoltageOutput(), the high-level API for VoltageOutput 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_VOLTAGEOUTPUT_H
#define YOCTO_VOLTAGEOUTPUT_H

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

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

typedef void (*YVoltageOutputValueCallback)(YVoltageOutput *func, const string& functionValue);
#define Y_CURRENTVOLTAGE_INVALID        (YAPI_INVALID_DOUBLE)
#define Y_VOLTAGETRANSITION_INVALID     (YAPI_INVALID_STRING)
#define Y_VOLTAGEATSTARTUP_INVALID      (YAPI_INVALID_DOUBLE)
//--- (end of YVoltageOutput definitions)

//--- (YVoltageOutput declaration)
class YOCTO_CLASS_EXPORT YVoltageOutput: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YVoltageOutput declaration)
protected:
    //--- (YVoltageOutput attributes)
    // Attributes (function value cache)
    double          _currentVoltage;
    string          _voltageTransition;
    double          _voltageAtStartUp;
    YVoltageOutputValueCallback _valueCallbackVoltageOutput;

    friend YVoltageOutput *yFindVoltageOutput(const string& func);
    friend YVoltageOutput *yFirstVoltageOutput(void);

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

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

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

    static const double CURRENTVOLTAGE_INVALID;
    static const string VOLTAGETRANSITION_INVALID;
    static const double VOLTAGEATSTARTUP_INVALID;

    int             set_currentVoltage(double newval);
    inline int      setCurrentVoltage(double newval)
    { return this->set_currentVoltage(newval); }

    double              get_currentVoltage(void);

    inline double       currentVoltage(void)
    { return this->get_currentVoltage(); }

    string              get_voltageTransition(void);

    inline string       voltageTransition(void)
    { return this->get_voltageTransition(); }

    int             set_voltageTransition(const string& newval);
    inline int      setVoltageTransition(const string& newval)
    { return this->set_voltageTransition(newval); }

    int             set_voltageAtStartUp(double newval);
    inline int      setVoltageAtStartUp(double newval)
    { return this->set_voltageAtStartUp(newval); }

    double              get_voltageAtStartUp(void);

    inline double       voltageAtStartUp(void)
    { return this->get_voltageAtStartUp(); }

    static YVoltageOutput* FindVoltageOutput(string func);

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

    virtual int         _invokeValueCallback(string value);

    virtual int         voltageMove(double V_target,int ms_duration);


    inline static YVoltageOutput* Find(string func)
    { return YVoltageOutput::FindVoltageOutput(func); }

           YVoltageOutput  *nextVoltageOutput(void);
    inline YVoltageOutput  *next(void)
    { return this->nextVoltageOutput();}

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

//--- (YVoltageOutput functions declaration)

inline YVoltageOutput* yFindVoltageOutput(const string& func)
{ return YVoltageOutput::FindVoltageOutput(func);}
inline YVoltageOutput* yFirstVoltageOutput(void)
{ return YVoltageOutput::FirstVoltageOutput();}

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

#endif