yocto_segmenteddisplay.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_segmenteddisplay.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindSegmentedDisplay(), the high-level API for SegmentedDisplay 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_SEGMENTEDDISPLAY_H
#define YOCTO_SEGMENTEDDISPLAY_H

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

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

typedef void (*YSegmentedDisplayValueCallback)(YSegmentedDisplay *func, const string& functionValue);
#ifndef _Y_DISPLAYMODE_ENUM
#define _Y_DISPLAYMODE_ENUM
typedef enum {
    Y_DISPLAYMODE_DISCONNECTED = 0,
    Y_DISPLAYMODE_MANUAL = 1,
    Y_DISPLAYMODE_AUTO1 = 2,
    Y_DISPLAYMODE_AUTO60 = 3,
    Y_DISPLAYMODE_INVALID = -1,
} Y_DISPLAYMODE_enum;
#endif
#define Y_DISPLAYEDTEXT_INVALID         (YAPI_INVALID_STRING)
//--- (end of YSegmentedDisplay definitions)

//--- (YSegmentedDisplay declaration)
class YOCTO_CLASS_EXPORT YSegmentedDisplay: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YSegmentedDisplay declaration)
protected:
    //--- (YSegmentedDisplay attributes)
    // Attributes (function value cache)
    string          _displayedText;
    Y_DISPLAYMODE_enum _displayMode;
    YSegmentedDisplayValueCallback _valueCallbackSegmentedDisplay;

    friend YSegmentedDisplay *yFindSegmentedDisplay(const string& func);
    friend YSegmentedDisplay *yFirstSegmentedDisplay(void);

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

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

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

    static const string DISPLAYEDTEXT_INVALID;
    static const Y_DISPLAYMODE_enum DISPLAYMODE_DISCONNECTED = Y_DISPLAYMODE_DISCONNECTED;
    static const Y_DISPLAYMODE_enum DISPLAYMODE_MANUAL = Y_DISPLAYMODE_MANUAL;
    static const Y_DISPLAYMODE_enum DISPLAYMODE_AUTO1 = Y_DISPLAYMODE_AUTO1;
    static const Y_DISPLAYMODE_enum DISPLAYMODE_AUTO60 = Y_DISPLAYMODE_AUTO60;
    static const Y_DISPLAYMODE_enum DISPLAYMODE_INVALID = Y_DISPLAYMODE_INVALID;

    string              get_displayedText(void);

    inline string       displayedText(void)
    { return this->get_displayedText(); }

    int             set_displayedText(const string& newval);
    inline int      setDisplayedText(const string& newval)
    { return this->set_displayedText(newval); }

    Y_DISPLAYMODE_enum  get_displayMode(void);

    inline Y_DISPLAYMODE_enum displayMode(void)
    { return this->get_displayMode(); }

    int             set_displayMode(Y_DISPLAYMODE_enum newval);
    inline int      setDisplayMode(Y_DISPLAYMODE_enum newval)
    { return this->set_displayMode(newval); }

    static YSegmentedDisplay* FindSegmentedDisplay(string func);

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

    virtual int         _invokeValueCallback(string value);


    inline static YSegmentedDisplay* Find(string func)
    { return YSegmentedDisplay::FindSegmentedDisplay(func); }

           YSegmentedDisplay *nextSegmentedDisplay(void);
    inline YSegmentedDisplay *next(void)
    { return this->nextSegmentedDisplay();}

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

//--- (YSegmentedDisplay functions declaration)

inline YSegmentedDisplay* yFindSegmentedDisplay(const string& func)
{ return YSegmentedDisplay::FindSegmentedDisplay(func);}
inline YSegmentedDisplay* yFirstSegmentedDisplay(void)
{ return YSegmentedDisplay::FirstSegmentedDisplay();}

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

#endif