forked from Serial-Studio/Serial-Studio
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFrame.h
More file actions
72 lines (66 loc) · 2.55 KB
/
Frame.h
File metadata and controls
72 lines (66 loc) · 2.55 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
/*
* Copyright (c) 2020-2022 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 <QVector>
#include <QObject>
#include <QVariant>
#include <QJsonArray>
#include <QJsonObject>
#include <JSON/Group.h>
namespace JSON
{
/**
* @brief The Frame class
*
* The frame class represents a complete frame, including the groups & datasets
* that compose it. This class allows Serial Studio to build the user interface
* dinamically from the received data.
*
* The process of building a frame and representing it in Serial Studio 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 this class.
* 8) This class creates a model of the JSON data with the values of the latest
* frame.
* 9) UI dashboard updates the widgets with the C++ model provided by this class.
*/
class Frame
{
public:
~Frame();
void clear();
QString title() const;
int groupCount() const;
QVector<Group> &groups();
bool read(const QJsonObject &object);
Q_INVOKABLE const JSON::Group &getGroup(const int index) const;
inline bool isValid() const { return !title().isEmpty() && groupCount() > 0; }
private:
QString m_title;
QVector<Group> m_groups;
};
}