##// END OF EJS Templates
Creates enum that represents the value types that can be read in AMDA...
Alexandre Leroux -
r563:a08e6992e146
parent child
Show More
@@ -1,19 +1,21
1 1 #ifndef SCIQLOP_AMDARESULTPARSER_H
2 2 #define SCIQLOP_AMDARESULTPARSER_H
3 3
4 4 #include "AmdaGlobal.h"
5 5
6 6 #include <QLoggingCategory>
7 7
8 8 #include <memory>
9 9
10 10 class IDataSeries;
11 11
12 12 Q_DECLARE_LOGGING_CATEGORY(LOG_AmdaResultParser)
13 13
14 14 struct SCIQLOP_AMDA_EXPORT AmdaResultParser {
15 enum class ValueType { SCALAR, VECTOR, UNKNOWN };
15 16
16 static std::shared_ptr<IDataSeries> readTxt(const QString &filePath) noexcept;
17 static std::shared_ptr<IDataSeries> readTxt(const QString &filePath,
18 ValueType valueType) noexcept;
17 19 };
18 20
19 21 #endif // SCIQLOP_AMDARESULTPARSER_H
@@ -1,160 +1,167
1 1 #include "AmdaResultParser.h"
2 2
3 3 #include <Common/DateUtils.h>
4 4 #include <Data/ScalarSeries.h>
5 5
6 6 #include <QDateTime>
7 7 #include <QFile>
8 8 #include <QRegularExpression>
9 9
10 10 #include <cmath>
11 11
12 12 Q_LOGGING_CATEGORY(LOG_AmdaResultParser, "AmdaResultParser")
13 13
14 14 namespace {
15 15
16 16 /// Message in result file when the file was not found on server
17 17 const auto FILE_NOT_FOUND_MESSAGE = QStringLiteral("Not Found");
18 18
19 19 /// Format for dates in result files
20 20 const auto DATE_FORMAT = QStringLiteral("yyyy-MM-ddThh:mm:ss.zzz");
21 21
22 22 /// Separator between values in a result line
23 23 const auto RESULT_LINE_SEPARATOR = QRegularExpression{QStringLiteral("\\s+")};
24 24
25 25 /// Regex to find unit in a line. Examples of valid lines:
26 26 /// ... - Units : nT - ...
27 27 /// ... -Units:nT- ...
28 28 /// ... -Units: mΒ²- ...
29 29 /// ... - Units : m/s - ...
30 30 const auto UNIT_REGEX = QRegularExpression{QStringLiteral("-\\s*Units\\s*:\\s*(.+?)\\s*-")};
31 31
32 32 /// Converts a string date to a double date
33 33 /// @return a double that represents the date in seconds, NaN if the string date can't be converted
34 34 double doubleDate(const QString &stringDate) noexcept
35 35 {
36 36 auto dateTime = QDateTime::fromString(stringDate, DATE_FORMAT);
37 37 dateTime.setTimeSpec(Qt::UTC);
38 38 return dateTime.isValid() ? DateUtils::secondsSinceEpoch(dateTime)
39 39 : std::numeric_limits<double>::quiet_NaN();
40 40 }
41 41
42 42 /// Checks if a line is a comment line
43 43 bool isCommentLine(const QString &line)
44 44 {
45 45 return line.startsWith("#");
46 46 }
47 47
48 48 /**
49 49 * Reads stream to retrieve x-axis unit
50 50 * @param stream the stream to read
51 51 * @return the unit that has been read in the stream, a default unit (time unit with no label) if an
52 52 * error occured during reading
53 53 */
54 54 Unit readXAxisUnit(QTextStream &stream)
55 55 {
56 56 QString line{};
57 57
58 58 // Searches unit in the comment lines
59 59 while (stream.readLineInto(&line) && isCommentLine(line)) {
60 60 auto match = UNIT_REGEX.match(line);
61 61 if (match.hasMatch()) {
62 62 return Unit{match.captured(1), true};
63 63 }
64 64 }
65 65
66 66 qCWarning(LOG_AmdaResultParser()) << QObject::tr("The unit could not be found in the file");
67 67
68 68 // Error cases
69 69 return Unit{{}, true};
70 70 }
71 71
72 72 /**
73 73 * Reads stream to retrieve results
74 74 * @param stream the stream to read
75 75 * @return the pair of vectors x-axis data/values data that has been read in the stream
76 76 */
77 77 QPair<QVector<double>, QVector<double> > readResults(QTextStream &stream)
78 78 {
79 79 auto xData = QVector<double>{};
80 80 auto valuesData = QVector<double>{};
81 81
82 82 QString line{};
83 83
84 84 while (stream.readLineInto(&line)) {
85 85 // Ignore comment lines
86 86 if (!isCommentLine(line)) {
87 87 auto lineData = line.split(RESULT_LINE_SEPARATOR, QString::SkipEmptyParts);
88 88 if (lineData.size() == 2) {
89 89 // X : the data is converted from date to double (in secs)
90 90 auto x = doubleDate(lineData.at(0));
91 91
92 92 // Value
93 93 bool valueOk;
94 94 auto value = lineData.at(1).toDouble(&valueOk);
95 95
96 96 // Adds result only if x is valid. Then, if value is invalid, it is set to NaN
97 97 if (!std::isnan(x)) {
98 98 xData.push_back(x);
99 99
100 100 if (!valueOk) {
101 101 qCWarning(LOG_AmdaResultParser())
102 102 << QObject::tr(
103 103 "Value from line %1 is invalid and will be converted to NaN")
104 104 .arg(line);
105 105 value = std::numeric_limits<double>::quiet_NaN();
106 106 }
107 107
108 108 valuesData.push_back(value);
109 109 }
110 110 else {
111 111 qCWarning(LOG_AmdaResultParser())
112 112 << QObject::tr("Can't retrieve results from line %1: x is invalid")
113 113 .arg(line);
114 114 }
115 115 }
116 116 else {
117 117 qCWarning(LOG_AmdaResultParser())
118 118 << QObject::tr("Can't retrieve results from line %1: invalid line").arg(line);
119 119 }
120 120 }
121 121 }
122 122
123 123 return qMakePair(std::move(xData), std::move(valuesData));
124 124 }
125 125
126 126 } // namespace
127 127
128 std::shared_ptr<IDataSeries> AmdaResultParser::readTxt(const QString &filePath) noexcept
128 std::shared_ptr<IDataSeries> AmdaResultParser::readTxt(const QString &filePath,
129 ValueType valueType) noexcept
129 130 {
131 if (valueType == ValueType::UNKNOWN) {
132 qCCritical(LOG_AmdaResultParser())
133 << QObject::tr("Can't retrieve AMDA data: the type of values to be read is unknown");
134 return nullptr;
135 }
136
130 137 QFile file{filePath};
131 138
132 139 if (!file.open(QFile::ReadOnly | QIODevice::Text)) {
133 140 qCCritical(LOG_AmdaResultParser())
134 141 << QObject::tr("Can't retrieve AMDA data from file %1: %2")
135 142 .arg(filePath, file.errorString());
136 143 return nullptr;
137 144 }
138 145
139 146 QTextStream stream{&file};
140 147
141 148 // Checks if the file was found on the server
142 149 auto firstLine = stream.readLine();
143 150 if (firstLine.compare(FILE_NOT_FOUND_MESSAGE) == 0) {
144 151 qCCritical(LOG_AmdaResultParser())
145 152 << QObject::tr("Can't retrieve AMDA data from file %1: file was not found on server")
146 153 .arg(filePath);
147 154 return nullptr;
148 155 }
149 156
150 157 // Reads x-axis unit
151 158 stream.seek(0); // returns to the beginning of the file
152 159 auto xAxisUnit = readXAxisUnit(stream);
153 160
154 161 // Reads results
155 162 stream.seek(0); // returns to the beginning of the file
156 163 auto results = readResults(stream);
157 164
158 165 return std::make_shared<ScalarSeries>(std::move(results.first), std::move(results.second),
159 166 xAxisUnit, Unit{});
160 167 }
General Comments 0
You need to be logged in to leave comments. Login now