swift
databaseutils.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (C) 2016 swift Project Community / Contributors
2 // SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
3 
5 
6 #ifndef SWIFT_CORE_DB_DATABASEUTILS_H
7 #define SWIFT_CORE_DB_DATABASEUTILS_H
8 
9 #include <QByteArray>
10 #include <QHttpPart>
11 #include <QJsonArray>
12 #include <QJsonObject>
13 #include <QUrlQuery>
14 
15 #include "core/progress.h"
16 #include "core/swiftcoreexport.h"
17 #include "misc/simulation/aircraftmodel.h"
18 #include "misc/simulation/autopublishdata.h"
19 
20 namespace swift::core::db
21 {
23  class SWIFT_CORE_EXPORT CDatabaseUtils
24  {
25  public:
27  CDatabaseUtils() = delete;
28 
30  static const QStringList &getLogCategories();
31 
34  static swift::misc::simulation::CAircraftModelList consolidateModelsWithSimulatorModelsAllowsGuiRefresh(
35  const swift::misc::simulation::CAircraftModelList &models,
36  const swift::misc::simulation::CAircraftModelList &simulatorModels, QStringList &removedModelStrings,
37  bool processEvents);
38 
41  static swift::misc::simulation::CAircraftModelList
42  updateModelsDirectoriesAllowsGuiRefresh(const swift::misc::simulation::CAircraftModelList &models,
43  const swift::misc::simulation::CAircraftModelList &simulatorModels,
44  QStringList &removedModelStrings, bool processEvents);
45 
47  static swift::misc::simulation::CAircraftModel
48  consolidateOwnAircraftModelWithDbData(const swift::misc::simulation::CAircraftModel &model, bool force,
49  bool *modified = nullptr);
50 
52  static swift::misc::simulation::CAircraftModel
53  consolidateModelWithDbData(const swift::misc::simulation::CAircraftModel &model, bool force,
54  bool *modified = nullptr);
55 
57  static swift::misc::simulation::CAircraftModel
58  consolidateModelWithDbData(const swift::misc::simulation::CAircraftModel &model,
59  const swift::misc::simulation::CAircraftModel &dbModel, bool force, bool *modified);
60 
62  static int consolidateModelsWithDbData(swift::misc::simulation::CAircraftModelList &models, bool force);
63 
66  static int consolidateModelsWithDbData(const swift::misc::simulation::CAircraftModelList &dbModels,
67  swift::misc::simulation::CAircraftModelList &simulatorModels,
68  bool force);
69 
71  static int consolidateModelsWithDbDataAllowsGuiRefresh(swift::misc::simulation::CAircraftModelList &models,
72  bool force, bool processEvents);
73 
75  static int consolidateModelsWithDbModelAndDistributor(swift::misc::simulation::CAircraftModelList &models,
76  bool force);
77 
79  static swift::misc::simulation::CAircraftModel
80  consolidateModelWithDbDistributor(const swift::misc::simulation::CAircraftModel &model, bool force);
81 
83  static int consolidateModelsWithDbDistributor(swift::misc::simulation::CAircraftModelList &models, bool force);
84 
86  static int fillInMissingAircraftAndLiveryEntities(swift::misc::simulation::CAircraftModelList &models);
87 
89  static swift::misc::simulation::CAircraftModelList
90  updateSimulatorForFsFamily(const swift::misc::simulation::CAircraftModelList &ownModels,
91  swift::misc::CStatusMessageList *updateInfo, int maxToStash = -1,
92  swift::core::IProgressIndicator *progressIndicator = nullptr,
93  bool processEvents = true);
94 
96  static QJsonDocument databaseJsonToQJsonDocument(const QString &content);
97 
99  static QJsonDocument readQJsonDocumentFromDatabaseFile(const QString &filename);
100 
102  static QJsonObject readQJsonObjectFromDatabaseFile(const QString &filename);
103 
105  static QJsonObject readQJsonObjectFromDatabaseFile(const QString &directory, const QString &filename);
106 
108  static bool hasDbAircraftData();
109 
111  static const QUrlQuery &getCompressedQuery();
112 
114  static QHttpPart getJsonTextMultipart(const QJsonObject &json, bool compress);
115 
117  static QHttpPart getJsonTextMultipart(const QString &json, bool compress);
118 
120  static QHttpPart getJsonTextMultipart(const QJsonArray &json, bool compress);
121 
123  static QHttpPart getJsonTextMultipart(const QByteArray &bytes, bool compress);
124 
126  static QHttpPart getMultipartWithDebugFlag();
127 
130  static swift::misc::simulation::ChangedAutoPublishData
131  autoPublishDataChanged(const QString &modelString, const swift::misc::physical_quantities::CLength &cg,
132  const swift::misc::simulation::CSimulatorInfo &simulator);
133 
136  static swift::misc::simulation::ChangedAutoPublishData
137  autoPublishDataChanged(const swift::misc::simulation::CAircraftModel &model,
138  const swift::misc::physical_quantities::CLength &cg,
139  const swift::misc::simulation::CSimulatorInfo &simulator);
140  };
141 } // namespace swift::core::db
142 #endif // SWIFT_CORE_DB_DATABASEUTILS_H
swift::core::IProgressIndicator
Implementing class features a progress bar or something similar.
Definition: progress.h:16
swift::core::db::CDatabaseUtils
Read information about data from Database.
Definition: databaseutils.h:24
swift::core::db::CDatabaseUtils::CDatabaseUtils
CDatabaseUtils()=delete
No constructor.
swift::misc::CStatusMessageList
Status messages, e.g. from Core -> GUI.
Definition: statusmessagelist.h:33
swift::misc::physical_quantities::CLength
Physical unit length (length)
Definition: length.h:18
swift::misc::simulation::CAircraftModel
Aircraft model (used by another pilot, my models on disk)
Definition: aircraftmodel.h:71
swift::misc::simulation::CAircraftModelList
Value object encapsulating a list of aircraft models.
Definition: aircraftmodellist.h:60
swift::misc::simulation::CSimulatorInfo
Simple hardcoded info about the corresponding simulator.
Definition: simulatorinfo.h:41
swift::core::db
Classes interacting with the swift database (aka "datastore").
Definition: airportdatareader.cpp:23
SWIFT_CORE_EXPORT
#define SWIFT_CORE_EXPORT
Export a class or function from the library.
Definition: swiftcoreexport.h:20
Generated on Mon Mar 24 2025 16:42:19 for swift by doxygen 1.9.1