VariantDataModel.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
 
#ifndef __VARIANT_DATA_MODEL__
#define __VARIANT_DATA_MODEL__
 
#include <QVariant>
 
#include "CamiTKExtensionGeneratorAPI.h"
 
class CAMITKEXTENSIONGENERATOR_EXPORT VariantDataModel {
public:
    enum VariantNodeType {
        Atomic, 
        List,   
        Map     
    };
 
    VariantDataModel();
 
    VariantDataModel(const QVariant& variant);
 
    VariantDataModel(const QVariantList& variant);
 
    VariantDataModel(const QVariantMap& variant);
 
    VariantDataModel(const VariantDataModel& other);
 
    static const VariantDataModel fromJsonString(const QString& jsonString);
 
    static const VariantDataModel fromJsonObject(const QJsonObject& jsonObject);
 
    static VariantDataModel& invalid();
 
    bool isModified() const;
    bool isValid() const ;
    QString typeString() const;
    QString getName();
 
    VariantDataModel& operator=(QVariant newValue);
 
    QVariant getValue() const;
 
    QString toString() const;
 
    operator QString() const;
 
    QString toJsonString() const;
 
    void remove();
 
    bool operator==(const VariantDataModel& other) const;
    bool operator==(const QVariant& v) const;
    bool operator==(const QVariantList& v) const;
    bool operator==(const QVariantMap& v) const;
 
    bool operator!=(const VariantDataModel& other) const;
    bool operator!=(const QVariant& v) const;
    bool operator!=(const QVariantList& v) const;
    bool operator!=(const QVariantMap& v) const;
 
    VariantDataModel& last();
 
    int size() const;
 
    bool isEmpty() const;
 
    void reset();
 
 
    VariantDataModel& value(const QString& key);
 
    VariantDataModel& operator[](const QString& key);
 
    const VariantDataModel operator[](const QString& key) const;
 
    bool contains(const QString& key) const;
 
    void insert(const QString& key, const VariantDataModel& value);
 
    void insert(const QString& key, const QVariant& value);
 
    int remove(const QString& key) ;
 
 
    VariantDataModel& at(int i) ;
 
    VariantDataModel& operator[](int i);
 
    const VariantDataModel operator[](int i) const;
 
    bool removeOne(const VariantDataModel& item);
 
    bool removeAt(int i);
 
    void append(const VariantDataModel& item);
 
 
    QList<VariantDataModel>::iterator begin();
 
    QList<VariantDataModel>::const_iterator begin() const;
 
    QList<VariantDataModel>::iterator end();
 
    QList<VariantDataModel>::const_iterator end() const;
 
    QMap<QString, VariantDataModel>::iterator beginMap();
 
    QMap<QString, VariantDataModel>::const_iterator beginMap() const;
 
    QMap<QString, VariantDataModel>::iterator endMap();
 
    QMap<QString, VariantDataModel>::const_iterator endMap() const;
 
protected:
    bool isModifiedFlag;
 
    VariantNodeType type;
 
    QString name;
 
    static VariantDataModel invalidVariantDataModel;
 
    void setName(const QString& name);
 
private:
    void copyMap(const QVariantMap&);
 
    void copyList(const QVariantList&);
 
    QVariant simpleValue;
 
    QList<VariantDataModel> list;
 
    QMap<QString, VariantDataModel> map;
};
 
#endif // __VARIANT_DATA_MODEL__