/
VariablesWidget.cpp
2695 lines (2570 loc) · 116 KB
/
VariablesWidget.cpp
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* This file is part of OpenModelica.
*
* Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
* c/o Linköpings universitet, Department of Computer and Information Science,
* SE-58183 Linköping, Sweden.
*
* All rights reserved.
*
* THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
* THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
* ACCORDING TO RECIPIENTS CHOICE.
*
* The OpenModelica software and the Open Source Modelica
* Consortium (OSMC) Public License (OSMC-PL) are obtained
* from OSMC, either from the above address,
* from the URLs: http://www.ida.liu.se/projects/OpenModelica or
* http://www.openmodelica.org, and in the OpenModelica distribution.
* GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
*
* This program is distributed WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
* IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
*
* See the full OSMC Public License conditions for more details.
*
*/
/*
* @author Adeel Asghar <adeel.asghar@liu.se>
*/
#include "VariablesWidget.h"
#include "MainWindow.h"
#include "OMC/OMCProxy.h"
#include "Modeling/ModelWidgetContainer.h"
#include "Modeling/ItemDelegate.h"
#include "Options/OptionsDialog.h"
#include "Modeling/MessagesWidget.h"
#include "util/read_matlab4.h"
#include "Plotting/PlotWindowContainer.h"
#include "Plotting/DiagramWindow.h"
#include "Simulation/SimulationDialog.h"
#include "Simulation/SimulationOutputWidget.h"
#include "TransformationalDebugger/TransformationsWidget.h"
#include <QObject>
using namespace OMPlot;
namespace VariableItemData {
enum VariableItemData {
FILEPATH=0,
FILENAME,
NAME,
DISPLAYNAME,
TYPE,
VALUE,
UNIT,
DISPLAYUNIT,
DISPLAYUNITS,
DESCRIPTION,
TOOLTIP,
ISMAINARRAY,
USES,
INITIAL_USES,
DEFINED_IN,
INFOFILE
};
}
/*!
* \class VariablesTreeItem
* \brief Contains the information about the result variable.
*/
/*!
* \brief VariablesTreeItem::VariablesTreeItem
* \param variableItemData see VariableItemData::VariableItemData
* \param pParent
* \param isRootItem
*/
VariablesTreeItem::VariablesTreeItem(const QVector<QVariant> &variableItemData, VariablesTreeItem *pParent, bool isRootItem)
{
mpParentVariablesTreeItem = pParent;
mIsRootItem = isRootItem;
setVariableItemData(variableItemData);
mValueChanged = false;
mChecked = false;
mEditable = false;
mVariability = "";
mActive = false;
}
VariablesTreeItem::~VariablesTreeItem()
{
qDeleteAll(mChildren);
mChildren.clear();
}
/*!
* \brief VariablesTreeItem::setVariableItemData
* Sets the values using the variable item data vector.
* \param variableItemData
*/
void VariablesTreeItem::setVariableItemData(const QVector<QVariant> &variableItemData)
{
mFilePath = variableItemData[VariableItemData::FILEPATH].toString();
mFileName = variableItemData[VariableItemData::FILENAME].toString();
mVariableName = variableItemData[VariableItemData::NAME].toString();
mDisplayVariableName = variableItemData[VariableItemData::DISPLAYNAME].toString();
mType = variableItemData[VariableItemData::TYPE].toString();
mValue = variableItemData[VariableItemData::VALUE].toString();
mUnit = variableItemData[VariableItemData::UNIT].toString();
mDisplayUnit = variableItemData[VariableItemData::DISPLAYUNIT].toString();
mPreviousUnit = variableItemData[VariableItemData::DISPLAYUNIT].toString();
mDisplayUnits = variableItemData[VariableItemData::DISPLAYUNITS].toStringList();
mDescription = variableItemData[VariableItemData::DESCRIPTION].toString();
mToolTip = variableItemData[VariableItemData::TOOLTIP].toString();
mIsMainArray = variableItemData[VariableItemData::ISMAINARRAY].toBool();
mUses = variableItemData[VariableItemData::USES].toStringList();
mInitialUses = variableItemData[VariableItemData::INITIAL_USES].toStringList();
foreach(QVariant var, variableItemData[VariableItemData::DEFINED_IN].toList()) {
mDefinedIn << var.value<IntStringPair>();
}
mInfoFileName = variableItemData[VariableItemData::INFOFILE].toString();
}
QString VariablesTreeItem::getPlotVariable()
{
return QString(mVariableName).remove(0, mFileName.length() + 1);
}
bool VariablesTreeItem::isString() const
{
return mType.compare(QStringLiteral("String")) == 0;
}
/*!
* \brief VariablesTreeItem::setActive
* Sets all the VariablesTreeItems inactive except this one.
*/
void VariablesTreeItem::setActive()
{
VariablesTreeItem *pRootVariablesTreeItem;
pRootVariablesTreeItem = MainWindow::instance()->getVariablesWidget()->getVariablesTreeModel()->getRootVariablesTreeItem();
for (int i = 0 ; i < pRootVariablesTreeItem->mChildren.size() ; i++) {
VariablesTreeItem *pVariablesTreeItem = pRootVariablesTreeItem->child(i);
if (pVariablesTreeItem) {
if (pVariablesTreeItem != this) {
pVariablesTreeItem->mActive = false;
}
}
}
// set VariablesTreeView to active.
mActive = true;
MainWindow::instance()->getVariablesWidget()->initializeVisualization(mSimulationOptions);
}
QIcon VariablesTreeItem::getVariableTreeItemIcon(QString name) const
{
if (name.endsWith(".mat"))
return QIcon(":/Resources/icons/mat.svg");
else if (name.endsWith(".plt"))
return QIcon(":/Resources/icons/plt.svg");
else if (name.endsWith(".csv"))
return QIcon(":/Resources/icons/csv.svg");
else
return QIcon(":/Resources/icons/interaction.svg");
}
void VariablesTreeItem::insertChild(int position, VariablesTreeItem *pVariablesTreeItem)
{
mChildren.insert(position, pVariablesTreeItem);
}
VariablesTreeItem* VariablesTreeItem::child(int row)
{
return mChildren.value(row);
}
void VariablesTreeItem::removeChildren()
{
qDeleteAll(mChildren);
mChildren.clear();
}
void VariablesTreeItem::removeChild(VariablesTreeItem *pVariablesTreeItem)
{
mChildren.removeOne(pVariablesTreeItem);
}
int VariablesTreeItem::columnCount() const
{
return 5;
}
/*!
* \brief VariablesTreeItem::setData
* Updates the item data.
* \param column
* \param value
* \param role
* \return
*/
bool VariablesTreeItem::setData(int column, const QVariant &value, int role)
{
if (column == 0 && role == Qt::CheckStateRole) {
if (value.toInt() == Qt::Checked) {
setChecked(true);
} else if (value.toInt() == Qt::Unchecked) {
setChecked(false);
}
return true;
} else if (column == 1 && role == Qt::EditRole) {
if (mValue.compare(value.toString()) != 0) {
mValueChanged = true;
mValue = value.toString();
}
return true;
} else if (column == 3 && role == Qt::EditRole) {
if (mDisplayUnit.compare(Utilities::convertSymbolToUnit(value.toString())) != 0) {
mPreviousUnit = mDisplayUnit;
mDisplayUnit = Utilities::convertSymbolToUnit(value.toString());
}
return true;
}
return false;
}
QVariant VariablesTreeItem::data(int column, int role) const
{
switch (column) {
case 0:
switch (role) {
case Qt::DisplayRole:
return isActive() ? "(Active) " + mDisplayVariableName : mDisplayVariableName;
case Qt::DecorationRole:
return mIsRootItem ? getVariableTreeItemIcon(mVariableName) : QIcon();
case Qt::ToolTipRole:
return mToolTip;
case Qt::CheckStateRole:
/* Show checkbox for nodes without children i.e., leaf nodes.
* Show checkbox for nodes that are array.
*/
if (parent()->parent() && (mChildren.size() == 0 || mIsMainArray)) {
return isChecked() ? Qt::Checked : Qt::Unchecked;
} else {
return QVariant();
}
case Qt::FontRole:
if (isActive()) {
QFont font;
font.setBold(true);
return font;
} else {
return QVariant();
}
default:
return QVariant();
}
case 1:
switch (role) {
case Qt::DisplayRole:
case Qt::ToolTipRole:
case Qt::EditRole:
return mValue;
case Qt::FontRole:
if (isParameter()) {
QFont font;
font.setItalic(true);
return font;
} else {
return QVariant();
}
default:
return QVariant();
}
case 2:
switch (role) {
case Qt::DisplayRole:
case Qt::ToolTipRole:
return Utilities::convertUnitToSymbol(mUnit);
default:
return QVariant();
}
case 3:
switch (role) {
case Qt::DisplayRole:
case Qt::ToolTipRole:
return Utilities::convertUnitToSymbol(mDisplayUnit);
default:
return QVariant();
}
case 4:
switch (role) {
case Qt::DisplayRole:
case Qt::ToolTipRole:
return mDescription;
default:
return QVariant();
}
default:
return QVariant();
}
}
int VariablesTreeItem::row() const
{
if (mpParentVariablesTreeItem)
return mpParentVariablesTreeItem->mChildren.indexOf(const_cast<VariablesTreeItem*>(this));
return 0;
}
VariablesTreeItem* VariablesTreeItem::rootParent()
{
// since we have global mpRootVariablesTreeItem so we return one level down from this function in order to get the top level item.
VariablesTreeItem *pVariablesTreeItem, *pVariablesTreeItem1;
pVariablesTreeItem = this;
pVariablesTreeItem1 = this;
while (pVariablesTreeItem->mpParentVariablesTreeItem) {
pVariablesTreeItem1 = pVariablesTreeItem;
pVariablesTreeItem = pVariablesTreeItem->mpParentVariablesTreeItem;
}
return pVariablesTreeItem1;
}
/*!
* \brief VariablesTreeItem::getValue
* Returns the value in the desired unit or
* an empty value in case of conversion error.
* \param fromUnit
* \param toUnit
* \return
*/
QVariant VariablesTreeItem::getValue(QString fromUnit, QString toUnit)
{
QString value = "";
if (fromUnit.compare(toUnit) == 0) {
value = mValue;
} else {
OMCInterface::convertUnits_res convertUnit = MainWindow::instance()->getOMCProxy()->convertUnits(fromUnit, toUnit);
if (convertUnit.unitsCompatible) {
bool ok = false;
qreal realValue = mValue.toDouble(&ok);
if (ok) {
realValue = Utilities::convertUnit(realValue, convertUnit.offset, convertUnit.scaleFactor);
value = StringHandler::number(realValue);
}
}
}
return value;
}
VariablesTreeModel::VariablesTreeModel(VariablesTreeView *pVariablesTreeView)
: QAbstractItemModel(pVariablesTreeView)
{
mpVariablesTreeView = pVariablesTreeView;
QVector<QVariant> headers;
headers << "" << "" << Helper::variables << Helper::variables << "" << tr("Value") << tr("Unit") << tr("Display Unit") <<
QStringList() << Helper::description << "" << false << QVariantList() << QVariantList() << QVariantList() << "dummy.json";
mpRootVariablesTreeItem = new VariablesTreeItem(headers, 0, true);
mpActiveVariablesTreeItem = 0;
}
int VariablesTreeModel::columnCount(const QModelIndex &parent) const
{
if (parent.isValid())
return static_cast<VariablesTreeItem*>(parent.internalPointer())->columnCount();
else
return mpRootVariablesTreeItem->columnCount();
}
int VariablesTreeModel::rowCount(const QModelIndex &parent) const
{
VariablesTreeItem *pParentVariablesTreeItem;
if (parent.column() > 0)
return 0;
if (!parent.isValid())
pParentVariablesTreeItem = mpRootVariablesTreeItem;
else
pParentVariablesTreeItem = static_cast<VariablesTreeItem*>(parent.internalPointer());
return pParentVariablesTreeItem->mChildren.size();
}
QVariant VariablesTreeModel::headerData(int section, Qt::Orientation orientation, int role) const
{
if (orientation == Qt::Horizontal && role == Qt::DisplayRole)
return mpRootVariablesTreeItem->data(section);
return QVariant();
}
QModelIndex VariablesTreeModel::index(int row, int column, const QModelIndex &parent) const
{
if (!hasIndex(row, column, parent))
return QModelIndex();
VariablesTreeItem *pParentVariablesTreeItem;
if (!parent.isValid())
pParentVariablesTreeItem = mpRootVariablesTreeItem;
else
pParentVariablesTreeItem = static_cast<VariablesTreeItem*>(parent.internalPointer());
VariablesTreeItem *pChildVariablesTreeItem = pParentVariablesTreeItem->child(row);
if (pChildVariablesTreeItem)
return createIndex(row, column, pChildVariablesTreeItem);
else
return QModelIndex();
}
QModelIndex VariablesTreeModel::parent(const QModelIndex &index) const
{
if (!index.isValid())
return QModelIndex();
VariablesTreeItem *pChildVariablesTreeItem = static_cast<VariablesTreeItem*>(index.internalPointer());
VariablesTreeItem *pParentVariablesTreeItem = pChildVariablesTreeItem->parent();
if (pParentVariablesTreeItem == mpRootVariablesTreeItem)
return QModelIndex();
return createIndex(pParentVariablesTreeItem->row(), 0, pParentVariablesTreeItem);
}
/*!
* \brief VariablesTreeModel::setData
* Updates the model data.
* \param index
* \param value
* \param role
* \return
*/
bool VariablesTreeModel::setData(const QModelIndex &index, const QVariant &value, int role)
{
VariablesTreeItem *pVariablesTreeItem = static_cast<VariablesTreeItem*>(index.internalPointer());
if (!pVariablesTreeItem) {
return false;
}
QString displayUnit = pVariablesTreeItem->getDisplayUnit();
bool result = pVariablesTreeItem->setData(index.column(), value, role);
if (index.column() == 0 && role == Qt::CheckStateRole) {
if (!signalsBlocked()) {
PlottingPage *pPlottingPage = OptionsDialog::instance()->getPlottingPage();
emit itemChecked(index, pPlottingPage->getCurveThickness(), pPlottingPage->getCurvePattern(), QApplication::keyboardModifiers().testFlag(Qt::ShiftModifier));
}
} else if (index.column() == 1) { // value
if (!signalsBlocked()) {
VariablesTreeItem *pVariablesRootTreeItem = pVariablesTreeItem->rootParent();
if (pVariablesRootTreeItem->getSimulationOptions().isInteractiveSimulation()) {
emit valueEntered(index);
}
}
} else if (index.column() == 3) { // display unit
if (!signalsBlocked() && displayUnit.compare(Utilities::convertSymbolToUnit(value.toString())) != 0) {
emit unitChanged(index);
}
}
updateVariablesTreeItem(pVariablesTreeItem);
return result;
}
QVariant VariablesTreeModel::data(const QModelIndex &index, int role) const
{
if (!index.isValid())
return QVariant();
VariablesTreeItem *pVariablesTreeItem = static_cast<VariablesTreeItem*>(index.internalPointer());
return pVariablesTreeItem->data(index.column(), role);
}
Qt::ItemFlags VariablesTreeModel::flags(const QModelIndex &index) const
{
if (!index.isValid()) {
return Qt::ItemFlags();
}
Qt::ItemFlags flags = Qt::ItemIsEnabled | Qt::ItemIsSelectable;
VariablesTreeItem *pVariablesTreeItem = static_cast<VariablesTreeItem*>(index.internalPointer());
if (((index.column() == 0 && pVariablesTreeItem && pVariablesTreeItem->mChildren.size() == 0) || pVariablesTreeItem->isMainArray())
&& pVariablesTreeItem->parent() != mpRootVariablesTreeItem) {
flags |= Qt::ItemIsUserCheckable;
// Disable string type since is not stored in the result file and we can't plot them
if (pVariablesTreeItem->isString()) {
flags &= ~Qt::ItemIsEnabled;
}
} else if (index.column() == 1 && pVariablesTreeItem && pVariablesTreeItem->mChildren.size() == 0 && pVariablesTreeItem->isEditable()) {
flags |= Qt::ItemIsEditable;
} else if (index.column() == 3) {
flags |= Qt::ItemIsEditable;
}
return flags;
}
VariablesTreeItem* VariablesTreeModel::findVariablesTreeItem(const QString &name, VariablesTreeItem *pVariablesTreeItem, Qt::CaseSensitivity caseSensitivity) const
{
if (pVariablesTreeItem->getVariableName().compare(name, caseSensitivity) == 0) {
return pVariablesTreeItem;
}
for (int i = pVariablesTreeItem->mChildren.size(); --i >= 0; ) {
if (VariablesTreeItem *item = findVariablesTreeItem(name, pVariablesTreeItem->mChildren.at(i), caseSensitivity)) {
return item;
}
}
return 0;
}
/*!
* \brief VariablesTreeModel::findVariablesTreeItemOneLevel
* Finds the VariablesTreeItem based on the name and case sensitivity only in the children of pVariablesTreeItem
* \param name
* \param pVariablesTreeItem
* \param caseSensitivity
* \return
*/
VariablesTreeItem* VariablesTreeModel::findVariablesTreeItemOneLevel(const QString &name, VariablesTreeItem *pVariablesTreeItem, Qt::CaseSensitivity caseSensitivity) const
{
if (!pVariablesTreeItem) {
pVariablesTreeItem = mpRootVariablesTreeItem;
}
for (int i = pVariablesTreeItem->mChildren.size(); --i >= 0; ) {
if (pVariablesTreeItem->mChildren.at(i)->getVariableName().compare(name, caseSensitivity) == 0) {
return pVariablesTreeItem->mChildren.at(i);
}
}
return 0;
}
/*!
* \brief VariablesTreeModel::updateVariablesTreeItem
* Triggers a view update for the VariablesTreeItem in the Variables Browser.
* \param pVariablesTreeItem
*/
void VariablesTreeModel::updateVariablesTreeItem(VariablesTreeItem *pVariablesTreeItem)
{
QModelIndex index = variablesTreeItemIndex(pVariablesTreeItem);
emit dataChanged(index, index);
}
QModelIndex VariablesTreeModel::variablesTreeItemIndex(const VariablesTreeItem *pVariablesTreeItem) const
{
return variablesTreeItemIndexHelper(pVariablesTreeItem, mpRootVariablesTreeItem, QModelIndex());
}
/*!
* \brief VariablesTreeModel::parseInitXml
* Parses the model_init.xml file and returns the scalar variables information.
* \param xmlReader
* \param variablesList
*/
void VariablesTreeModel::parseInitXml(QXmlStreamReader &xmlReader, QStringList* variablesList)
{
// if the variables list is empty then add the xml scalar variables to the list
bool addVariablesToList = variablesList->isEmpty();
/* We'll parse the XML until we reach end of it.*/
while (!xmlReader.atEnd() && !xmlReader.hasError()) {
/* Read next element.*/
QXmlStreamReader::TokenType token = xmlReader.readNext();
/* If token is just StartDocument, we'll go to next.*/
if (token == QXmlStreamReader::StartDocument) {
continue;
}
/* If token is StartElement, we'll see if we can read it.*/
if (token == QXmlStreamReader::StartElement) {
/* If it's named ScalarVariable, we'll dig the information from there.*/
if (xmlReader.name() == "ScalarVariable") {
QHash<QString, QString> scalarVariable = parseScalarVariable(xmlReader);
if (!scalarVariable.value("name").startsWith("$")) {
mScalarVariablesHash.insert(scalarVariable.value("name"),scalarVariable);
if (addVariablesToList) {
variablesList->append(scalarVariable.value("name"));
}
}
}
}
}
xmlReader.clear();
}
/*!
* \brief VariablesTreeModel::removeVariableTreeItem
* Removes the VariablesTreeItem.
* \param variable
* \return
*/
bool VariablesTreeModel::removeVariableTreeItem(QString variable)
{
VariablesTreeItem *pVariablesTreeItem = findVariablesTreeItem(variable, mpRootVariablesTreeItem);
if (pVariablesTreeItem) {
// if we are going to remove an active VariablesTreeItem then we should disable the visualization controls.
if (pVariablesTreeItem->isActive()) {
mpVariablesTreeView->getVariablesWidget()->enableVisualizationControls(false);
mpVariablesTreeView->getVariablesWidget()->rewindVisualization();
mpVariablesTreeView->getVariablesWidget()->closeResultFile();
}
beginRemoveRows(variablesTreeItemIndex(pVariablesTreeItem->parent()), 0, pVariablesTreeItem->mChildren.size());
pVariablesTreeItem->removeChildren();
VariablesTreeItem *pParentVariablesTreeItem = pVariablesTreeItem->parent();
pParentVariablesTreeItem->removeChild(pVariablesTreeItem);
if (pVariablesTreeItem->getSimulationOptions().isInteractiveSimulation()) {
// remove the right interactive simulation output widget
SimulationOutputWidget *pSimulationOutputWidget = MessagesWidget::instance()->getSimulationOutputWidget(pVariablesTreeItem->getFileName());
if (pSimulationOutputWidget) {
MainWindow::instance()->getSimulationDialog()->removeSimulationOutputWidget(pSimulationOutputWidget);
}
}
if (pVariablesTreeItem) {
delete pVariablesTreeItem;
}
endRemoveRows();
mpVariablesTreeView->getVariablesWidget()->findVariables();
return true;
}
return false;
}
/*!
* \brief VariablesTreeModel::insertVariablesItems
* Inserts the variables in the Variables Browser.
* \param fileName
* \param filePath
* \param variablesList
* \param simulationOptions
* \return
*/
bool VariablesTreeModel::insertVariablesItems(QString fileName, QString filePath, QStringList variablesList, SimulationOptions simulationOptions)
{
QString toolTip;
if (simulationOptions.isInteractiveSimulation()) {
toolTip = tr("Interactive Simulation\nPort: %1").arg(simulationOptions.getInteractiveSimulationPortNumber());
} else {
toolTip = tr("Simulation Result File: %1\n%2: %3/%4").arg(fileName).arg(Helper::fileLocation).arg(filePath).arg(fileName);
}
QRegExp resultTypeRegExp("(\\.mat|\\.plt|\\.csv|_res.mat|_res.plt|_res.csv)");
QString text = QString(fileName).remove(resultTypeRegExp);
QVector<QVariant> variabledata;
variabledata << filePath << fileName << fileName << text << "" << "" << "" << "" << QStringList() << "" << toolTip << false << QVariantList() << QVariantList() << QVariantList() << "dummy.json";
bool existingTopVariableTreeItem;
VariablesTreeItem *pTopVariablesTreeItem = findVariablesTreeItemOneLevel(variabledata.at(VariableItemData::NAME).toString(), mpRootVariablesTreeItem);
if (pTopVariablesTreeItem) {
pTopVariablesTreeItem->setVariableItemData(variabledata);
pTopVariablesTreeItem->setSimulationOptions(simulationOptions);
existingTopVariableTreeItem = true;
} else {
pTopVariablesTreeItem = new VariablesTreeItem(variabledata, mpRootVariablesTreeItem, true);
pTopVariablesTreeItem->setSimulationOptions(simulationOptions);
int row = rowCount();
QModelIndex index = variablesTreeItemIndex(mpRootVariablesTreeItem);
beginInsertRows(index, row, row);
mpRootVariablesTreeItem->insertChild(row, pTopVariablesTreeItem);
endInsertRows();
existingTopVariableTreeItem = false;
}
// set the newly inserted VariablesTreeItem active
mpActiveVariablesTreeItem = pTopVariablesTreeItem;
if (simulationOptions.isValid() && !simulationOptions.isInteractiveSimulation()) {
pTopVariablesTreeItem->setActive();
}
/* open the model_init.xml file for reading */
mScalarVariablesHash.clear();
QString initFileName, infoFileName;
if (simulationOptions.isValid()) {
initFileName = QString("%1_init.xml").arg(simulationOptions.getOutputFileName());
infoFileName = QString("%1_info.json").arg(simulationOptions.getOutputFileName());
} else {
initFileName = QString("%1_init.xml").arg(text);
infoFileName = QString("%1_info.json").arg(text);
}
QFile initFile(QString("%1%2%3").arg(filePath, QDir::separator(), initFileName));
if (initFile.exists()) {
if (initFile.open(QIODevice::ReadOnly)) {
QXmlStreamReader initXmlReader(&initFile);
parseInitXml(initXmlReader, &variablesList);
initFile.close();
} else {
MessagesWidget::instance()->addGUIMessage(MessageItem(MessageItem::Modelica, GUIMessages::getMessage(GUIMessages::ERROR_OPENING_FILE).arg(initFile.fileName())
.arg(initFile.errorString()), Helper::scriptingKind, Helper::errorLevel));
}
}
QMap<QString,QSet<QString>> usedInitialVars;
QMap<QString,QSet<QString>> usedVars;
QMap<QString,QList<IntStringPair>> definedIn;
JsonDocument jsonDocument;
if (jsonDocument.parse(QString("%1%2%3").arg(filePath, QDir::separator(), infoFileName))) {
QVariantMap result = jsonDocument.result.toMap();
QVariantList eqs = result["equations"].toList();
for (int i=0; i<eqs.size(); i++) {
QVariantMap veq = eqs[i].toMap();
bool isInitial = (veq.find("section") != veq.end() && veq["section"] == QString("initial"));
if (veq.find("defines") != veq.end()) {
QStringList defines = Utilities::variantListToStringList(veq["defines"].toList());
foreach (QString v1, defines) {
if (!definedIn.contains(v1)) {
definedIn[v1] = QList<IntStringPair>();
}
definedIn[v1] << IntStringPair(veq["eqIndex"].toInt(), veq.find("section") != veq.end() ? veq["section"].toString() : QString("unknown"));
if (veq.find("uses") != veq.end()) {
QStringList uses = Utilities::variantListToStringList(veq["uses"].toList());
foreach (QString v2, uses) {
if (isInitial) {
usedInitialVars[v1].insert(v2);
} else {
usedVars[v1].insert(v2);
}
}
}
}
}
}
} else {
MessagesWidget::instance()->addGUIMessage(MessageItem(MessageItem::Modelica, jsonDocument.errorString, Helper::scriptingKind, Helper::errorLevel));
MainWindow::instance()->printStandardOutAndErrorFilesMessages();
}
/* open the .mat file */
ModelicaMatReader matReader;
matReader.file = 0;
const char *msg[] = {""};
if (fileName.endsWith(".mat")) {
//Read in mat file
if (0 != (msg[0] = omc_new_matlab4_reader(QString(filePath + "/" + fileName).toUtf8().constData(), &matReader))) {
MessagesWidget::instance()->addGUIMessage(MessageItem(MessageItem::Modelica, GUIMessages::getMessage(GUIMessages::ERROR_OPENING_FILE).arg(filePath + "/" + fileName)
.arg(QString(msg[0])), Helper::scriptingKind, Helper::errorLevel));
}
}
// create hash based VariableNode
VariableNode *pTopVariableNode = new VariableNode(variabledata);
// sort the variables using natural sort
std::sort(variablesList.begin(), variablesList.end(), StringHandler::naturalSortForResultVariables);
// remove time from variables list
variablesList.removeOne("time");
/* Fixes issue #7551
* Add the $cpuTime variable to the list if cpu time flag is set.
* We read the variables from model_init.xml file that doesn't contain $cpuTime variable but is present in model_res.mat file.
*/
if (simulationOptions.isValid() && simulationOptions.getCPUTime()) {
variablesList.append("$cpuTime");
}
QStringList variables;
foreach (QString plotVariable, variablesList) {
QString parentVariable = "";
if (plotVariable.startsWith("der(")) {
QString str = plotVariable;
str.chop((str.lastIndexOf("der(")/4)+1);
variables = StringHandler::makeVariablePartsWithInd(str.mid(str.lastIndexOf("der(") + 4));
} else if (plotVariable.startsWith("previous(")) {
QString str = plotVariable;
str.chop((str.lastIndexOf("previous(")/9)+1);
variables = StringHandler::makeVariablePartsWithInd(str.mid(str.lastIndexOf("previous(") + 9));
} else {
variables = StringHandler::makeVariablePartsWithInd(plotVariable);
}
int count = 1;
VariableNode *pParentVariableNode = 0;
foreach (QString variable, variables) {
if (count == 1) { /* first loop iteration */
pParentVariableNode = pTopVariableNode;
}
QString findVariable;
/* if last item of derivative */
if ((variables.size() == count) && (plotVariable.startsWith("der("))) {
if (parentVariable.isEmpty()) {
findVariable = QString("%1.%2").arg(fileName ,StringHandler::joinDerivativeAndPreviousVariable(plotVariable, variable, "der("));
} else {
findVariable = QString("%1.%2").arg(fileName ,StringHandler::joinDerivativeAndPreviousVariable(plotVariable, parentVariable, "der("));
}
} else if ((variables.size() == count) && (plotVariable.startsWith("previous("))) { /* if last item of previous */
if (parentVariable.isEmpty()) {
findVariable = QString("%1.%2").arg(fileName ,StringHandler::joinDerivativeAndPreviousVariable(plotVariable, variable, "previous("));
} else {
findVariable = QString("%1.%2").arg(fileName ,StringHandler::joinDerivativeAndPreviousVariable(plotVariable, parentVariable, "previous("));
}
} else {
if (parentVariable.isEmpty()) {
findVariable = QString("%1.%2").arg(fileName, variable);
} else {
findVariable = QString("%1.%2.%3").arg(fileName, parentVariable, variable);
}
}
// if its the last item then don't try to find the item as we will always fail to find it
if (variables.size() != count) {
pParentVariableNode = VariableNode::findVariableNode(findVariable, pParentVariableNode);
if (pParentVariableNode) {
QString addVar = "";
/* if last item of derivative */
if ((variables.size() == count) && (plotVariable.startsWith("der("))) {
addVar = StringHandler::joinDerivativeAndPreviousVariable(plotVariable, variable, "der(");
} else if ((variables.size() == count) && (plotVariable.startsWith("previous("))) { /* if last item of previous */
addVar = StringHandler::joinDerivativeAndPreviousVariable(plotVariable, variable, "previous(");
} else {
addVar = variable;
}
if (count == 1) {
parentVariable = addVar;
} else {
parentVariable += "." + addVar;
}
count++;
continue;
}
}
/* If pParentVariablesTreeItem is 0 and it is first loop iteration then use pTopVariablesTreeItem as parent.
* If loop iteration is not first and pParentVariablesTreeItem is 0 then find the parent item.
*/
if (!pParentVariableNode && count > 1) {
pParentVariableNode = VariableNode::findVariableNode(fileName + "." + parentVariable, pTopVariableNode);
}
// Just make sure parent is not NULL
if (!pParentVariableNode) {
pParentVariableNode = pTopVariableNode;
}
// data
QVector<QVariant> variableData;
/* if last item of derivative */
if ((variables.size() == count) && (plotVariable.startsWith("der("))) {
variableData << filePath << fileName << fileName + "." + plotVariable << StringHandler::joinDerivativeAndPreviousVariable(plotVariable, variable, "der(");
} else if ((variables.size() == count) && (plotVariable.startsWith("previous("))) { /* if last item of previous */
variableData << filePath << fileName << fileName + "." + plotVariable << StringHandler::joinDerivativeAndPreviousVariable(plotVariable, variable, "previous(");
} else if (variables.size() == count && QRegExp("\\[\\d+\\]").exactMatch(variable)) { /* if last item of array derivative*/
variableData << filePath << fileName << fileName + "." + plotVariable << variable;
} else {
variableData << filePath << fileName << pParentVariableNode->mVariableNodeData.at(VariableItemData::NAME).toString() + "." + variable << variable;
}
/* find the variable in the xml file */
QString variableToFind = variableData.at(VariableItemData::NAME).toString();
variableToFind.remove(QRegExp(pTopVariablesTreeItem->getVariableName() + "."));
/* get the variable information i.e value, unit, displayunit, description */
QString type, value, variability, unit, displayUnit, description;
bool changeAble = false;
getVariableInformation(&matReader, variableToFind, &type, &value, &changeAble, &variability, &unit, &displayUnit, &description);
/* set the variable type and value */
variableData << type << StringHandler::unparse(QString("\"").append(value).append("\""));
/* set the variable unit */
variableData << StringHandler::unparse(QString("\"").append(unit).append("\""));
/* set the variable displayUnit */
variableData << StringHandler::unparse(QString("\"").append(displayUnit).append("\""));
/* set the variable displayUnits */
if ((variableData.at(VariableItemData::TYPE).toString().compare(QStringLiteral("String")) != 0) && !variableData.at(VariableItemData::UNIT).toString().isEmpty()) {
QStringList displayUnits, displayUnitOptions;
displayUnits << variableData.at(VariableItemData::UNIT).toString();
if (!variableData.at(VariableItemData::DISPLAYUNIT).toString().isEmpty()) {
displayUnitOptions << variableData.at(VariableItemData::DISPLAYUNIT).toString();
/* convert value to displayUnit */
OMCInterface::convertUnits_res convertUnit = MainWindow::instance()->getOMCProxy()->convertUnits(variableData.at(VariableItemData::UNIT).toString(),
variableData.at(VariableItemData::DISPLAYUNIT).toString());
if (convertUnit.unitsCompatible) {
bool ok = true;
qreal realValue = variableData.at(VariableItemData::VALUE).toDouble(&ok);
if (ok) {
realValue = Utilities::convertUnit(realValue, convertUnit.offset, convertUnit.scaleFactor);
variableData[VariableItemData::VALUE] = StringHandler::number(realValue);
}
}
} else { /* use unit as displayUnit */
variableData[VariableItemData::DISPLAYUNIT] = variableData.at(VariableItemData::UNIT);
}
displayUnits << displayUnitOptions;
variableData << displayUnits;
} else {
variableData << QStringList();
}
/* set the variable description */
variableData << StringHandler::unparse(QString("\"").append(description).append("\""));
/* construct tooltip text */
if (simulationOptions.isInteractiveSimulation()) {
variableData << tr("Variable: %1\nVariability: %2").arg(variableToFind).arg(variability);
} else {
variableData << tr("File: %1/%2\nVariable: %3\nVariability: %4").arg(filePath).arg(fileName).arg(variableToFind).arg(variability);
}
/*is main array*/
if (variables.size() == count+1 && QRegExp("\\[\\d+\\]").exactMatch(variables.last())) {
variableData << true;
} else {
variableData << false;
}
QString findVariableNoFileName = findVariable.right(findVariable.size()-fileName.size()-1);
if (usedVars.find(findVariableNoFileName) != usedVars.end()) {
QStringList lst = QStringList(usedVars[findVariableNoFileName].values());
lst << findVariableNoFileName;
variableData << lst;
} else {
variableData << QStringList(findVariableNoFileName);
}
if (usedInitialVars.find(findVariableNoFileName) != usedInitialVars.end()) {
QStringList lst = QStringList(usedInitialVars[findVariableNoFileName].values());
lst << findVariableNoFileName;
variableData << lst;
} else {
variableData << QStringList(findVariableNoFileName);
}
QVariantList variantDefinedIn;
if (definedIn.find(findVariableNoFileName) != definedIn.end()) {
foreach (IntStringPair pair, definedIn[findVariableNoFileName]) {
variantDefinedIn << QVariant::fromValue(pair);
}
} else {
variantDefinedIn << QVariant::fromValue(IntStringPair(0,QString("")));
}
variableData << variantDefinedIn;
variableData << infoFileName;
VariableNode *pVariableNode = new VariableNode(variableData);
pVariableNode->mEditable = changeAble;
pVariableNode->mVariability = variability;
pParentVariableNode->mChildren.insert(variableData.at(VariableItemData::NAME).toString(), pVariableNode);
pParentVariableNode = pVariableNode;
QString addVar = "";
/* if last item of derivative */
if ((variables.size() == count) && (plotVariable.startsWith("der("))) {
addVar = StringHandler::joinDerivativeAndPreviousVariable(plotVariable, variable, "der(");
} else if ((variables.size() == count) && (plotVariable.startsWith("previous("))) { /* if last item of previous */
addVar = StringHandler::joinDerivativeAndPreviousVariable(plotVariable, variable, "previous(");
} else {
addVar = variable;
}
if (count == 1) {
parentVariable = addVar;
} else {
parentVariable += "." + addVar;
}
count++;
}
}
// remove VariablesTreeItems only when result already exists
if (existingTopVariableTreeItem) {
filterVariableTreeItem(pTopVariableNode, pTopVariablesTreeItem);
}
// insert variables to VariablesTreeModel
insertVariablesItems(pTopVariableNode, pTopVariablesTreeItem);
// Delete VariableNode
delete pTopVariableNode;
/* close the .mat file */
if (fileName.endsWith(".mat") && matReader.file) {
omc_free_matlab4_reader(&matReader);
}
/* Ticket #3016.
* If you only have one model the message "You must select a class to re-simulate" is annoying.
* A default behavior of selecting the (single) model would be good.
* The following line selects the result tree top level item.
*/
QModelIndex idx = variablesTreeItemIndex(pTopVariablesTreeItem);
idx = mpVariablesTreeView->getVariablesWidget()->getVariableTreeProxyModel()->mapFromSource(idx);
mpVariablesTreeView->expand(idx);
mpVariablesTreeView->setCurrentIndex(idx);
mpVariablesTreeView->setFocus(Qt::ActiveWindowFocusReason);
MainWindow::instance()->enableReSimulationToolbar(MainWindow::instance()->getVariablesDockWidget()->isVisible());
return existingTopVariableTreeItem;
}
void VariablesTreeModel::unCheckVariables(VariablesTreeItem *pVariablesTreeItem)
{
QList<VariablesTreeItem*> items = pVariablesTreeItem->mChildren;
for (int i = 0 ; i < items.size() ; i++) {
items[i]->setData(0, Qt::Unchecked, Qt::CheckStateRole);
unCheckVariables(items[i]);
}
}
void VariablesTreeModel::plotAllVariables(VariablesTreeItem *pVariablesTreeItem, PlotWindow *pPlotWindow)
{
QList<VariablesTreeItem*> variablesTreeItems = pVariablesTreeItem->mChildren;
if (variablesTreeItems.size() == 0) {
QModelIndex index = variablesTreeItemIndex(pVariablesTreeItem);
OMPlot::PlotCurve *pPlotCurve = 0;
foreach (OMPlot::PlotCurve *curve, pPlotWindow->getPlot()->getPlotCurvesList()) {
if (curve->getNameStructure().compare(pVariablesTreeItem->getVariableName()) == 0) {
pPlotCurve = curve;
break;
}
}
setData(index, Qt::Checked, Qt::CheckStateRole);
mpVariablesTreeView->getVariablesWidget()->plotVariables(index, pPlotWindow->getCurveWidth(), pPlotWindow->getCurveStyle(), false, pPlotCurve);
} else {
for (int i = 0 ; i < variablesTreeItems.size() ; i++) {
plotAllVariables(variablesTreeItems[i], pPlotWindow);
}
}
}
/*!
* \brief VariablesTreeModel::variablesTreeItemIndexHelper
* Helper function for VariablesTreeModel::variablesTreeItem()
* \param pVariablesTreeItem
* \param pParentVariablesTreeItem
* \param parentIndex
* \return
*/
QModelIndex VariablesTreeModel::variablesTreeItemIndexHelper(const VariablesTreeItem *pVariablesTreeItem, const VariablesTreeItem *pParentVariablesTreeItem,
const QModelIndex &parentIndex) const
{