yocto_files.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_files.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindFiles(), the high-level API for Files 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_FILES_H
#define YOCTO_FILES_H

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

//--- (generated code: YFiles definitions)
class YFiles; // forward declaration

typedef void (*YFilesValueCallback)(YFiles *func, const string& functionValue);
#define Y_FILESCOUNT_INVALID            (YAPI_INVALID_UINT)
#define Y_FREESPACE_INVALID             (YAPI_INVALID_UINT)
//--- (end of generated code: YFiles definitions)


//--- (generated code: YFileRecord definitions)
//--- (end of generated code: YFileRecord definitions)


//--- (generated code: YFileRecord declaration)
class YOCTO_CLASS_EXPORT YFileRecord {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of generated code: YFileRecord declaration)
    //--- (generated code: YFileRecord attributes)
    // Attributes (function value cache)
    string          _name;
    int             _size;
    int             _crc;
    //--- (end of generated code: YFileRecord attributes)
    //--- (generated code: YFileRecord constructor)

    //--- (end of generated code: YFileRecord constructor)
    //--- (generated code: YFileRecord initialization)
    //--- (end of generated code: YFileRecord initialization)

public:
    YFileRecord(const string& json);
    //--- (generated code: YFileRecord accessors declaration)


    virtual string      get_name(void);

    virtual int         get_size(void);

    virtual int         get_crc(void);

#ifdef __BORLANDC__
#pragma option pop
#endif
    //--- (end of generated code: YFileRecord accessors declaration)
};





//--- (generated code: YFiles declaration)
class YOCTO_CLASS_EXPORT YFiles: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of generated code: YFiles declaration)
    //--- (generated code: YFiles attributes)
    // Attributes (function value cache)
    int             _filesCount;
    int             _freeSpace;
    YFilesValueCallback _valueCallbackFiles;

    friend YFiles *yFindFiles(const string& func);
    friend YFiles *yFirstFiles(void);

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

    // Constructor is protected, use yFindFiles factory function to instantiate
    YFiles(const string& func);
    //--- (end of generated code: YFiles attributes)

    //--- (generated code: YFiles initialization)
    //--- (end of generated code: YFiles initialization)

public:
    ~YFiles();
    //--- (generated code: YFiles accessors declaration)

    static const int FILESCOUNT_INVALID = YAPI_INVALID_UINT;
    static const int FREESPACE_INVALID = YAPI_INVALID_UINT;

    int                 get_filesCount(void);

    inline int          filesCount(void)
    { return this->get_filesCount(); }

    int                 get_freeSpace(void);

    inline int          freeSpace(void)
    { return this->get_freeSpace(); }

    static YFiles*      FindFiles(string func);

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

    virtual int         _invokeValueCallback(string value);

    virtual string      sendCommand(string command);

    virtual int         format_fs(void);

    virtual vector<YFileRecord> get_list(string pattern);

    virtual bool        fileExist(string filename);

    virtual string      download(string pathname);

    virtual int         upload(string pathname,string content);

    virtual int         remove(string pathname);


    inline static YFiles* Find(string func)
    { return YFiles::FindFiles(func); }

           YFiles          *nextFiles(void);
    inline YFiles          *next(void)
    { return this->nextFiles();}

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

//--- (generated code: YFiles functions declaration)

inline YFiles* yFindFiles(const string& func)
{ return YFiles::FindFiles(func);}
inline YFiles* yFirstFiles(void)
{ return YFiles::FirstFiles();}

//--- (end of generated code: YFiles functions declaration)

#endif