-
Notifications
You must be signed in to change notification settings - Fork 298
/
ElementProperties.cpp
1929 lines (1859 loc) · 83.2 KB
/
ElementProperties.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 "ElementProperties.h"
#include "MainWindow.h"
#include "Modeling/MessagesWidget.h"
#include "Modeling/Commands.h"
#include "Options/OptionsDialog.h"
#include <QApplication>
#include <QMenu>
#include <QWidgetAction>
#include <QButtonGroup>
#include <QMessageBox>
#include <QDesktopServices>
#include <QDesktopWidget>
#include <QList>
#include <QStringList>
/*!
* \class Parameter
* \brief Defines one parameter. Creates name, value, unit and comment GUI controls.
*/
/*!
* \brief Parameter::Parameter
* \param pComponent
* \param showStartAttribute
* \param tab
* \param groupBox
*/
Parameter::Parameter(Element *pComponent, bool showStartAttribute, QString tab, QString groupBox)
{
mpComponent = pComponent;
mTab = tab;
mGroupBox = groupBox;
mShowStartAttribute = showStartAttribute;
mpNameLabel = new Label;
mpFixedCheckBox = new FixedCheckBox;
connect(mpFixedCheckBox, SIGNAL(clicked()), SLOT(showFixedMenu()));
setFixedState("false", true);
// set the value type based on component type.
OMCProxy *pOMCProxy = MainWindow::instance()->getOMCProxy();
if (mpComponent->getComponentInfo()->getClassName().compare("Boolean") == 0) {
if (mpComponent->getChoicesAnnotation().size() > 1 && /* Size should be 2. We always get choices(checkBox, __Dymola_checkBox) */
(mpComponent->getChoicesAnnotation().at(0).compare("true") == 0 || mpComponent->getChoicesAnnotation().at(1).compare("true") == 0)) {
mValueType = Parameter::CheckBox;
} else {
mValueType = Parameter::Boolean;
}
} else if (pOMCProxy->isBuiltinType(mpComponent->getComponentInfo()->getClassName())) {
mValueType = Parameter::Normal;
} else if (pOMCProxy->isWhat(StringHandler::Enumeration, mpComponent->getComponentInfo()->getClassName())) {
mValueType = Parameter::Enumeration;
} else if (OptionsDialog::instance()->getGeneralSettingsPage()->getReplaceableSupport() && mpComponent->getComponentInfo()->getReplaceable()) { // replaceable component or short element definition
mValueType = mpComponent->getComponentInfo()->getIsElement() ? Parameter::ReplaceableClass : Parameter::ReplaceableComponent;
} else if (OptionsDialog::instance()->getGeneralSettingsPage()->getReplaceableSupport() && mpComponent->getComponentInfo()->getIsElement()) { // non replaceable short element definition
mValueType = Parameter::ReplaceableClass;
} else {
mValueType = Parameter::Normal;
}
mValueCheckBoxModified = false;
mDefaultValue = "";
mpFileSelectorButton = new QToolButton;
mpFileSelectorButton->setText("...");
mpFileSelectorButton->setToolButtonStyle(Qt::ToolButtonTextOnly);
connect(mpFileSelectorButton, SIGNAL(clicked()), SLOT(fileSelectorButtonClicked()));
setLoadSelectorFilter("-");
setLoadSelectorCaption("-");
setSaveSelectorFilter("-");
setSaveSelectorCaption("-");
createValueWidget();
// Get unit value
QString unit = mpComponent->getDerivedClassModifierValue("unit");
mUnit = unit;
// Get displayUnit value
QString displayUnit = mpComponent->getDerivedClassModifierValue("displayUnit");
if (displayUnit.isEmpty()) {
displayUnit = unit;
}
mDisplayUnit = StringHandler::removeFirstLastQuotes(displayUnit);
mPreviousUnit = mDisplayUnit;
mpUnitComboBox = new QComboBox;
if (!mUnit.isEmpty()) {
mpUnitComboBox->addItem(mUnit);
if (mDisplayUnit.compare(mUnit) != 0) {
mpUnitComboBox->addItem(mDisplayUnit);
mpUnitComboBox->setCurrentIndex(1);
}
}
connect(mpUnitComboBox, SIGNAL(currentIndexChanged(QString)), SLOT(unitComboBoxChanged(QString)));
mpCommentLabel = new Label(mpComponent->getComponentInfo()->getComment());
}
/*!
* \brief Parameter::updateNameLabel
* Updates the name label.
*/
void Parameter::updateNameLabel()
{
mpNameLabel->setText(mpComponent->getName() + (mShowStartAttribute ? ".start" : ""));
}
/*!
* \brief Parameter::setValueWidget
* Sets the value and defaultValue for the parameter.
* \param value
* \param defaultValue
* \param fromUnit
* \param valueModified
* \param adjustSize
* \param unitComboBoxChanged
*/
void Parameter::setValueWidget(QString value, bool defaultValue, QString fromUnit, bool valueModified, bool adjustSize, bool unitComboBoxChanged)
{
/* ticket:5618 if we don't have a literal constant and array of constants
* then we assume its an expression and don't do any conversions.
* So just show the unit in the unit drop down list
*/
if (!unitComboBoxChanged) {
enableDisableUnitComboBox(value);
}
if (Utilities::isValueLiteralConstant(value)) {
// convert the value to display unit
if (!fromUnit.isEmpty() && mpUnitComboBox->currentText().compare(fromUnit) != 0) {
bool ok = true;
qreal realValue = value.toDouble(&ok);
// if the modifier is a literal constant
if (ok) {
OMCProxy *pOMCProxy = MainWindow::instance()->getOMCProxy();
OMCInterface::convertUnits_res convertUnit = pOMCProxy->convertUnits(fromUnit, mpUnitComboBox->currentText());
if (convertUnit.unitsCompatible) {
realValue = Utilities::convertUnit(realValue, convertUnit.offset, convertUnit.scaleFactor);
value = StringHandler::number(realValue);
}
} else { // if expression
value = Utilities::arrayExpressionUnitConversion(MainWindow::instance()->getOMCProxy(), value, fromUnit, mpUnitComboBox->currentText());
}
}
}
if (defaultValue) {
mDefaultValue = value;
}
QFontMetrics fm = QFontMetrics(QFont());
switch (mValueType) {
case Parameter::Boolean:
case Parameter::Enumeration:
case Parameter::ReplaceableClass:
case Parameter::ReplaceableComponent:
if (defaultValue) {
mpValueComboBox->lineEdit()->setPlaceholderText(value);
} else {
// update the value combobox index when setting the value on the line edit
bool state = mpValueComboBox->blockSignals(true);
int index = mpValueComboBox->findData(value);
if (index > -1) {
mpValueComboBox->setCurrentIndex(index);
} else { // if we fail to find the value in the combobox then add it to the combobox
mpValueComboBox->insertItem(1, value, value);
}
mpValueComboBox->lineEdit()->setText(value);
mpValueComboBox->lineEdit()->setModified(valueModified);
mpValueComboBox->blockSignals(state);
}
if (adjustSize) {
/* Set the minimum width so that the value text will be readable.
* If the items width is greater than the value text than use it.
*/
fm = QFontMetrics(mpValueComboBox->lineEdit()->font());
mpValueComboBox->setMinimumWidth(qMax(fm.width(value), mpValueComboBox->minimumSizeHint().width()) + 50);
}
break;
case Parameter::CheckBox:
mpValueCheckBox->setChecked(value.compare("true") == 0);
break;
case Parameter::Normal:
default:
if (defaultValue) {
mpValueTextBox->setPlaceholderText(value);
} else {
mpValueTextBox->setText(value);
mpValueTextBox->setModified(valueModified);
}
if (adjustSize) {
/* Set the minimum width so that the value text will be readable */
fm = QFontMetrics(mpValueTextBox->font());
mpValueTextBox->setMinimumWidth(fm.width(value) + 50);
}
mpValueTextBox->setCursorPosition(0); /* move the cursor to start so that parameter value will show up from start instead of end. */
break;
}
}
QWidget* Parameter::getValueWidget()
{
switch (mValueType) {
case Parameter::Boolean:
case Parameter::Enumeration:
case Parameter::ReplaceableClass:
case Parameter::ReplaceableComponent:
return mpValueComboBox;
case Parameter::CheckBox:
return mpValueCheckBox;
case Parameter::Normal:
default:
return mpValueTextBox;
}
}
/*!
* \brief Parameter::isValueModified
* Returns true if value widget is changed.
* \return
*/
bool Parameter::isValueModified()
{
switch (mValueType) {
case Parameter::Boolean:
case Parameter::Enumeration:
case Parameter::ReplaceableClass:
case Parameter::ReplaceableComponent:
return mpValueComboBox->lineEdit()->isModified();
case Parameter::CheckBox:
return mValueCheckBoxModified;
case Parameter::Normal:
default:
return mpValueTextBox->isModified();
}
}
/*!
* \brief Parameter::getValue
* Returns the value.
* \return
*/
QString Parameter::getValue()
{
switch (mValueType) {
case Parameter::Boolean:
case Parameter::Enumeration:
case Parameter::ReplaceableClass:
case Parameter::ReplaceableComponent:
return mpValueComboBox->lineEdit()->text().trimmed();
case Parameter::CheckBox:
return mpValueCheckBox->isChecked() ? "true" : "false";
case Parameter::Normal:
default:
return mpValueTextBox->text().trimmed();
}
}
void Parameter::setFixedState(QString fixed, bool defaultValue)
{
mOriginalFixedValue = fixed;
if (fixed.compare("true") == 0) {
mpFixedCheckBox->setTickState(defaultValue, true);
} else {
mpFixedCheckBox->setTickState(defaultValue, false);
}
}
QString Parameter::getFixedState()
{
return mpFixedCheckBox->tickStateString();
}
/*!
Sets the input field of the parameter enable/disable.
\param enable
*/
void Parameter::setEnabled(bool enable)
{
switch (mValueType) {
case Parameter::Boolean:
case Parameter::Enumeration:
case Parameter::ReplaceableComponent:
case Parameter::ReplaceableClass:
mpValueComboBox->setEnabled(enable);
break;
case Parameter::CheckBox:
mpValueCheckBox->setEnabled(enable);
break;
case Parameter::Normal:
default:
mpValueTextBox->setEnabled(enable);
break;
}
}
void Parameter::createValueWidget()
{
int i;
OMCProxy *pOMCProxy = MainWindow::instance()->getOMCProxy();
QString className = mpComponent->getComponentInfo()->getClassName();
QString constrainedByClassName = QStringLiteral("$Any");
QString replaceable = "", replaceableText = "", replaceableChoice = "", parentClassName = "";
QStringList enumerationLiterals, replaceableChoices;
switch (mValueType) {
case Parameter::Boolean:
mpValueComboBox = new QComboBox;
mpValueComboBox->setEditable(true);
mpValueComboBox->addItem("", "");
mpValueComboBox->addItem("true", "true");
mpValueComboBox->addItem("false", "false");
connect(mpValueComboBox, SIGNAL(currentIndexChanged(int)), SLOT(valueComboBoxChanged(int)));
break;
case Parameter::Enumeration:
mpValueComboBox = new QComboBox;
mpValueComboBox->setEditable(true);
mpValueComboBox->addItem("", "");
enumerationLiterals = pOMCProxy->getEnumerationLiterals(className);
for (i = 0 ; i < enumerationLiterals.size(); i++) {
mpValueComboBox->addItem(enumerationLiterals[i], className + "." + enumerationLiterals[i]);
}
connect(mpValueComboBox, SIGNAL(currentIndexChanged(int)), SLOT(valueComboBoxChanged(int)));
break;
case Parameter::CheckBox:
mpValueCheckBox = new QCheckBox;
connect(mpValueCheckBox, SIGNAL(toggled(bool)), SLOT(valueCheckBoxChanged(bool)));
break;
case Parameter::ReplaceableComponent:
case Parameter::ReplaceableClass:
constrainedByClassName = mpComponent->getComponentInfo()->getConstrainedByClassName();
mpValueComboBox = new QComboBox;
mpValueComboBox->setEditable(true);
mpValueComboBox->addItem("", "");
if (constrainedByClassName.contains(QStringLiteral("$Any"))) {
constrainedByClassName = className;
}
parentClassName = mpComponent->getComponentInfo()->getParentClassName();
replaceableChoices = pOMCProxy->getAllSubtypeOf(constrainedByClassName, parentClassName);
for (i = 0 ; i < replaceableChoices.size(); i++) {
replaceableChoice = replaceableChoices[i];
// if replaceableChoices points to a class in this scope, remove scope
if (replaceableChoice.startsWith(parentClassName + "."))
{
replaceableChoice.remove(0, parentClassName.size() + 1);
}
if (mValueType == Parameter::ReplaceableClass) {
replaceable = QString("redeclare %1 %2 = %3").arg(mpComponent->getComponentInfo()->getRestriction(), mpComponent->getName(), replaceableChoice);
QString str = (pOMCProxy->getClassInformation(replaceableChoices[i])).comment;
if (!str.isEmpty()) {
str = " - " + str;
}
replaceableText = replaceableChoices[i] + str;
mpValueComboBox->addItem(replaceableText, replaceable);
} else {
replaceable = QString("redeclare %1 %2").arg(replaceableChoice, mpComponent->getName());
mpValueComboBox->addItem(replaceable, replaceable);
}
}
connect(mpValueComboBox, SIGNAL(currentIndexChanged(int)), SLOT(valueComboBoxChanged(int)));
break;
case Parameter::Normal:
default:
mpValueTextBox = new QLineEdit;
connect(mpValueTextBox, SIGNAL(textEdited(QString)), SLOT(valueTextBoxEdited(QString)));
break;
}
}
/*!
* \brief Parameter::enableDisableUnitComboBox
* Enables/disables the unit combobox.
* \param value
*/
void Parameter::enableDisableUnitComboBox(const QString &value)
{
/* Enable/disable the unit combobox based on the literalConstant
* Set the display unit as current when value is literalConstant otherwise use unit
* ticket:5618 Disable the unit drop down when we have a symbolic parameter
*/
bool literalConstant = Utilities::isValueLiteralConstant(value);
mpUnitComboBox->setEnabled(literalConstant);
/* ticket:5976 don't change the unit combobox when the literalConstant is true
* We only want to disbale and switch to display unit when literalConstant is false and we got a symbolic or expression parameter.
*/
if (!literalConstant) {
bool state = mpUnitComboBox->blockSignals(true);
int index = mpUnitComboBox->findText(literalConstant ? mDisplayUnit : mUnit, Qt::MatchExactly);
if (index > -1 && index != mpUnitComboBox->currentIndex()) {
mpUnitComboBox->setCurrentIndex(index);
mPreviousUnit = mpUnitComboBox->currentText();
}
mpUnitComboBox->blockSignals(state);
}
}
/*!
* \brief Parameter::fileSelectorButtonClicked
* Slot activated when mpFileSelectorButton clicked SIGNAL is raised.
* Opens a QFileDialog::getOpenFileName or QFileDialog::getSaveFileName so user can select a file.
*/
void Parameter::fileSelectorButtonClicked()
{
QString filter, caption = "";
QString fileName;
/* saveSelector is given precedence if present.
* There is nothing about it in the specification but we do so to keep consistant with Dymola.
*/
if (mSaveSelectorFilter.compare("-") != 0 && mSaveSelectorCaption.compare("-") != 0) {
if (mSaveSelectorFilter.compare("-") != 0) {
filter = mSaveSelectorFilter;
}
caption = tr("Save");
if (mSaveSelectorCaption.compare("-") != 0) {
caption = mSaveSelectorCaption;
}
fileName = StringHandler::getSaveFileName(MainWindow::instance(), caption, NULL, filter, NULL);
} else {
filter = "";
if (mLoadSelectorFilter.compare("-") != 0) {
filter = mLoadSelectorFilter;
}
caption = tr("Load");
if (mLoadSelectorCaption.compare("-") != 0) {
caption = mLoadSelectorCaption;
}
fileName = StringHandler::getOpenFileName(MainWindow::instance(), caption, NULL, filter, NULL);
}
// if user press ESC
if (fileName.isEmpty()) {
return;
}
setValueWidget(QString("\"%1\"").arg(fileName), false, mUnit, true, false);
}
/*!
* \brief Parameter::unitComboBoxChanged
* SLOT activated when mpUnitComboBox currentIndexChanged(QString) SIGNAL is raised.\n
* Updates the value according to the unit selected.
* \param text
*/
void Parameter::unitComboBoxChanged(QString text)
{
if (!mDefaultValue.isEmpty()) {
setValueWidget(mDefaultValue, true, mPreviousUnit, false, true, true);
}
QString value = getValue();
if (!value.isEmpty()) {
setValueWidget(value, false, mPreviousUnit, true, true, true);
}
mPreviousUnit = text;
}
/*!
* \brief Parameter::valueComboBoxChanged
* SLOT activated when mpValueComboBox currentIndexChanged(int) SIGNAL is raised.\n
* Updates the value according to the value selected.
* \param index
*/
void Parameter::valueComboBoxChanged(int index)
{
mpValueComboBox->lineEdit()->setText(mpValueComboBox->itemData(index).toString());
mpValueComboBox->lineEdit()->setModified(true);
}
/*!
* \brief Parameter::valueCheckBoxChanged
* SLOT activated when mpValueCheckBox toggled(bool) SIGNAL is raised.\n
* Marks the item modified.
* \param toggle
*/
void Parameter::valueCheckBoxChanged(bool toggle)
{
Q_UNUSED(toggle);
mValueCheckBoxModified = true;
}
/*!
* \brief Parameter::valueTextBoxEdited
* This slot is only called when user manually edits the text.\n
* \param text
*/
void Parameter::valueTextBoxEdited(const QString &text)
{
// if we don't have the text we use the default value otherwise the text
QString value;
if (text.isEmpty()) {
value = mDefaultValue;
} else {
value = text;
}
enableDisableUnitComboBox(value);
}
void Parameter::showFixedMenu()
{
// create a menu
QMenu menu;
Label *pTitleLabel = new Label("Fixed");
QWidgetAction *pTitleAction = new QWidgetAction(&menu);
pTitleAction->setDefaultWidget(pTitleLabel);
menu.addAction(pTitleAction);
// fixed action group
QActionGroup *pFixedActionGroup = new QActionGroup(this);
pFixedActionGroup->setExclusive(false);
// true case action
QString trueText = tr("true: start-value is used to initialize");
QAction *pTrueAction = new QAction(trueText, pFixedActionGroup);
pTrueAction->setCheckable(true);
connect(pTrueAction, SIGNAL(triggered()), SLOT(trueFixedClicked()));
menu.addAction(pTrueAction);
// false case action
QString falseText = tr("false: start-value is only a guess-value");
QAction *pFalseAction = new QAction(falseText, pFixedActionGroup);
pFalseAction->setCheckable(true);
connect(pFalseAction, SIGNAL(triggered()), SLOT(falseFixedClicked()));
menu.addAction(pFalseAction);
// inherited case action
QString inheritedText = tr("inherited: (%1)").arg(mpFixedCheckBox->tickState() ? trueText : falseText);
QAction *pInheritedAction = new QAction(inheritedText, pFixedActionGroup);
pInheritedAction->setCheckable(true);
connect(pInheritedAction, SIGNAL(triggered()), SLOT(inheritedFixedClicked()));
menu.addAction(pInheritedAction);
// set the menu actions states
if (mpFixedCheckBox->tickStateString().compare("true") == 0) {
pTrueAction->setChecked(true);
} else if (mpFixedCheckBox->tickStateString().compare("false") == 0) {
pFalseAction->setChecked(true);
} else {
pInheritedAction->setChecked(true);
}
// show the menu
menu.exec(mpFixedCheckBox->mapToGlobal(QPoint(0, 0)));
}
void Parameter::trueFixedClicked()
{
mpFixedCheckBox->setTickState(false, true);
}
void Parameter::falseFixedClicked()
{
mpFixedCheckBox->setTickState(false, false);
}
void Parameter::inheritedFixedClicked()
{
mpFixedCheckBox->setTickState(true, true);
}
/*!
\class GroupBox
\brief Creates a group for parameters.
*/
GroupBox::GroupBox(const QString &title, QWidget *parent)
: QGroupBox(title, parent)
{
mpGroupImageLabel = new Label;
mpGridLayout = new QGridLayout;
mpGridLayout->setObjectName(title);
mpGridLayout->setAlignment(Qt::AlignTop | Qt::AlignLeft);
mpHorizontalLayout = new QHBoxLayout;
mpHorizontalLayout->setAlignment(Qt::AlignTop | Qt::AlignLeft);
mpHorizontalLayout->addLayout(mpGridLayout, 1);
mpHorizontalLayout->addWidget(mpGroupImageLabel, 0, Qt::AlignRight);
setLayout(mpHorizontalLayout);
}
/*!
Sets the group image.
\param groupImage - the absolute path of the image.
*/
void GroupBox::setGroupImage(QString groupImage)
{
if (QFile::exists(groupImage)) {
QPixmap pixmap(groupImage);
mpGroupImageLabel->setPixmap(pixmap);
}
}
/*!
\class ParametersScrollArea
\brief Creates a scroll area for each tab of the component parameters dialog.
*/
ParametersScrollArea::ParametersScrollArea()
{
mpWidget = new QWidget;
setFrameShape(QFrame::NoFrame);
setBackgroundRole(QPalette::Base);
setWidgetResizable(true);
mpVerticalLayout = new QVBoxLayout;
mpVerticalLayout->setAlignment(Qt::AlignLeft | Qt::AlignTop);
mpWidget->setLayout(mpVerticalLayout);
setWidget(mpWidget);
}
/*!
* Reimplementation of minimumSizeHint.
* Finds maximum optimal size for ElementParameters dialog. If the dialog is larger than screen then shows the scrollbars.
*/
QSize ParametersScrollArea::minimumSizeHint() const
{
QSize size = QWidget::sizeHint();
// find optimal width
int screenWidth = QApplication::desktop()->availableGeometry().width() - 100;
int widgetWidth = mpWidget->minimumSizeHint().width() + (verticalScrollBar()->isVisible() ? verticalScrollBar()->width() : 0);
size.rwidth() = qMin(screenWidth, widgetWidth);
// find optimal height
int screenHeight = QApplication::desktop()->availableGeometry().height() - 300;
int widgetHeight = mpWidget->minimumSizeHint().height() + (horizontalScrollBar()->isVisible() ? horizontalScrollBar()->height() : 0);
size.rheight() = qMin(screenHeight, widgetHeight);
return size;
}
/*!
Adds a QGroupBox to the layout.
\param pGroupBox - pointer to QGroupBox.
\param pGroupBoxLayout - pointer to QGridLayout.
*/
void ParametersScrollArea::addGroupBox(GroupBox *pGroupBox)
{
if (!getGroupBox(pGroupBox->title()))
{
pGroupBox->hide(); /* create a hidden groupbox, we show it when it contains the parameters. */
mGroupBoxesList.append(pGroupBox);
mpVerticalLayout->addWidget(pGroupBox);
}
}
/*!
Returns the GroupBox by reading the list of GroupBoxes.
\return the GroupBox
*/
GroupBox* ParametersScrollArea::getGroupBox(QString title)
{
foreach (GroupBox *pGroupBox, mGroupBoxesList)
{
if (pGroupBox->title().compare(title) == 0)
return pGroupBox;
}
return 0;
}
/*!
Returns the main layout of the widget.
\return the QVBoxLayout
*/
QVBoxLayout *ParametersScrollArea::getLayout()
{
return mpVerticalLayout;
}
/*!
* \class ElementParameters
* \brief A dialog for displaying Component's parameters.
*/
/*!
* \brief ElementParameters::ElementParameters
* \param pComponent - pointer to Component
* \param pParent
*/
ElementParameters::ElementParameters(Element *pComponent, QWidget *pParent)
: QDialog(pParent)
{
QString className = pComponent->getGraphicsView()->getModelWidget()->getLibraryTreeItem()->getNameStructure();
setWindowTitle(tr("%1 - %2 - %3 in %4").arg(Helper::applicationName).arg(tr("Element Parameters")).arg(pComponent->getName())
.arg(className));
setAttribute(Qt::WA_DeleteOnClose);
mpComponent = pComponent;
setUpDialog();
}
/*!
* \brief ElementParameters::~ElementParameters
* Deletes the list of Parameter objects.
*/
ElementParameters::~ElementParameters()
{
qDeleteAll(mParametersList.begin(), mParametersList.end());
mParametersList.clear();
}
/*!
Creates the Dialog and set up all the controls with default values.
*/
void ElementParameters::setUpDialog()
{
// heading label
mpParametersHeading = Utilities::getHeadingLabel(Helper::parameters);
// set separator line
mHorizontalLine = Utilities::getHeadingLine();
// parameters tab widget
mpParametersTabWidget = new QTabWidget;
// Component Group Box
mpComponentGroupBox = new QGroupBox(tr("Component"));
// Component name
mpComponentNameLabel = new Label(Helper::name);
mpComponentNameTextBox = new Label(mpComponent->getName());
QGridLayout *pComponentGroupBoxLayout = new QGridLayout;
pComponentGroupBoxLayout->setAlignment(Qt::AlignTop | Qt::AlignLeft);
pComponentGroupBoxLayout->addWidget(mpComponentNameLabel, 0, 0);
pComponentGroupBoxLayout->addWidget(mpComponentNameTextBox, 0, 1);
mpComponentGroupBox->setLayout(pComponentGroupBoxLayout);
// Component Class Group Box
mpComponentClassGroupBox = new QGroupBox(tr("Class"));
// Component class name
mpComponentClassNameLabel = new Label(Helper::path);
mpComponentClassNameTextBox = new Label(mpComponent->getComponentInfo()->getClassName());
// Component comment
mpComponentClassCommentLabel = new Label(Helper::comment);
mpComponentClassCommentTextBox = new Label;
mpComponentClassCommentTextBox->setTextFormat(Qt::RichText);
mpComponentClassCommentTextBox->setTextInteractionFlags(mpComponentClassCommentTextBox->textInteractionFlags()
| Qt::LinksAccessibleByMouse | Qt::LinksAccessibleByKeyboard);
if (mpComponent->getLibraryTreeItem()) {
mpComponentClassCommentTextBox->setText(mpComponent->getLibraryTreeItem()->mClassInformation.comment);
}
connect(mpComponentClassCommentTextBox, SIGNAL(linkActivated(QString)), SLOT(commentLinkClicked(QString)));
QGridLayout *pComponentClassGroupBoxLayout = new QGridLayout;
pComponentClassGroupBoxLayout->setAlignment(Qt::AlignTop | Qt::AlignLeft);
pComponentClassGroupBoxLayout->addWidget(mpComponentClassNameLabel, 0, 0);
pComponentClassGroupBoxLayout->addWidget(mpComponentClassNameTextBox, 0, 1);
pComponentClassGroupBoxLayout->addWidget(mpComponentClassCommentLabel, 1, 0);
pComponentClassGroupBoxLayout->addWidget(mpComponentClassCommentTextBox, 1, 1);
mpComponentClassGroupBox->setLayout(pComponentClassGroupBoxLayout);
// Create General tab and Parameters GroupBox
ParametersScrollArea *pParametersScrollArea = new ParametersScrollArea;
// first add the Component Group Box and component class group box
pParametersScrollArea->getLayout()->addWidget(mpComponentGroupBox);
pParametersScrollArea->getLayout()->addWidget(mpComponentClassGroupBox);
GroupBox *pParametersGroupBox = new GroupBox("Parameters");
pParametersScrollArea->addGroupBox(pParametersGroupBox);
GroupBox *pInitializationGroupBox = new GroupBox("Initialization");
pParametersScrollArea->addGroupBox(pInitializationGroupBox);
mTabsMap.insert("General", mpParametersTabWidget->addTab(pParametersScrollArea, "General"));
// create parameters tabs and groupboxes
createTabsGroupBoxesAndParameters(mpComponent->getLibraryTreeItem());
/* We append the actual Components parameters first so that they appear first on the list.
* For that we use QList insert instead of append in ElementParameters::createTabsGroupBoxesAndParametersHelper() function.
* Modelica.Electrical.Analog.Basic.Resistor order is wrong if we don't use insert.
*/
createTabsGroupBoxesAndParametersHelper(mpComponent->getLibraryTreeItem(), true);
fetchComponentModifiers();
fetchExtendsModifiers();
foreach (Parameter *pParameter, mParametersList) {
ParametersScrollArea *pParametersScrollArea;
pParametersScrollArea = qobject_cast<ParametersScrollArea*>(mpParametersTabWidget->widget(mTabsMap.value(pParameter->getTab())));
if (pParametersScrollArea) {
if (!pParameter->getGroupBox().isEmpty()) {
GroupBox *pGroupBox = pParametersScrollArea->getGroupBox(pParameter->getGroupBox());
if (pGroupBox) {
/* We hide the groupbox when we create it. Show the groupbox now since it has a parameter. */
pGroupBox->show();
QGridLayout *pGroupBoxGridLayout = pGroupBox->getGridLayout();
int layoutIndex = pGroupBoxGridLayout->rowCount();
int columnIndex = 0;
pParameter->updateNameLabel();
pGroupBoxGridLayout->addWidget(pParameter->getNameLabel(), layoutIndex, columnIndex++);
if (pParameter->isShowStartAttribute()) {
pGroupBoxGridLayout->addWidget(pParameter->getFixedCheckBox(), layoutIndex, columnIndex++);
} else {
pGroupBoxGridLayout->addItem(new QSpacerItem(1, 1), layoutIndex, columnIndex++);
}
pGroupBoxGridLayout->addWidget(pParameter->getValueWidget(), layoutIndex, columnIndex++);
if (pParameter->getLoadSelectorFilter().compare("-") != 0 || pParameter->getLoadSelectorCaption().compare("-") != 0 ||
pParameter->getSaveSelectorFilter().compare("-") != 0 || pParameter->getSaveSelectorCaption().compare("-") != 0) {
pGroupBoxGridLayout->addWidget(pParameter->getFileSelectorButton(), layoutIndex, columnIndex++);
} else {
pGroupBoxGridLayout->addItem(new QSpacerItem(1, 1), layoutIndex, columnIndex++);
}
if (pParameter->getUnitComboBox()->count() > 0) { // only add the unit combobox if we really have a unit
/* ticket:4421
* Show a fixed value when there is only one unit.
*/
if (pParameter->getUnitComboBox()->count() == 1) {
pGroupBoxGridLayout->addWidget(new Label(pParameter->getUnitComboBox()->currentText()), layoutIndex, columnIndex++);
} else {
pGroupBoxGridLayout->addWidget(pParameter->getUnitComboBox(), layoutIndex, columnIndex++);
}
} else {
pGroupBoxGridLayout->addItem(new QSpacerItem(1, 1), layoutIndex, columnIndex++);
}
pGroupBoxGridLayout->addWidget(pParameter->getCommentLabel(), layoutIndex, columnIndex++);
}
}
}
}
// create Modifiers tab
QWidget *pModifiersTab = new QWidget;
// add items to modifiers tab
mpModifiersLabel = new Label(tr("Add new modifiers, e.g., phi(start=1), w(start=2)"));
mpModifiersTextBox = new QLineEdit;
QVBoxLayout *pModifiersTabLayout = new QVBoxLayout;
pModifiersTabLayout->setAlignment(Qt::AlignTop | Qt::AlignLeft);
pModifiersTabLayout->addWidget(mpModifiersLabel);
pModifiersTabLayout->addWidget(mpModifiersTextBox);
pModifiersTab->setLayout(pModifiersTabLayout);
mpParametersTabWidget->addTab(pModifiersTab, "Modifiers");
// Create the buttons
mpOkButton = new QPushButton(Helper::ok);
mpOkButton->setAutoDefault(true);
connect(mpOkButton, SIGNAL(clicked()), this, SLOT(updateComponentParameters()));
if (mpComponent->getGraphicsView()->getModelWidget()->getLibraryTreeItem()->isSystemLibrary() || mpComponent->getGraphicsView()->isVisualizationView()) {
mpOkButton->setDisabled(true);
}
mpCancelButton = new QPushButton(Helper::cancel);
mpCancelButton->setAutoDefault(false);
connect(mpCancelButton, SIGNAL(clicked()), this, SLOT(reject()));
mpButtonBox = new QDialogButtonBox(Qt::Horizontal);
mpButtonBox->addButton(mpOkButton, QDialogButtonBox::ActionRole);
mpButtonBox->addButton(mpCancelButton, QDialogButtonBox::ActionRole);
// main layout
QVBoxLayout *pMainLayout = new QVBoxLayout;
pMainLayout->addWidget(mpParametersHeading);
pMainLayout->addWidget(mHorizontalLine);
pMainLayout->addWidget(mpParametersTabWidget);
pMainLayout->addWidget(mpButtonBox);
setLayout(pMainLayout);
}
/*!
* \brief ElementParameters::createTabsGroupBoxesAndParameters
* Loops over the inherited classes of the Component.
* \param pLibraryTreeItem
* \see ElementParameters::createTabsGroupBoxesAndParametersHelper()
*/
void ElementParameters::createTabsGroupBoxesAndParameters(LibraryTreeItem *pLibraryTreeItem)
{
foreach (LibraryTreeItem *pInheritedLibraryTreeItem, pLibraryTreeItem->getModelWidget()->getInheritedClassesList()) {
createTabsGroupBoxesAndParameters(pInheritedLibraryTreeItem);
createTabsGroupBoxesAndParametersHelper(pInheritedLibraryTreeItem);
}
}
/*!
* \brief ElementParameters::createTabsGroupBoxesAndParametersHelper
* Creates the dynamic tabs for QTabWidget and QGroupBoxes within them.
* Creats the parameters and adds them to the appropriate tab and groupbox.
* \param pLibraryTreeItem
* \param useInsert - if true we use QList insert instead of append.
* \see ElementParameters::createTabsGroupBoxesAndParameters()
*/
void ElementParameters::createTabsGroupBoxesAndParametersHelper(LibraryTreeItem *pLibraryTreeItem, bool useInsert)
{
OMCProxy *pOMCProxy = MainWindow::instance()->getOMCProxy();
foreach (LibraryTreeItem *pInheritedLibraryTreeItem, pLibraryTreeItem->getInheritedClasses()) {
QMap<QString, QString> extendsModifiers = pLibraryTreeItem->getModelWidget()->getExtendsModifiersMap(pInheritedLibraryTreeItem->getNameStructure());
QMap<QString, QString>::iterator extendsModifiersIterator;
for (extendsModifiersIterator = extendsModifiers.begin(); extendsModifiersIterator != extendsModifiers.end(); ++extendsModifiersIterator) {
QString parameterName = StringHandler::getFirstWordBeforeDot(extendsModifiersIterator.key());
/* Ticket #2531
* Check if parameter is marked final in the extends modifier.
*/
if (pOMCProxy->isExtendsModifierFinal(pLibraryTreeItem->getNameStructure(), pInheritedLibraryTreeItem->getNameStructure(), parameterName)) {
Parameter *pParameter = findParameter(parameterName);
if (pParameter) {
mParametersList.removeOne(pParameter);
delete pParameter;
}
} else {
Parameter *pParameter = findParameter(parameterName);
if (pParameter) {
if (extendsModifiersIterator.key().compare(parameterName + ".start") == 0) {
QString start = extendsModifiersIterator.value();
if (!start.isEmpty()) {
if (pParameter->getGroupBox().isEmpty()) {
pParameter->setGroupBox("Initialization");
}
pParameter->setShowStartAttribute(true);
pParameter->setValueWidget(start, true, pParameter->getUnit());
}
} else if (extendsModifiersIterator.key().compare(parameterName + ".fixed") == 0) {
QString fixed = extendsModifiersIterator.value();
if (!fixed.isEmpty()) {
if (pParameter->getGroupBox().isEmpty()) {
pParameter->setGroupBox("Initialization");
}
pParameter->setShowStartAttribute(true);
pParameter->setFixedState(fixed, true);
}
} else {
pParameter->setValueWidget(extendsModifiersIterator.value(), true, pParameter->getUnit());
}
}
}
}
}
int insertIndex = 0;
pLibraryTreeItem->getModelWidget()->loadDiagramView();
foreach (Element *pComponent, pLibraryTreeItem->getModelWidget()->getDiagramGraphicsView()->getElementsList()) {
// if we already have the parameter from one of the inherited class then just skip this one.
if (findParameter(pComponent->getName())) {
continue;
}
/* Ticket #2531
* Do not show the protected & final parameters.
*/
if (pComponent->getComponentInfo()->getProtected() || pComponent->getComponentInfo()->getFinal()) {
continue;
}
/* I didn't find anything useful in the specification regarding this issue.
* The parameters dialog is only suppose to show the parameters. However, Dymola also shows the variables in the parameters window
* which have the dialog annotation with them. So, if the variable has dialog annotation or it is a parameter then show it.
* If the variable have start/fixed attribute set then show it also.
*/
QString tab = QString("General");
QString groupBox = "";
bool enable = true;
bool showStartAttribute = false;
QString loadSelectorFilter = "-", loadSelectorCaption = "-", saveSelectorFilter = "-", saveSelectorCaption = "-";
QString start = "", fixed = "";
bool isParameter = (pComponent->getComponentInfo()->getVariablity().compare("parameter") == 0);
// If not a parameter then check for start and fixed bindings. See Modelica.Electrical.Analog.Basic.Resistor parameter R.
if (!isParameter) {
OMCProxy *pOMCProxy = MainWindow::instance()->getOMCProxy();
QString className = pComponent->getGraphicsView()->getModelWidget()->getLibraryTreeItem()->getNameStructure();
QMap<QString, QString> modifiers = pComponent->getComponentInfo()->getModifiersMap(pOMCProxy, className, pComponent);
QMap<QString, QString>::iterator modifiersIterator;
for (modifiersIterator = modifiers.begin(); modifiersIterator != modifiers.end(); ++modifiersIterator) {
if (modifiersIterator.key().compare("start") == 0) {
start = modifiersIterator.value();
}
else if (modifiersIterator.key().compare("fixed") == 0) {
fixed = modifiersIterator.value();
}
}
showStartAttribute = (!start.isEmpty() || !fixed.isEmpty()) ? true : false;
}
/* get the dialog annotation */
QStringList dialogAnnotation = pComponent->getDialogAnnotation();
QString groupImage = "";
bool connectorSizing = false;
if (dialogAnnotation.size() > 10) {
// get the tab value
tab = StringHandler::removeFirstLastQuotes(dialogAnnotation.at(0));
// get the group value
groupBox = StringHandler::removeFirstLastQuotes(dialogAnnotation.at(1));
// get the enable value
/* Ticket #4008
* For now just display all parameters as enabled.
*/
//enable = (dialogAnnotation.at(2).compare("true") == 0);
// get the showStartAttribute value
if (dialogAnnotation.at(3).compare("-") != 0) {
showStartAttribute = (dialogAnnotation.at(3).compare("true") == 0);
}
// get the loadSelector
loadSelectorFilter = StringHandler::removeFirstLastQuotes(dialogAnnotation.at(5));
loadSelectorCaption = StringHandler::removeFirstLastQuotes(dialogAnnotation.at(6));
// get the saveSelector
saveSelectorFilter = StringHandler::removeFirstLastQuotes(dialogAnnotation.at(7));
saveSelectorCaption = StringHandler::removeFirstLastQuotes(dialogAnnotation.at(8));
// get the group image
groupImage = StringHandler::removeFirstLastQuotes(dialogAnnotation.at(9));
if (!groupImage.isEmpty()) {
groupImage = MainWindow::instance()->getOMCProxy()->uriToFilename(groupImage);
}
// get the connectorSizing
connectorSizing = (dialogAnnotation.at(10).compare("true") == 0);
}
// if connectorSizing is present then don't show the parameter
if (connectorSizing) {
continue;
}
// if showStartAttribute true and group name is empty or Parameters then we should make group name Initialization
if (showStartAttribute && groupBox.isEmpty()) {
groupBox = "Initialization";
} else if (groupBox.isEmpty() && (isParameter || (dialogAnnotation.size() > 0) || (pComponent->getComponentInfo()->getReplaceable()))) {
groupBox = "Parameters";