forked from Serial-Studio/Serial-Studio
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGenerator.h
More file actions
121 lines (108 loc) · 3.87 KB
/
Generator.h
File metadata and controls
121 lines (108 loc) · 3.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/*
* Copyright (c) 2020-2023 Alex Spataru <https://github.com/alex-spataru>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#pragma once
#include <QFile>
#include <QObject>
#include <QSettings>
#include <QJsonArray>
#include <QJsonValue>
#include <QJsonObject>
#include <QJsonDocument>
#include <JSON/Frame.h>
namespace JSON
{
/**
* @brief The Generator class
*
* The JSON generator class receives raw frame data from the I/O manager
* class and generates a JSON file that represents the project title,
* the groups that compose the project and the datasets that compose each
* group.
*
* As described in the documentation of the @c Frame class, the process
* of receiving data and generating the Serial Studio user interface is:
* 1) Physical device sends data
* 2) I/O driver receives data
* 3) I/O manager processes the data and separates the frames
* 4) JSON generator creates a JSON file with the data contained in each frame.
* 5) UI dashboard class receives the JSON file.
* 6) TimerEvents class notifies the UI dashboard that the user interface should
* be re-generated.
* 7) UI dashboard feeds JSON data to a @c Frame object.
* 8) The @c Frame object creates a model of the JSON data with the values of
* the latest received frame.
* 9) UI dashboard updates the widgets with the C++ model provided by this class.
*/
class Generator : public QObject
{
// clang-format off
Q_OBJECT
Q_PROPERTY(QString jsonMapFilename
READ jsonMapFilename
NOTIFY jsonFileMapChanged)
Q_PROPERTY(QString jsonMapFilepath
READ jsonMapFilepath
NOTIFY jsonFileMapChanged)
Q_PROPERTY(OperationMode operationMode
READ operationMode
WRITE setOperationMode
NOTIFY operationModeChanged)
// clang-format on
Q_SIGNALS:
void jsonFileMapChanged();
void operationModeChanged();
void jsonChanged(const QJsonObject &json);
private:
explicit Generator();
Generator(Generator &&) = delete;
Generator(const Generator &) = delete;
Generator &operator=(Generator &&) = delete;
Generator &operator=(const Generator &) = delete;
public:
enum OperationMode
{
kManual = 0x00,
kAutomatic = 0x01
};
Q_ENUM(OperationMode)
static Generator &instance();
QJsonObject &json();
QString jsonMapFilename() const;
QString jsonMapFilepath() const;
OperationMode operationMode() const;
public Q_SLOTS:
void loadJsonMap();
void loadJsonMap(const QString &path);
void setOperationMode(const JSON::Generator::OperationMode &mode);
public Q_SLOTS:
void readSettings();
void writeSettings(const QString &path);
private Q_SLOTS:
void readData(const QByteArray &data);
private:
QFile m_jsonMap;
QJsonObject m_json;
QSettings m_settings;
OperationMode m_opMode;
QJsonParseError m_error;
};
}