OPreferenceManager.h

Go to the documentation of this file.

/*
 * Copyright (C) <2012-2024> <EDF-DTG> <FRANCE>
 * This file is part of Code_TYMPAN (R).
 * Code_TYMPAN (R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * Code_TYMPAN (R) 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License along
 * with Code_TYMPAN (R). If not, see <https://www.gnu.org/licenses/>.
 */
 
/*
 *
 *
 *
 *
 */
#ifdef _MSC_VER
    #pragma warning(disable : 4503)
    #pragma warning(disable : 4786)
#endif
 
#ifndef __O_PREFERENCE_MANAGER__
    #define __O_PREFERENCE_MANAGER__
 
    #include "Tympan/core/defines.h"
    #include <map>
    #include <QString>
    #include <vector>
 
// typedef std::map<QString, QString> OPrefMap;
struct OPrefMap
{
    typedef std::map<QString, QString>::iterator OPrefMapIt;
    std::map<QString, QString> _prefMap;
};
 
// typedef std::map<QString, OPrefMap> ODirMap;
struct ODirMap
{
    typedef std::map<QString, OPrefMap>::iterator ODirMapIt;
    std::map<QString, OPrefMap> _dirMap;
};
 
class OPreferenceManager
{
public:
    OPreferenceManager();
    OPreferenceManager(const QString& currentDirectory);
    OPreferenceManager(const QString& rootNodeName, const QString& paramNodeName);
    OPreferenceManager(const QString& rootNodeName, const QString& paramNodeName,
                       const QString& currentDirectory);
    virtual ~OPreferenceManager();
 
    void completePreferences(QString filePath);
 
    void loadDefault(const char* defaultParams[][2], int nbParams);
 
    void reset();
 
    void setXMLRootNodeName(QString name)
    {
        _xmlRootNodeName = name;
    }
 
    void setXMLParamNodeName(QString name)
    {
        _xmlParamNodeName = name;
    }
 
    bool readXML(QString fileName);
 
    bool writeXML(QString fileName);
 
    bool exists(const QString& pref);
 
    bool exists(const QString& dir, const QString& pref);
 
    QString getDirectory(const QString& pref);
 
    void setCurrentDirectory(QString dir);
    QString getCurrentDirectory()
    {
        return _curDir;
    }
 
    void setString(const QString& pref, const QString& value);
 
    void setString(const QString& dir, const QString& pref, const QString& value);
 
    QString getString(const QString& pref);
 
    QString getString(const QString& dir, const QString& pref);
 
    void setStringArray(const QString& pref, const QString* valueArray, const int& sizeArray);
 
    void setStringArray(const QString& dir, const QString& pref, const QString* valueArray,
                        const int& sizeArray);
 
    QString* getStringArray(const QString& pref, int& sizeArray);
 
    QString* getStringArray(const QString& dir, const QString& pref, int& sizeArray);
 
    #if TY_ARCH_TYPE == TY_ARCHITECTURE_64
    void setUInt(const QString& pref, const unsigned int& value);
    void setUInt(const QString& dir, const QString& pref, const unsigned int& value);
 
    void setUInt(const QString& pref, const size_t& value);
    void setUInt(const QString& dir, const QString& pref, const size_t& value);
 
        #if TY_COMPILER == TY_COMPILER_MSVC
    void setUInt(const QString& pref, const unsigned long& value);
    void setUInt(const QString& dir, const QString& pref, const unsigned long& value);
        #endif
    #else
    void setUInt(const QString& pref, const size_t& value);
 
    void setUInt(const QString& dir, const QString& pref, const size_t& value);
 
    void setUInt(const QString& pref, const unsigned long& value);
 
    void setUInt(const QString& dir, const QString& pref, const unsigned long& value);
 
    #endif
    void setInt(const QString& pref, const int& value);
 
    void setInt(const QString& dir, const QString& pref, const int& value);
 
    int getInt(const QString& pref);
 
    int getInt(const QString& dir, const QString& pref);
 
    void setBool(const QString& pref, const bool& value);
    void setBool(const QString& dir, const QString& pref, const bool& value);
 
    bool getBool(const QString& pref);
 
    bool getBool(const QString& dir, const QString& pref);
 
    void setFloat(const QString& pref, const float& value);
 
    void setFloat(const QString& dir, const QString& pref, const float& value);
 
    float getFloat(const QString& pref);
 
    float getFloat(const QString& dir, const QString& pref);
 
    void setDouble(const QString& pref, const double& value);
 
    void setDouble(const QString& dir, const QString& pref, const double& value);
 
    double getDouble(const QString& pref);
    double getDouble(const QString& dir, const QString& pref);
 
    void setFrame(const QString& pref, const int& posX, const int& posY, const int& sizeX, const int& sizeY);
 
    void setFrame(const QString& dir, const QString& pref, const int& posX, const int& posY, const int& sizeX,
                  const int& sizeY);
 
    void getFrame(const QString& pref, int& posX, int& posY, int& sizeX, int& sizeY);
 
    void getFrame(const QString& dir, const QString& pref, int& posX, int& posY, int& sizeX, int& sizeY);
 
    void setPoint(const QString& pref, const int& x, const int& y);
 
    void setPoint(const QString& dir, const QString& pref, const int& x, const int& y);
 
    void getPoint(const QString& pref, int& x, int& y);
 
    void getPoint(const QString& dir, const QString& pref, int& x, int& y);
 
    void setColor(const QString& pref, const float& r, const float& g, const float& b);
 
    void setColor(const QString& dir, const QString& pref, const float& r, const float& g, const float& b);
 
    void getColor(const QString& pref, float& r, float& g, float& b);
 
    void getColor(const QString& dir, const QString& pref, float& r, float& g, float& b);
 
    #if TY_ARCH_TYPE == TY_ARCHITECTURE_64
    static QString uintToString(const unsigned int& val);
 
    static QString uintToString(const size_t& val);
        #if TY_COMPILER == TY_COMPILER_MSVC
    static QString uintToString(const unsigned long& val);
        #endif
    #else
    static QString uintToString(const size_t& val);
 
    static QString uintToString(const unsigned long& val);
    #endif
 
    static QString intToString(const int& val);
 
    static QString floatToString(const float& val);
 
    static QString doubleToString(const double& val);
 
    int getLastModificationCode()
    {
        return _nPreferenceModificationStamp;
    }
 
    std::vector<QString> getPreferenceNames();
 
protected:
    ODirMap _prefDirs;
 
    QString _curDir;
 
    QString _xmlRootNodeName;
    QString _xmlParamNodeName;
 
private:
    int _nPreferenceModificationStamp;
};
 
#endif // __O_PREFERENCE_MANAGER__