/
simulationexperimentviewplugin.cpp
445 lines (317 loc) · 14.8 KB
/
simulationexperimentviewplugin.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
/*******************************************************************************
Copyright (C) The University of Auckland
OpenCOR is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenCOR is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*******************************************************************************/
//==============================================================================
// Simulation Experiment view plugin
//==============================================================================
#include "cellmlfilemanager.h"
#include "cellmlsupportplugin.h"
#include "combinefilemanager.h"
#include "combinesupportplugin.h"
#include "filemanager.h"
#include "sedmlfilemanager.h"
#include "sedmlsupportplugin.h"
#include "simulation.h"
#include "simulationexperimentviewplugin.h"
#include "simulationexperimentviewpreferenceswidget.h"
#include "simulationexperimentviewpythonwrapper.h"
#include "simulationexperimentviewsimulationwidget.h"
#include "simulationexperimentviewwidget.h"
//==============================================================================
#include <QMainWindow>
#include <QSettings>
//==============================================================================
namespace OpenCOR {
namespace SimulationExperimentView {
//==============================================================================
PLUGININFO_FUNC SimulationExperimentViewPluginInfo()
{
Descriptions descriptions;
descriptions.insert("en", QString::fromUtf8("a plugin to edit and run a simulation experiment."));
descriptions.insert("fr", QString::fromUtf8("une extension pour éditer et exécuter une expérience de simulation."));
return new PluginInfo(PluginInfo::Category::Simulation, true, false,
QStringList() << "GraphPanelWidget" << "PythonQtSupport" << "SimulationSupport",
descriptions);
}
//==============================================================================
// File handling interface
//==============================================================================
bool SimulationExperimentViewPlugin::importFile(const QString &pFileName)
{
// Let our view widget know that we want to import a file
return mViewWidget->importFile(pFileName);
}
//==============================================================================
bool SimulationExperimentViewPlugin::saveFile(const QString &pOldFileName,
const QString &pNewFileName,
bool &pNeedFeedback)
{
Q_UNUSED(pNeedFeedback)
// Let our view widget know that we want to save a file
return mViewWidget->saveFile(pOldFileName, pNewFileName);
}
//==============================================================================
void SimulationExperimentViewPlugin::fileOpened(const QString &pFileName)
{
// Let our view widget know that a file has been opened
mViewWidget->fileOpened(pFileName);
}
//==============================================================================
void SimulationExperimentViewPlugin::filePermissionsChanged(const QString &pFileName)
{
// The given file has been un/locked, so let our view widget know about it
mViewWidget->filePermissionsChanged(pFileName);
}
//==============================================================================
void SimulationExperimentViewPlugin::fileModified(const QString &pFileName)
{
Q_UNUSED(pFileName)
// We don't handle this interface...
}
//==============================================================================
void SimulationExperimentViewPlugin::fileSaved(const QString &pFileName)
{
// The given file has been saved, so let our view widget know about it
mViewWidget->fileSaved(pFileName);
}
//==============================================================================
void SimulationExperimentViewPlugin::fileReloaded(const QString &pFileName)
{
// The given file has been reloaded, so let our view widget know about it
mViewWidget->fileReloaded(pFileName);
}
//==============================================================================
void SimulationExperimentViewPlugin::fileRenamed(const QString &pOldFileName,
const QString &pNewFileName)
{
// Let our view widget know that a file has been renamed
mViewWidget->fileRenamed(pOldFileName, pNewFileName);
}
//==============================================================================
void SimulationExperimentViewPlugin::fileClosed(const QString &pFileName)
{
// Let our view widget know that a file has been closed
mViewWidget->fileClosed(pFileName);
}
//==============================================================================
// I18n interface
//==============================================================================
void SimulationExperimentViewPlugin::retranslateUi()
{
// Retranslate our Simulation Experiment view widget
mViewWidget->retranslateUi();
}
//==============================================================================
// Plugin interface
//==============================================================================
bool SimulationExperimentViewPlugin::definesPluginInterfaces()
{
// We don't handle this interface...
return false;
}
//==============================================================================
bool SimulationExperimentViewPlugin::pluginInterfacesOk(const QString &pFileName,
QObject *pInstance)
{
Q_UNUSED(pFileName)
Q_UNUSED(pInstance)
// We don't handle this interface...
return false;
}
//==============================================================================
void SimulationExperimentViewPlugin::initializePlugin()
{
// We don't handle this interface...
}
//==============================================================================
void SimulationExperimentViewPlugin::finalizePlugin()
{
// We don't handle this interface...
}
//==============================================================================
void SimulationExperimentViewPlugin::pluginsInitialized(const Plugins &pLoadedPlugins)
{
// Retrieve the different CellML capable editing and simulation views
Plugins cellmlEditingViewPlugins = Plugins();
Plugins cellmlSimulationViewPlugins = Plugins();
for (auto plugin : pLoadedPlugins) {
ViewInterface *viewInterface = qobject_cast<ViewInterface *>(plugin->instance());
if ( (viewInterface != nullptr)
&& ( (viewInterface->viewMode() == ViewInterface::Mode::Editing)
|| (viewInterface->viewMode() == ViewInterface::Mode::Simulation))) {
QStringList viewMimeTypes = viewInterface->viewMimeTypes();
if ( viewMimeTypes.isEmpty()
|| viewMimeTypes.contains(CellMLSupport::CellmlMimeType)) {
if (viewInterface->viewMode() == ViewInterface::Mode::Editing) {
cellmlEditingViewPlugins << plugin;
} else {
cellmlSimulationViewPlugins << plugin;
}
}
}
}
// Create our Simulation Experiment view widget
mViewWidget = new SimulationExperimentViewWidget(this,
cellmlEditingViewPlugins,
cellmlSimulationViewPlugins,
Core::mainWindow());
mViewWidget->setObjectName("SimulationExperimentViewWidget");
// Hide our Simulation Experiment view widget since it may not initially be
// shown in our central widget
mViewWidget->hide();
// Save the view widget for our Python wrapper
instance()->mViewWidget = mViewWidget;
}
//==============================================================================
void SimulationExperimentViewPlugin::loadSettings(QSettings &pSettings)
{
// Retrieve our Simulation Experiment view settings
pSettings.beginGroup(mViewWidget->objectName());
mViewWidget->loadSettings(pSettings);
pSettings.endGroup();
}
//==============================================================================
void SimulationExperimentViewPlugin::saveSettings(QSettings &pSettings) const
{
// Keep track of our Simulation Experiment view settings
pSettings.beginGroup(mViewWidget->objectName());
mViewWidget->saveSettings(pSettings);
pSettings.endGroup();
}
//==============================================================================
void SimulationExperimentViewPlugin::handleUrl(const QUrl &pUrl)
{
Q_UNUSED(pUrl)
// We don't handle this interface...
}
//==============================================================================
// Preferences interface
//==============================================================================
Preferences::PreferencesWidget * SimulationExperimentViewPlugin::preferencesWidget()
{
// Return our preferences widget
return new SimulationExperimentViewPreferencesWidget(Core::mainWindow());
}
//==============================================================================
void SimulationExperimentViewPlugin::preferencesChanged(const QStringList &pPluginNames)
{
Q_UNUSED(pPluginNames)
// We don't handle this interface...
}
//==============================================================================
// View interface
//==============================================================================
ViewInterface::Mode SimulationExperimentViewPlugin::viewMode() const
{
// Return our mode
return ViewInterface::Mode::Simulation;
}
//==============================================================================
QStringList SimulationExperimentViewPlugin::viewMimeTypes() const
{
// Return the MIME types we support
return QStringList() << CellMLSupport::CellmlMimeType
<< SEDMLSupport::SedmlMimeType
<< COMBINESupport::CombineMimeType;
}
//==============================================================================
QString SimulationExperimentViewPlugin::viewMimeType(const QString &pFileName) const
{
// Return the MIME type for the given CellML file
// Note: we should never return an empty string...
if (CellMLSupport::CellmlFileManager::instance()->cellmlFile(pFileName) != nullptr) {
return CellMLSupport::CellmlMimeType;
}
if (SEDMLSupport::SedmlFileManager::instance()->sedmlFile(pFileName) != nullptr) {
return SEDMLSupport::SedmlMimeType;
}
if (COMBINESupport::CombineFileManager::instance()->combineArchive(pFileName) != nullptr) {
return COMBINESupport::CombineMimeType;
}
return {};
}
//==============================================================================
QString SimulationExperimentViewPlugin::viewDefaultFileExtension() const
{
// Return the default file extension we support, based on the file type of
// our simulation
return (mViewWidget->simulationWidget()->simulation()->fileType() == SimulationSupport::Simulation::FileType::CellmlFile)?
CellMLSupport::CellmlFileExtension:
SEDMLSupport::SedmlFileExtension;
}
//==============================================================================
QWidget * SimulationExperimentViewPlugin::viewWidget(const QString &pFileName)
{
// Make sure that we are not dealing with a new file, but a CellML 1.0/1.1
// file, a SED-ML file or a COMBINE archive
CellMLSupport::CellmlFile::Version cellmlVersion = CellMLSupport::CellmlFile::fileVersion(pFileName);
if ( Core::FileManager::instance()->isNew(pFileName)
|| ( (cellmlVersion != CellMLSupport::CellmlFile::Version::Cellml_1_0)
&& (cellmlVersion != CellMLSupport::CellmlFile::Version::Cellml_1_1)
&& (SEDMLSupport::SedmlFileManager::instance()->sedmlFile(pFileName) == nullptr)
&& (COMBINESupport::CombineFileManager::instance()->combineArchive(pFileName) == nullptr))) {
return nullptr;
}
// Update and return our simulation view widget using the given CellML file,
// SED-ML file or COMBINE archive
mViewWidget->initialize(pFileName);
return mViewWidget;
}
//==============================================================================
void SimulationExperimentViewPlugin::removeViewWidget(const QString &pFileName)
{
// Ask our view widget to finalise the given CellML file
mViewWidget->finalize(pFileName);
}
//==============================================================================
QString SimulationExperimentViewPlugin::viewName() const
{
// Return our Simulation Experiment view's name
return tr("Simulation Experiment");
}
//==============================================================================
QIcon SimulationExperimentViewPlugin::fileTabIcon(const QString &pFileName) const
{
// Return the requested file tab icon
return mViewWidget->fileTabIcon(pFileName);
}
//==============================================================================
// Python interface
//==============================================================================
void SimulationExperimentViewPlugin::registerPythonClasses(PyObject *pModule)
{
// Register our Python classes
new SimulationExperimentViewPythonWrapper(pModule, this);
}
//==============================================================================
// Plugin specific
//==============================================================================
SimulationExperimentViewPlugin * SimulationExperimentViewPlugin::instance(void)
{
// Return the 'global' instance of our plugin
static SimulationExperimentViewPlugin pluginInstance;
return static_cast<SimulationExperimentViewPlugin *>(Core::globalInstance("OpenCOR::SimulationExperimentView::SimulationExperimentViewPlugin",
&pluginInstance));
}
//==============================================================================
SimulationExperimentViewWidget * SimulationExperimentViewPlugin::viewWidget() const
{
// Return our view widget
return mViewWidget;
}
//==============================================================================
} // namespace SimulationExperimentView
} // namespace OpenCOR
//==============================================================================
// End of file
//==============================================================================