JsonHelper.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QLoggingCategory>
#include <QtCore/QJsonObject>
#include <QtCore/QVariantList>
#include <QtPositioning/QGeoCoordinate>
 
class QmlObjectListModel;
class QTranslator;
 
Q_DECLARE_LOGGING_CATEGORY(JsonHelperLog)
 
 
namespace JsonHelper
{
    QTranslator *translator();
 
    void saveQGCJsonFileHeader(QJsonObject &jsonObject,  
                               const QString &fileType,  
                               int version);             
 
    bool validateExternalQGCJsonFile(const QJsonObject &jsonObject,      
                                     const QString &expectedFileType,    
                                     int minSupportedVersion,            
                                     int maxSupportedVersion,            
                                     int &version,                       
                                     QString &errorString);              
 
    bool validateInternalQGCJsonFile(const QJsonObject &jsonObject,      
                                     const QString &expectedFileType,    
                                     int minSupportedVersion,            
                                     int maxSupportedVersion,            
                                     int &version,                       
                                     QString &errorString);              
 
    // Opens, validates and translates an internal QGC json file.
    // @return Json root object for file. Empty QJsonObject if error.
    QJsonObject openInternalQGCJsonFile(const QString &jsonFilename,     
                                        const QString &expectedFileType, 
                                        int minSupportedVersion,         
                                        int maxSupportedVersion,         
                                        int &version,                    
                                        QString &errorString);           
 
    struct KeyValidateInfo {
        const char *key;        
        QJsonValue::Type type;  
        bool required;          
    };
 
    bool validateKeys(const QJsonObject& jsonObject, const QList<KeyValidateInfo>& keyInfo, QString& errorString);
 
    bool loadGeoCoordinate(const QJsonValue &jsonValue, 
                           bool altitudeRequired,       
                           QGeoCoordinate &coordinate,  
                           QString &errorString,        
                           bool geoJsonFormat = false); 
 
    void saveGeoCoordinate(const QGeoCoordinate &coordinate,    
                           bool writeAltitude,                  
                           QJsonValue &jsonValue,               
                           bool geoJsonFormat = false);
 
    bool loadGeoCoordinateArray(const QJsonValue &jsonValue,        
                                bool altitudeRequired,              
                                QVariantList &rgVarPoints,          
                                QString &errorString);              
    bool loadGeoCoordinateArray(const QJsonValue &jsonValue,        
                                bool altitudeRequired,              
                                QList<QGeoCoordinate> &rgPoints,    
                                QString &errorString);              
 
    void saveGeoCoordinateArray(const QVariantList &rgVarPoints,        
                                bool writeAltitude,                     
                                QJsonValue &jsonValue);                 
    void saveGeoCoordinateArray(const QList<QGeoCoordinate> &rgPoints,  
                                bool writeAltitude,                     
                                QJsonValue &jsonValue);                 
 
    bool loadPolygon(const QJsonArray &polygonArray,    
                     QmlObjectListModel &list,          
                     QObject *parent,                   
                     QString &errorString);             
 
    void savePolygon(const QmlObjectListModel &list, 
                     QJsonArray &polygonArray);      
 
    constexpr const char *jsonVersionKey = "version";
    constexpr const char *jsonFileTypeKey = "fileType";
};