From 55ad27986bff87bcbd1b9b648473dffdaa37b3fd Mon Sep 17 00:00:00 2001
From: Nick Draper <nick.draper@stfc.ac.uk>
Date: Fri, 31 Jan 2020 12:58:45 +0000
Subject: [PATCH] Reslove MonitorData not showing in the workbench algorithm
details box
This was due to:
1. Too long a default UpdateEvery default
2. Too infrequest progress updates from MonitorLiveData
3. The Algorithm Details box not adding an algorithm until it sends a progress update
4. The StartLiveData custom Dialog not showing the default for UpdateEvery
Fixes:
1. Decreased the default UpdateEvery from 60 to 30 seconds
2. Change the default timeout for FakeISISHistongramDAE from 30 to 60s
3. improved the progress logging for MonitorLivedata to update more frequently with an idle counter as well.
4. Changed the tie function used in custom algorithm dialogs to set the placeholder text for line edits
5. Changed the log level for user cancelling of algorithms from Error to warning so it does not trigger the notification service
6. Changed the log message for user cancellation from Terminated to cancelled to reduce confusion
re #27077
---
Framework/API/src/Algorithm.cpp | 2 +-
Framework/LiveData/src/ISIS/FakeISISHistoDAE.cpp | 2 +-
Framework/LiveData/src/MonitorLiveData.cpp | 10 ++++++++--
Framework/LiveData/src/StartLiveData.cpp | 4 ++--
docs/source/release/v4.3.0/mantidworkbench.rst | 2 ++
.../EnggDiffraction/EnggDiffractionPresenter.cpp | 2 +-
.../common/inc/MantidQtWidgets/Common/PropertyWidget.h | 10 +++++-----
qt/widgets/common/src/AlgorithmDialog.cpp | 10 ++++++++++
8 files changed, 30 insertions(+), 12 deletions(-)
diff --git a/Framework/API/src/Algorithm.cpp b/Framework/API/src/Algorithm.cpp
index 2908f919fbc..57b1d4ad5cc 100644
--- a/Framework/API/src/Algorithm.cpp
+++ b/Framework/API/src/Algorithm.cpp
@@ -686,7 +686,7 @@ bool Algorithm::executeInternal() {
} catch (CancelException &ex) {
m_runningAsync = false;
m_running = false;
- getLogger().error() << this->name() << ": Execution terminated by user.\n";
+ getLogger().warning() << this->name() << ": Execution cancelled by user.\n";
notificationCenter().postNotification(
new ErrorNotification(this, ex.what()));
this->unlockWorkspaces();
diff --git a/Framework/LiveData/src/ISIS/FakeISISHistoDAE.cpp b/Framework/LiveData/src/ISIS/FakeISISHistoDAE.cpp
index 0b4429bfdde..989e5e9e1bc 100644
--- a/Framework/LiveData/src/ISIS/FakeISISHistoDAE.cpp
+++ b/Framework/LiveData/src/ISIS/FakeISISHistoDAE.cpp
@@ -20,7 +20,7 @@ DECLARE_ALGORITHM(FakeISISHistoDAE)
namespace {
// Time we'll wait on a receive call (in seconds)
-const long RECV_TIMEOUT = 30;
+const long RECV_TIMEOUT = 60;
typedef enum {
ISISDSUnknown = 0,
diff --git a/Framework/LiveData/src/MonitorLiveData.cpp b/Framework/LiveData/src/MonitorLiveData.cpp
index 7c8aa2a5133..a8051ed3d85 100644
--- a/Framework/LiveData/src/MonitorLiveData.cpp
+++ b/Framework/LiveData/src/MonitorLiveData.cpp
@@ -151,15 +151,21 @@ void MonitorLiveData::exec() {
// Exit if the user presses cancel
this->interruption_point();
+ DateAndTime now = DateAndTime::getCurrentTime();
+ double seconds = DateAndTime::secondsFromDuration(now - lastTime);
+
+ // Report progress and exit if the user presses cancel
+ progress(0.0, "Live Waiting " + Strings::toString((int)seconds) +
+ " of " + Strings::toString((int)UpdateEvery) + "s");
+
// Sleep for 50 msec
Poco::Thread::sleep(50);
- DateAndTime now = DateAndTime::getCurrentTime();
- double seconds = DateAndTime::secondsFromDuration(now - lastTime);
if (seconds > UpdateEvery) {
lastTime = now;
g_log.notice() << "Loading live data chunk " << m_chunkNumber << " at "
<< now.toFormattedString("%H:%M:%S") << '\n';
+ progress(0.0, "Live Data " + Strings::toString(m_chunkNumber));
// Time to run LoadLiveData again
Algorithm_sptr alg = createChildAlgorithm("LoadLiveData");
diff --git a/Framework/LiveData/src/StartLiveData.cpp b/Framework/LiveData/src/StartLiveData.cpp
index 5be5f7cd909..1d8e19b349b 100644
--- a/Framework/LiveData/src/StartLiveData.cpp
+++ b/Framework/LiveData/src/StartLiveData.cpp
@@ -62,9 +62,9 @@ void StartLiveData::init() {
"You must specify the StartTime property if this is checked.");
declareProperty(
- std::make_unique<PropertyWithValue<double>>("UpdateEvery", 60.0,
+ std::make_unique<PropertyWithValue<double>>("UpdateEvery", 30.0,
Direction::Input),
- "Frequency of updates, in seconds. Default 60.\n"
+ "Frequency of updates, in seconds. Default 30.\n"
"If you specify 0, MonitorLiveData will not launch and you will get only "
"one chunk.");
diff --git a/docs/source/release/v4.3.0/mantidworkbench.rst b/docs/source/release/v4.3.0/mantidworkbench.rst
index 6ba27601232..fd7866fa647 100644
--- a/docs/source/release/v4.3.0/mantidworkbench.rst
+++ b/docs/source/release/v4.3.0/mantidworkbench.rst
@@ -29,6 +29,7 @@ Improvements
- An exclude property has been added to the fit property browser
- The images tab in figure options no longer forces the max value to be greater than the min value.
- Double clicking on a workspace that only has a single bin of data (for example from a constant wavelength source) will now plot that bin, also for single bin workspaces a plot bin option has been added to the right click plot menu of the workspace.
+- Default values for algorithm properties now appear as placeholder (greyed-out) text on custm algorithm dialogs.
Bugfixes
@@ -39,5 +40,6 @@ Bugfixes
- Running an algorithm that reduces the number of spectra on an active plot (eg SumSpectra) no longer causes an error
- Fix crash when loading a script with syntax errors
- The Show Instruments right click menu option is now disabled for workspaces that have had their spectrum axis converted to another axis using :ref:`ConvertSpectrumAxis <algm-ConvertSpectrumAxis>`. Once this axis has been converetd the workspace loses it's link between the data values and the detectors they were recorded on so we cannot display it in the instrument view.
+- MonitorLiveData now appears promptly in the algorithm details window, allowing live data sessions to be cancelled.
:ref:`Release 4.3.0 <v4.3.0>`
diff --git a/qt/scientific_interfaces/EnggDiffraction/EnggDiffractionPresenter.cpp b/qt/scientific_interfaces/EnggDiffraction/EnggDiffractionPresenter.cpp
index 161c59f634c..0e18f345e88 100644
--- a/qt/scientific_interfaces/EnggDiffraction/EnggDiffractionPresenter.cpp
+++ b/qt/scientific_interfaces/EnggDiffraction/EnggDiffractionPresenter.cpp
@@ -896,7 +896,7 @@ void EnggDiffractionPresenter::doNewCalibration(const std::string &outFilename,
} catch (Mantid::API::Algorithm::CancelException &) {
m_calibFinishedOK = false;
m_cancelled = true;
- g_log.error() << "Execution terminated by user. \n";
+ g_log.warning() << "Execution cancelled by user. \n";
}
// restore normal data search paths
conf.setDataSearchDirs(tmpDirs);
diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/PropertyWidget.h b/qt/widgets/common/inc/MantidQtWidgets/Common/PropertyWidget.h
index 76363894a7f..8cb33b06744 100644
--- a/qt/widgets/common/inc/MantidQtWidgets/Common/PropertyWidget.h
+++ b/qt/widgets/common/inc/MantidQtWidgets/Common/PropertyWidget.h
@@ -54,6 +54,11 @@ class EXPORT_OPT_MANTIDQT_COMMON PropertyWidget : public QWidget {
Q_OBJECT
public:
+ /// Set the placeholder text of the given field based on the default value of
+ /// the given property.
+ static void setFieldPlaceholderText(Mantid::Kernel::Property *prop,
+ QLineEdit *field);
+
enum Info { INVALID, REPLACE, RESTORE };
PropertyWidget(Mantid::Kernel::Property *prop, QWidget *parent = nullptr,
@@ -123,11 +128,6 @@ protected:
/// the given property.
static void setLabelFont(Mantid::Kernel::Property *prop, QWidget *label);
- /// Set the placeholder text of the given field based on the default value of
- /// the given property.
- static void setFieldPlaceholderText(Mantid::Kernel::Property *prop,
- QLineEdit *field);
-
/// Property being looked at. This is NOT owned by the widget
Mantid::Kernel::Property *m_prop;
diff --git a/qt/widgets/common/src/AlgorithmDialog.cpp b/qt/widgets/common/src/AlgorithmDialog.cpp
index a6ce59e6351..9018e0d504f 100644
--- a/qt/widgets/common/src/AlgorithmDialog.cpp
+++ b/qt/widgets/common/src/AlgorithmDialog.cpp
@@ -15,6 +15,7 @@
#include "MantidQtWidgets/Common/FilePropertyWidget.h"
#include "MantidQtWidgets/Common/HelpWindow.h"
#include "MantidQtWidgets/Common/MantidWidget.h"
+#include "MantidQtWidgets/Common/PropertyWidget.h"
#include <QCheckBox>
#include <QCloseEvent>
@@ -566,6 +567,15 @@ QWidget *AlgorithmDialog::tie(QWidget *widget, const QString &property,
setPreviousValue(widget, property);
}
+ // If the widget is a line edit and has no value then set the placeholder text
+ // to the default value.
+ QLineEdit *textfield = qobject_cast<QLineEdit *>(widget);
+ if ((textfield) && (textfield->text() == "")) {
+ if (prop) {
+ PropertyWidget::setFieldPlaceholderText(prop, textfield);
+ }
+ }
+
return validlbl;
}
--
GitLab