yocto_weighscale.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_weighscale.h 29661 2018-01-18 13:32:13Z mvuilleu $
 *
 * Declares yFindWeighScale(), the high-level API for WeighScale 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_WEIGHSCALE_H
#define YOCTO_WEIGHSCALE_H

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

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

typedef void (*YWeighScaleValueCallback)(YWeighScale *func, const string& functionValue);
class YMeasure; // forward declaration
typedef void (*YWeighScaleTimedReportCallback)(YWeighScale *func, YMeasure measure);
#ifndef _Y_EXCITATION_ENUM
#define _Y_EXCITATION_ENUM
typedef enum {
    Y_EXCITATION_OFF = 0,
    Y_EXCITATION_DC = 1,
    Y_EXCITATION_AC = 2,
    Y_EXCITATION_INVALID = -1,
} Y_EXCITATION_enum;
#endif
#define Y_COMPTEMPADAPTRATIO_INVALID    (YAPI_INVALID_DOUBLE)
#define Y_COMPTEMPAVG_INVALID           (YAPI_INVALID_DOUBLE)
#define Y_COMPTEMPCHG_INVALID           (YAPI_INVALID_DOUBLE)
#define Y_COMPENSATION_INVALID          (YAPI_INVALID_DOUBLE)
#define Y_ZEROTRACKING_INVALID          (YAPI_INVALID_DOUBLE)
#define Y_COMMAND_INVALID               (YAPI_INVALID_STRING)
//--- (end of YWeighScale definitions)

//--- (YWeighScale declaration)
class YOCTO_CLASS_EXPORT YWeighScale: public YSensor {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YWeighScale declaration)
protected:
    //--- (YWeighScale attributes)
    // Attributes (function value cache)
    Y_EXCITATION_enum _excitation;
    double          _compTempAdaptRatio;
    double          _compTempAvg;
    double          _compTempChg;
    double          _compensation;
    double          _zeroTracking;
    string          _command;
    YWeighScaleValueCallback _valueCallbackWeighScale;
    YWeighScaleTimedReportCallback _timedReportCallbackWeighScale;

    friend YWeighScale *yFindWeighScale(const string& func);
    friend YWeighScale *yFirstWeighScale(void);

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

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

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

    static const Y_EXCITATION_enum EXCITATION_OFF = Y_EXCITATION_OFF;
    static const Y_EXCITATION_enum EXCITATION_DC = Y_EXCITATION_DC;
    static const Y_EXCITATION_enum EXCITATION_AC = Y_EXCITATION_AC;
    static const Y_EXCITATION_enum EXCITATION_INVALID = Y_EXCITATION_INVALID;
    static const double COMPTEMPADAPTRATIO_INVALID;
    static const double COMPTEMPAVG_INVALID;
    static const double COMPTEMPCHG_INVALID;
    static const double COMPENSATION_INVALID;
    static const double ZEROTRACKING_INVALID;
    static const string COMMAND_INVALID;

    int             set_unit(const string& newval);
    inline int      setUnit(const string& newval)
    { return this->set_unit(newval); }

    Y_EXCITATION_enum   get_excitation(void);

    inline Y_EXCITATION_enum excitation(void)
    { return this->get_excitation(); }

    int             set_excitation(Y_EXCITATION_enum newval);
    inline int      setExcitation(Y_EXCITATION_enum newval)
    { return this->set_excitation(newval); }

    int             set_compTempAdaptRatio(double newval);
    inline int      setCompTempAdaptRatio(double newval)
    { return this->set_compTempAdaptRatio(newval); }

    double              get_compTempAdaptRatio(void);

    inline double       compTempAdaptRatio(void)
    { return this->get_compTempAdaptRatio(); }

    double              get_compTempAvg(void);

    inline double       compTempAvg(void)
    { return this->get_compTempAvg(); }

    double              get_compTempChg(void);

    inline double       compTempChg(void)
    { return this->get_compTempChg(); }

    double              get_compensation(void);

    inline double       compensation(void)
    { return this->get_compensation(); }

    int             set_zeroTracking(double newval);
    inline int      setZeroTracking(double newval)
    { return this->set_zeroTracking(newval); }

    double              get_zeroTracking(void);

    inline double       zeroTracking(void)
    { return this->get_zeroTracking(); }

    string              get_command(void);

    inline string       command(void)
    { return this->get_command(); }

    int             set_command(const string& newval);
    inline int      setCommand(const string& newval)
    { return this->set_command(newval); }

    static YWeighScale* FindWeighScale(string func);

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

    virtual int         _invokeValueCallback(string value);

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

    virtual int         _invokeTimedReportCallback(YMeasure value);

    virtual int         tare(void);

    virtual int         setupSpan(double currWeight,double maxWeight);

    virtual int         setCompensationTable(int tableIndex,vector<double> tempValues,vector<double> compValues);

    virtual int         loadCompensationTable(int tableIndex,vector<double>& tempValues,vector<double>& compValues);

    virtual int         set_offsetAvgCompensationTable(vector<double> tempValues,vector<double> compValues);

    virtual int         loadOffsetAvgCompensationTable(vector<double>& tempValues,vector<double>& compValues);

    virtual int         set_offsetChgCompensationTable(vector<double> tempValues,vector<double> compValues);

    virtual int         loadOffsetChgCompensationTable(vector<double>& tempValues,vector<double>& compValues);

    virtual int         set_spanAvgCompensationTable(vector<double> tempValues,vector<double> compValues);

    virtual int         loadSpanAvgCompensationTable(vector<double>& tempValues,vector<double>& compValues);

    virtual int         set_spanChgCompensationTable(vector<double> tempValues,vector<double> compValues);

    virtual int         loadSpanChgCompensationTable(vector<double>& tempValues,vector<double>& compValues);


    inline static YWeighScale* Find(string func)
    { return YWeighScale::FindWeighScale(func); }

           YWeighScale     *nextWeighScale(void);
    inline YWeighScale     *next(void)
    { return this->nextWeighScale();}

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

//--- (YWeighScale functions declaration)

inline YWeighScale* yFindWeighScale(const string& func)
{ return YWeighScale::FindWeighScale(func);}
inline YWeighScale* yFirstWeighScale(void)
{ return YWeighScale::FirstWeighScale();}

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

#endif