Rev 646 | Rev 649 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
1 | |||
105 | Werner | 2 | /** ModelController is a helper class used to |
3 | control the flow of operations during a model run. |
||
4 | Really useful???? or a dispatcher??? |
||
5 | */ |
||
128 | Werner | 6 | |
105 | Werner | 7 | #include "global.h" |
8 | #include "modelcontroller.h" |
||
128 | Werner | 9 | #include <QObject> |
105 | Werner | 10 | |
11 | #include "model.h" |
||
128 | Werner | 12 | #include "helper.h" |
165 | werner | 13 | #include "expression.h" |
161 | werner | 14 | #include "expressionwrapper.h" |
176 | werner | 15 | #include "../output/outputmanager.h" |
105 | Werner | 16 | |
514 | werner | 17 | #include "species.h" |
18 | #include "speciesset.h" |
||
596 | werner | 19 | #include "mapgrid.h" |
514 | werner | 20 | |
267 | werner | 21 | #include "mainwindow.h" // for the debug message buffering |
22 | |||
105 | Werner | 23 | ModelController::ModelController() |
24 | { |
||
128 | Werner | 25 | mModel = NULL; |
223 | werner | 26 | mPaused = false; |
225 | werner | 27 | mRunning = false; |
223 | werner | 28 | mYearsToRun = 0; |
590 | werner | 29 | mViewerWindow = 0; |
105 | Werner | 30 | } |
128 | Werner | 31 | |
32 | ModelController::~ModelController() |
||
33 | { |
||
34 | destroy(); |
||
35 | } |
||
36 | |||
590 | werner | 37 | void ModelController::connectSignals() |
38 | { |
||
39 | if (!mViewerWindow) |
||
40 | return; |
||
41 | connect(this,SIGNAL(bufferLogs(bool)), mViewerWindow, SLOT(bufferedLog(bool))); |
||
42 | } |
||
43 | |||
514 | werner | 44 | /// prepare a list of all (active) species |
45 | QHash<QString, QString> ModelController::availableSpecies() |
||
46 | { |
||
47 | QHash<QString, QString> list; |
||
48 | if (mModel) { |
||
49 | SpeciesSet *set = mModel->speciesSet(); |
||
50 | if (!set) |
||
51 | throw IException("there are 0 or more than one species sets."); |
||
52 | foreach (const Species *s, set->activeSpecies()) { |
||
53 | list[s->id()] = s->name(); |
||
54 | } |
||
55 | } |
||
56 | return list; |
||
57 | } |
||
128 | Werner | 58 | |
145 | Werner | 59 | bool ModelController::canCreate() |
128 | Werner | 60 | { |
129 | Werner | 61 | if (mModel) |
128 | Werner | 62 | return false; |
63 | return true; |
||
64 | } |
||
65 | |||
145 | Werner | 66 | bool ModelController::canDestroy() |
128 | Werner | 67 | { |
68 | return mModel != NULL; |
||
69 | } |
||
70 | |||
145 | Werner | 71 | bool ModelController::canRun() |
128 | Werner | 72 | { |
73 | if (mModel && mModel->isSetup()) |
||
74 | return true; |
||
75 | return false; |
||
76 | } |
||
77 | |||
145 | Werner | 78 | bool ModelController::isRunning() |
128 | Werner | 79 | { |
225 | werner | 80 | return mRunning; |
128 | Werner | 81 | } |
82 | |||
225 | werner | 83 | bool ModelController::isFinished() |
84 | { |
||
85 | if (!mModel) |
||
86 | return false; |
||
87 | return canRun() && !isRunning() && mFinished; |
||
497 | werner | 88 | } |
128 | Werner | 89 | |
497 | werner | 90 | int ModelController::currentYear() const |
91 | { |
||
92 | return GlobalSettings::instance()->currentYear(); |
||
225 | werner | 93 | } |
94 | |||
128 | Werner | 95 | void ModelController::setFileName(QString initFileName) |
96 | { |
||
97 | mInitFile = initFileName; |
||
98 | try { |
||
99 | GlobalSettings::instance()->loadProjectFile(mInitFile); |
||
100 | } catch(const IException &e) { |
||
575 | werner | 101 | QString error_msg = e.message(); |
128 | Werner | 102 | Helper::msg(error_msg); |
103 | qDebug() << error_msg; |
||
104 | } |
||
105 | } |
||
106 | |||
107 | void ModelController::create() |
||
108 | { |
||
109 | if (!canCreate()) |
||
110 | return; |
||
590 | werner | 111 | emit bufferLogs(true); |
112 | |||
128 | Werner | 113 | try { |
285 | werner | 114 | DebugTimer::clearAllTimers(); |
115 | mModel = new Model(); |
||
116 | mModel->loadProject(); |
||
286 | werner | 117 | if (!mModel->isSetup()) |
118 | return; |
||
119 | |||
497 | werner | 120 | // reset clock... |
121 | GlobalSettings::instance()->setCurrentYear(1); // reset clock |
||
395 | werner | 122 | // initialization of trees, output on startup |
286 | werner | 123 | mModel->beforeRun(); |
128 | Werner | 124 | } catch(const IException &e) { |
575 | werner | 125 | QString error_msg = e.message(); |
128 | Werner | 126 | Helper::msg(error_msg); |
127 | qDebug() << error_msg; |
||
128 | } |
||
590 | werner | 129 | emit bufferLogs(false); |
130 | |||
362 | werner | 131 | qDebug() << "Model created."; |
128 | Werner | 132 | } |
133 | |||
134 | void ModelController::destroy() |
||
135 | { |
||
136 | if (canDestroy()) { |
||
137 | delete mModel; |
||
138 | mModel = 0; |
||
162 | werner | 139 | GlobalSettings::instance()->setCurrentYear(0); |
128 | Werner | 140 | qDebug() << "ModelController: Model destroyed."; |
141 | } |
||
142 | } |
||
222 | werner | 143 | |
223 | werner | 144 | void ModelController::runloop() |
145 | { |
||
515 | werner | 146 | static QTime sLastTime = QTime::currentTime(); |
370 | werner | 147 | QApplication::processEvents(); |
223 | werner | 148 | if (mPaused) |
149 | return; |
||
225 | werner | 150 | bool doStop = false; |
151 | bool hasError = false; |
||
515 | werner | 152 | if (GlobalSettings::instance()->currentYear()<=1) { |
153 | sLastTime = QTime::currentTime(); // reset clock at the beginning of the simulation |
||
154 | } |
||
225 | werner | 155 | |
156 | if (!mCanceled && GlobalSettings::instance()->currentYear() < mYearsToRun) { |
||
590 | werner | 157 | emit bufferLogs(true); |
267 | werner | 158 | hasError = runYear(); // do the work |
225 | werner | 159 | mRunning = true; |
160 | emit year(GlobalSettings::instance()->currentYear()); |
||
497 | werner | 161 | if (!hasError) { |
515 | werner | 162 | int elapsed = sLastTime.msecsTo(QTime::currentTime()); |
497 | werner | 163 | int time=0; |
515 | werner | 164 | if (currentYear()%50==0 && elapsed>10000) |
497 | werner | 165 | time = 100; // a 100ms pause... |
515 | werner | 166 | if (currentYear()%100==0 && elapsed>10000) { |
497 | werner | 167 | time = 500; // a 500ms pause... |
168 | } |
||
515 | werner | 169 | if (time>0) { |
170 | sLastTime = QTime::currentTime(); // reset clock |
||
171 | qDebug() << "--- little break ---- (after " << elapsed << "ms)."; |
||
172 | } |
||
497 | werner | 173 | QTimer::singleShot(time,this, SLOT(runloop())); |
174 | } |
||
225 | werner | 175 | else |
176 | doStop = true; // an error occured |
||
177 | |||
178 | } else { |
||
179 | doStop = true; // all years simulated |
||
223 | werner | 180 | } |
225 | werner | 181 | |
182 | if (doStop || mCanceled) { |
||
183 | // finished |
||
184 | mRunning = false; |
||
185 | GlobalSettings::instance()->outputManager()->save(); |
||
186 | DebugTimer::printAllTimers(); |
||
187 | mFinished = true; |
||
590 | werner | 188 | emit bufferLogs(false); // stop buffering |
225 | werner | 189 | emit finished(QString()); |
190 | } |
||
267 | werner | 191 | |
225 | werner | 192 | QApplication::processEvents(); |
223 | werner | 193 | } |
194 | |||
222 | werner | 195 | void ModelController::run(int years) |
128 | Werner | 196 | { |
222 | werner | 197 | if (!canRun()) |
198 | return; |
||
590 | werner | 199 | emit bufferLogs(true); // start buffering |
200 | |||
222 | werner | 201 | DebugTimer many_runs(QString("Timer for %1 runs").arg(years)); |
223 | werner | 202 | mPaused = false; |
225 | werner | 203 | mFinished = false; |
204 | mCanceled = false; |
||
223 | werner | 205 | mYearsToRun = years; |
497 | werner | 206 | //GlobalSettings::instance()->setCurrentYear(1); // reset clock |
222 | werner | 207 | |
208 | DebugTimer::clearAllTimers(); |
||
223 | werner | 209 | |
210 | runloop(); // start the running loop |
||
211 | |||
128 | Werner | 212 | } |
213 | |||
223 | werner | 214 | bool ModelController::runYear() |
128 | Werner | 215 | { |
223 | werner | 216 | if (!canRun()) return false; |
421 | werner | 217 | DebugTimer t("ModelController:runYear"); |
497 | werner | 218 | qDebug() << "ModelController: run year" << currentYear(); |
421 | werner | 219 | |
171 | werner | 220 | if (GlobalSettings::instance()->settings().paramValueBool("debug_clear")) |
164 | werner | 221 | GlobalSettings::instance()->clearDebugLists(); // clear debug data |
223 | werner | 222 | bool err=false; |
128 | Werner | 223 | try { |
590 | werner | 224 | emit bufferLogs(true); |
128 | Werner | 225 | mModel->runYear(); |
162 | werner | 226 | fetchDynamicOutput(); |
128 | Werner | 227 | } catch(const IException &e) { |
575 | werner | 228 | QString error_msg = e.message(); |
128 | Werner | 229 | Helper::msg(error_msg); |
230 | qDebug() << error_msg; |
||
223 | werner | 231 | err=true; |
128 | Werner | 232 | } |
590 | werner | 233 | emit bufferLogs(false); |
223 | werner | 234 | return err; |
128 | Werner | 235 | } |
236 | |||
222 | werner | 237 | bool ModelController::pause() |
238 | { |
||
223 | werner | 239 | if(!isRunning()) |
240 | return mPaused; |
||
241 | |||
242 | if (mPaused) { |
||
243 | // currently in pause - mode -> continue |
||
244 | mPaused = false; |
||
245 | QTimer::singleShot(0,this, SLOT(runloop())); // continue loop |
||
246 | } else { |
||
247 | // currently running -> set to pause mode |
||
248 | GlobalSettings::instance()->outputManager()->save(); |
||
249 | mPaused = true; |
||
590 | werner | 250 | emit bufferLogs(false); |
223 | werner | 251 | } |
252 | return mPaused; |
||
222 | werner | 253 | } |
128 | Werner | 254 | |
222 | werner | 255 | void ModelController::cancel() |
256 | { |
||
225 | werner | 257 | mCanceled = true; |
222 | werner | 258 | } |
225 | werner | 259 | |
632 | werner | 260 | QMutex error_mutex; |
261 | void ModelController::throwError(const QString msg) |
||
262 | { |
||
263 | QMutexLocker lock(&error_mutex); // serialize access |
||
264 | qDebug() << "ModelController: throwError reached:"; |
||
265 | qDebug() << msg; |
||
266 | emit bufferLogs(false); |
||
267 | emit bufferLogs(true); // start buffering again |
||
268 | |||
269 | throw IException(msg); // raise error again |
||
270 | |||
271 | } |
||
161 | werner | 272 | ////////////////////////////////////// |
273 | // dynamic outut |
||
274 | ////////////////////////////////////// |
||
275 | ////////////////////////////////////// |
||
276 | void ModelController::setupDynamicOutput(QString fieldList) |
||
277 | { |
||
171 | werner | 278 | mDynFieldList.clear(); |
279 | if (!fieldList.isEmpty()) { |
||
280 | QRegExp rx("((?:\\[.+\\]|\\w+)\\.\\w+)"); |
||
281 | int pos=0; |
||
282 | while ((pos = rx.indexIn(fieldList, pos)) != -1) { |
||
283 | mDynFieldList.append(rx.cap(1)); |
||
284 | pos += rx.matchedLength(); |
||
285 | } |
||
286 | |||
287 | //mDynFieldList = fieldList.split(QRegExp("(?:\\[.+\\]|\\w+)\\.\\w+"), QString::SkipEmptyParts); |
||
170 | werner | 288 | mDynFieldList.prepend("count"); |
289 | mDynFieldList.prepend("year"); // fixed fields. |
||
290 | } |
||
161 | werner | 291 | mDynData.clear(); |
292 | mDynData.append(mDynFieldList.join(";")); |
||
293 | } |
||
162 | werner | 294 | |
161 | werner | 295 | QString ModelController::dynamicOutput() |
296 | { |
||
297 | return mDynData.join("\n"); |
||
298 | } |
||
299 | |||
218 | werner | 300 | const QStringList aggList = QStringList() << "mean" << "sum" << "min" << "max" << "p25" << "p50" << "p75" << "p5"<< "p10" << "p90" << "p95"; |
161 | werner | 301 | void ModelController::fetchDynamicOutput() |
302 | { |
||
303 | if (mDynFieldList.isEmpty()) |
||
304 | return; |
||
165 | werner | 305 | DebugTimer t("dynamic output"); |
161 | werner | 306 | QStringList var; |
307 | QString lastVar = ""; |
||
308 | QVector<double> data; |
||
309 | AllTreeIterator at(mModel); |
||
310 | TreeWrapper tw; |
||
311 | int var_index; |
||
312 | StatData stat; |
||
313 | double value; |
||
314 | QStringList line; |
||
165 | werner | 315 | Expression custom_expr; |
316 | bool simple_expression; |
||
161 | werner | 317 | foreach (QString field, mDynFieldList) { |
163 | werner | 318 | if (field=="count" || field=="year") |
319 | continue; |
||
166 | werner | 320 | if (field.count()>0 && field.at(0)=='[') { |
321 | QRegExp rex("\\[(.+)\\]\\.(\\w+)"); |
||
322 | rex.indexIn(field); |
||
323 | var = rex.capturedTexts(); |
||
324 | var.pop_front(); // drop first element (contains the full string) |
||
165 | werner | 325 | simple_expression = false; |
326 | } else { |
||
327 | var = field.split(QRegExp("\\W+"), QString::SkipEmptyParts); |
||
328 | simple_expression = true; |
||
329 | } |
||
161 | werner | 330 | if (var.count()!=2) |
331 | throw IException(QString("Invalid variable name for dynamic output:") + field); |
||
332 | if (var.first()!=lastVar) { |
||
333 | // load new field |
||
334 | data.clear(); |
||
168 | werner | 335 | at.reset(); var_index = 0; |
165 | werner | 336 | if (simple_expression) { |
337 | var_index = tw.variableIndex(var.first()); |
||
166 | werner | 338 | if (var_index<0) |
165 | werner | 339 | throw IException(QString("Invalid variable name for dynamic output:") + var.first()); |
166 | werner | 340 | |
165 | werner | 341 | } else { |
342 | custom_expr.setExpression(var.first()); |
||
343 | custom_expr.setModelObject(&tw); |
||
161 | werner | 344 | } |
345 | while (Tree *t = at.next()) { |
||
346 | tw.setTree(t); |
||
165 | werner | 347 | if (simple_expression) |
348 | value = tw.value(var_index); |
||
349 | else |
||
350 | value = custom_expr.execute(); |
||
166 | werner | 351 | data.push_back(value); |
161 | werner | 352 | } |
353 | stat.setData(data); |
||
354 | } |
||
355 | // fetch data |
||
356 | var_index = aggList.indexOf(var[1]); |
||
357 | switch (var_index) { |
||
358 | case 0: value = stat.mean(); break; |
||
359 | case 1: value = stat.sum(); break; |
||
360 | case 2: value = stat.min(); break; |
||
361 | case 3: value = stat.max(); break; |
||
362 | case 4: value = stat.percentile25(); break; |
||
363 | case 5: value = stat.median(); break; |
||
364 | case 6: value = stat.percentile75(); break; |
||
218 | werner | 365 | case 7: value = stat.percentile(5); break; |
366 | case 8: value = stat.percentile(10); break; |
||
367 | case 9: value = stat.percentile(90); break; |
||
368 | case 10: value = stat.percentile(95); break; |
||
161 | werner | 369 | default: throw IException(QString("Invalid aggregate expression for dynamic output: %1\nallowed:%2") |
370 | .arg(var[1]).arg(aggList.join(" "))); |
||
371 | } |
||
372 | line+=QString::number(value); |
||
373 | } |
||
162 | werner | 374 | line.prepend( QString::number(data.size()) ); |
375 | line.prepend( QString::number(GlobalSettings::instance()->currentYear()) ); |
||
376 | mDynData.append(line.join(";")); |
||
161 | werner | 377 | } |
590 | werner | 378 | |
379 | void ModelController::saveScreenshot(QString file_name) |
||
380 | { |
||
381 | if (!mViewerWindow) |
||
382 | return; |
||
383 | QImage img = mViewerWindow->screenshot(); |
||
384 | img.save(file_name); |
||
385 | } |
||
596 | werner | 386 | |
387 | void ModelController::paintMap(MapGrid *map, double min_value, double max_value) |
||
388 | { |
||
389 | if (mViewerWindow) { |
||
643 | werner | 390 | mViewerWindow->paintGrid(map, "", GridViewRainbow, min_value, max_value); |
596 | werner | 391 | qDebug() << "painted map grid" << map->name() << "min-value (blue):" << min_value << "max-value(red):" << max_value; |
392 | } |
||
393 | } |
||
632 | werner | 394 | |
643 | werner | 395 | void ModelController::paintGrid(const FloatGrid *grid, const QString &name, const GridViewType view_type, double min_value, double max_value) |
642 | werner | 396 | { |
397 | if (mViewerWindow) { |
||
643 | werner | 398 | mViewerWindow->paintGrid(grid, name, view_type, min_value, max_value); |
642 | werner | 399 | qDebug() << "painted grid min-value (blue):" << min_value << "max-value(red):" << max_value; |
400 | } |
||
401 | } |
||
402 | |||
634 | werner | 403 | void ModelController::setViewport(QPointF center_point, double scale_px_per_m) |
404 | { |
||
405 | if (mViewerWindow) |
||
406 | mViewerWindow->setViewport(center_point, scale_px_per_m); |
||
407 | } |
||
632 | werner | 408 | |
647 | werner | 409 | void ModelController::addLayers(const LayeredGridBase *layers, const QString &name) |
646 | werner | 410 | { |
647 | werner | 411 | if (mViewerWindow) |
412 | mViewerWindow->addLayers(layers, name); |
||
413 | //qDebug() << layers->names(); |
||
646 | werner | 414 | } |
634 | werner | 415 | |
646 | werner | 416 |