yocto_oscontrol.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_oscontrol.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindOsControl(), the high-level API for OsControl 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_OSCONTROL_H
#define YOCTO_OSCONTROL_H

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

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

typedef void (*YOsControlValueCallback)(YOsControl *func, const string& functionValue);
#define Y_SHUTDOWNCOUNTDOWN_INVALID     (YAPI_INVALID_UINT)
//--- (end of YOsControl definitions)

//--- (YOsControl declaration)
class YOCTO_CLASS_EXPORT YOsControl: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YOsControl declaration)
protected:
    //--- (YOsControl attributes)
    // Attributes (function value cache)
    int             _shutdownCountdown;
    YOsControlValueCallback _valueCallbackOsControl;

    friend YOsControl *yFindOsControl(const string& func);
    friend YOsControl *yFirstOsControl(void);

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

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

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

    static const int SHUTDOWNCOUNTDOWN_INVALID = YAPI_INVALID_UINT;

    int                 get_shutdownCountdown(void);

    inline int          shutdownCountdown(void)
    { return this->get_shutdownCountdown(); }

    int             set_shutdownCountdown(int newval);
    inline int      setShutdownCountdown(int newval)
    { return this->set_shutdownCountdown(newval); }

    static YOsControl*  FindOsControl(string func);

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

    virtual int         _invokeValueCallback(string value);

    virtual int         shutdown(int secBeforeShutDown);


    inline static YOsControl* Find(string func)
    { return YOsControl::FindOsControl(func); }

           YOsControl      *nextOsControl(void);
    inline YOsControl      *next(void)
    { return this->nextOsControl();}

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

//--- (YOsControl functions declaration)

inline YOsControl* yFindOsControl(const string& func)
{ return YOsControl::FindOsControl(func);}
inline YOsControl* yFirstOsControl(void)
{ return YOsControl::FirstOsControl();}

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

#endif