Re #26643 Add DecoderTest and update Item state on project save

qt/scientific_interfaces/ISISReflectometry/GUI/Common/Decoder.cpp

@@ -227,7 +227,7 @@ void Decoder::decodeRunsTable(QtRunsTableView *gui, ReductionJobs *redJobs,
                               const QMap<QString, QVariant> &map) {
   MantidQt::API::SignalBlocker signalBlockerView(gui);
 
-  bool projectSave = map[QString("projectSave")].toBool();
+  m_projectSave = map[QString("projectSave")].toBool();
   auto runsTable = map[QString("runsTableModel")].toList();
 
   // Clear
@@ -255,9 +255,11 @@ void Decoder::decodeRunsTable(QtRunsTableView *gui, ReductionJobs *redJobs,
   // Still need to do this for groups
   updateRunsTableViewFromModel(gui, redJobs);
 
-  if (projectSave) {
+  if (m_projectSave) {
     // Apply styling and restore completed state for output range values best
     // way to achieve this is yet to be decided.
+    presenter->notifyRowOutputsChanged();
+    presenter->notifyRowStateChanged();
   }
   gui->m_ui.filterBox->setText(map[QString("filterBox")].toString());
 }
@@ -275,6 +277,10 @@ Decoder::decodeGroup(const QMap<QString, QVariant> &map) {
   auto rows = decodeRows(map["rows"].toList());
   MantidQt::CustomInterfaces::ISISReflectometry::Group group(
       map[QString("name")].toString().toStdString(), rows);
+  if (m_projectSave) {
+    auto itemState = map[QString("itemState")].toInt();
+    group.setState(State(itemState));
+  }
   group.m_postprocessedWorkspaceName =
       map[QString("postprocessedWorkspaceName")].toString().toStdString();
   return group;
@@ -317,21 +323,30 @@ Decoder::decodeRow(const QMap<QString, QVariant> &map) {
   if (scaleFactorPresent) {
     scaleFactor = map[QString("scaleFactor")].toDouble();
   }
-
   if (scaleFactorPresent) {
-    return MantidQt::CustomInterfaces::ISISReflectometry::Row(
+    auto row = MantidQt::CustomInterfaces::ISISReflectometry::Row(
         number, map[QString("theta")].toDouble(),
         decodeTransmissionRunPair(map[QString("transRunNums")].toMap()),
         decodeRangeInQ(map[QString("qRange")].toMap()), scaleFactor,
         decodeReductionOptions(map[QString("reductionOptions")].toMap()),
         decodeReductionWorkspace(map[QString("reductionWorkspaces")].toMap()));
+    if (m_projectSave) {
+      auto itemState = map[QString("itemState")].toInt();
+      row.setState(State(itemState));
+    }
+    return row;
   } else {
-    return MantidQt::CustomInterfaces::ISISReflectometry::Row(
+    auto row = MantidQt::CustomInterfaces::ISISReflectometry::Row(
         number, map[QString("theta")].toDouble(),
         decodeTransmissionRunPair(map[QString("transRunNums")].toMap()),
         decodeRangeInQ(map[QString("qRange")].toMap()), boost::none,
         decodeReductionOptions(map[QString("reductionOptions")].toMap()),
         decodeReductionWorkspace(map[QString("reductionWorkspaces")].toMap()));
+    if (m_projectSave) {
+      auto itemState = map[QString("itemState")].toInt();
+      row.setState(State(itemState));
+    }
+    return row;
   }
 }
 

qt/scientific_interfaces/ISISReflectometry/GUI/Common/Decoder.h

@@ -79,6 +79,7 @@ private:
   void decodeEvent(const QtEventView *gui, const QMap<QString, QVariant> &map);
   void updateRunsTableViewFromModel(QtRunsTableView *view,
                                     const ReductionJobs *model);
+  bool m_projectSave = false;
   friend class CoderCommonTester;
 };
 

qt/scientific_interfaces/ISISReflectometry/GUI/Common/Encoder.cpp

@@ -116,6 +116,7 @@ QMap<QString, QVariant> Encoder::encodeGroup(
     const MantidQt::CustomInterfaces::ISISReflectometry::Group &group) {
   QMap<QString, QVariant> map;
   map.insert(QString("name"), QVariant(QString::fromStdString(group.m_name)));
+  map.insert(QString("itemState"), QVariant(static_cast<int>(group.state())));
   map.insert(
       QString("postprocessedWorkspaceName"),
       QVariant(QString::fromStdString(group.m_postprocessedWorkspaceName)));
@@ -204,6 +205,7 @@ Encoder::encodeReductionOptions(const ReductionOptionsMap &rom) {
 QMap<QString, QVariant> Encoder::encodeRow(
     const MantidQt::CustomInterfaces::ISISReflectometry::Row &row) {
   QMap<QString, QVariant> map;
+  map.insert(QString("itemState"), QVariant(static_cast<int>(row.state())));
   QList<QVariant> runNumbers;
   for (const auto &runNumber : row.m_runNumbers) {
     runNumbers.append(QVariant(QString::fromStdString(runNumber)));

qt/scientific_interfaces/ISISReflectometry/Reduction/Item.cpp

@@ -14,6 +14,8 @@ Item::Item() : m_itemState(), m_skipped(false) {}
 
 State Item::state() const { return m_itemState.state(); }
 
+void Item::setState(State state) { m_itemState = ItemState(state); }
+
 std::string Item::message() const { return m_itemState.message(); }
 
 void Item::resetState(bool resetChildren) {

qt/scientific_interfaces/ISISReflectometry/Reduction/Item.h

@@ -29,6 +29,7 @@ public:
 
   virtual bool isGroup() const = 0;
   State state() const;
+  void setState(State state);
   std::string message() const;
   virtual bool requiresProcessing(bool reprocessFailed) const;
 

qt/scientific_interfaces/ISISReflectometry/Reduction/ItemState.cpp

@@ -14,6 +14,9 @@ ItemState::ItemState()
     : m_state(State::ITEM_NOT_STARTED), m_message(boost::none),
       m_progress(0.0) {}
 
+ItemState::ItemState(State state)
+    : m_state(state), m_message(boost::none), m_progress(0.0) {}
+
 State ItemState::state() const { return m_state; }
 
 std::string ItemState::message() const {

qt/scientific_interfaces/ISISReflectometry/Reduction/ItemState.h

@@ -16,12 +16,12 @@ namespace CustomInterfaces {
 namespace ISISReflectometry {
 
 enum class State {
-  ITEM_NOT_STARTED,
-  ITEM_STARTING,
-  ITEM_RUNNING,
-  ITEM_COMPLETE,
-  ITEM_ERROR,
-  ITEM_WARNING
+  ITEM_NOT_STARTED = 0,
+  ITEM_STARTING = 1,
+  ITEM_RUNNING = 2,
+  ITEM_COMPLETE = 3,
+  ITEM_ERROR = 4,
+  ITEM_WARNING = 5
 };
 
 /** @class ItemState
@@ -32,6 +32,7 @@ enum class State {
 class MANTIDQT_ISISREFLECTOMETRY_DLL ItemState {
 public:
   ItemState();
+  ItemState(State state);
 
   State state() const;
   std::string message() const;

qt/scientific_interfaces/test/ISISReflectometry/Common/CoderCommonTester.h

@@ -32,6 +32,17 @@ namespace CustomInterfaces {
 namespace ISISReflectometry {
 class CoderCommonTester {
 public:
+  void testMainWindowView(const QtMainWindowView &mwv,
+                          const QMap<QString, QVariant> &map) {
+    auto list = map[QString("batches")].toList();
+    for (auto batchIndex = 0u; batchIndex < mwv.m_batchViews.size();
+         ++batchIndex) {
+      testBatch(mwv.m_batchViews[batchIndex], mwv, list[batchIndex].toMap());
+    }
+    TS_ASSERT_EQUALS(map[QString("tag")].toString().toStdString(),
+                     "ISIS Reflectometry")
+  }
+
   void testBatch(const QtBatchView *gui, const QtMainWindowView &mwv,
                  const QMap<QString, QVariant> &map) {
     Decoder batchFinder;

qt/scientific_interfaces/test/ISISReflectometry/Common/DecoderTest.h

@@ -21,41 +21,106 @@
 #include <QVariant>
 
 namespace {
-const static QString JSON_STRING{
-    "{\"eventView\":{\"customButton\":false,\"customEdit\":\"\", "
-    "\"disabledSlicingButton\":false,\"logValueButton\":false,\"logValueEdit\":"
-    "\"\",\"logValueTypeEdit\":\"\",\"uniformButton\":true,\"uniformEdit\":3,"
-    "\"uniformEvenButton\":false,\"uniformEvenEdit\":2},\"experimentView\":{"
-    "\"analysisModeComboBox\":1,\"debugCheckbox\":true,\"endOverlapEdit\":13,"
-    "\"floodCorComboBox\":1,\"floodWorkspaceWsSelector\":0,"
-    "\"includePartialBinsCheckBox\":true,\"perAngleDefaults\":{\"columnsNum\":"
-    "9,\"rows\":[[\"123\",\"123\",\"213\",\"123\",\"123\",\"123\",\"123\","
-    "\"123\",\"123\"]],\"rowsNum\":1},\"polCorrCheckBox\":false,"
-    "\"reductionTypeComboBox\":2,\"startOverlapEdit\":12,\"stitchEdit\":\"\","
-    "\"summationTypeComboBox\":1,\"transScaleRHSCheckBox\":true,"
-    "\"transStitchParamsEdit\":\"1\"},\"instrumentView\":{\"I0MonitorIndex\":3,"
-    "\"correctDetectorsCheckBox\":false,\"detectorCorrectionTypeComboBox\":1,"
-    "\"intMonCheckBox\":false,\"lamMaxEdit\":18,\"lamMinEdit\":2.5,"
-    "\"monBgMaxEdit\":20,\"monBgMinEdit\":19,\"monIntMaxEdit\":11,"
-    "\"monIntMinEdit\":5},\"runsView\":{\"comboSearchInstrument\":0,"
-    "\"runsTable\":{\"filterBox\":\"123\",\"projectSave\":false,"
-    "\"runsTableModel\":[{\"name\":\"123\",\"postprocessedWorkspaceName\":\"\","
-    "\"rows\":[{\"qRange\":{\"max\":0.1,\"maxPresent\":true,\"min\":0.1,"
-    "\"minPresent\":true,\"step\":0.1,\"stepPresent\":true},\"qRangeOutput\":{"
-    "\"maxPresent\":false,\"minPresent\":false,\"stepPresent\":false},"
-    "\"reductionOptions\":{\"ProcessingInstructions\":\"1-4\"},"
-    "\"reductionWorkspaces\":{\"iVsLambda\":\"\",\"iVsQ\":\"\",\"iVsQBinned\":"
-    "\"\",\"inputRunNumbers\":[\"13460\"],\"transPair\":{\"firstTransRuns\":["
-    "\"123\"],\"secondTransRuns\":[\"1234\"]}},\"runNumbers\":[\"13460\"],"
-    "\"scaleFactor\":2,\"scaleFactorPresent\":true,\"theta\":0.5,"
-    "\"transRunNums\":{\"firstTransRuns\":[\"123\"],\"secondTransRuns\":["
-    "\"1234\"]}}]}]},\"textSearch\":\"1120015\"},\"saveView\":{"
-    "\"commaRadioButton\":false,\"fileFormatComboBox\":1,\"filterEdit\":"
-    "\"123\",\"prefixEdit\":\"123\",\"qResolutionCheckBox\":true,"
-    "\"regexCheckBox\":true,\"savePathEdit\":\"123\","
-    "\"saveReductionResultsCheckBox\":false,\"spaceRadioButton\":true,"
-    "\"tabRadioButton\":false,\"titleCheckBox\":true}}"};
-}
+const static QString MAINWINDOW_JSON_STRING {
+  "{\"batches\": [{\"saveView\": {\"commaRadioButton\": true, "
+  "\"spaceRadioButton\": false, \"regexCheckBox\": false, \"savePathEdit\": "
+  "\"\", \"saveReductionResultsCheckBox\": false, \"titleCheckBox\": false, "
+  "\"filterEdit\": \"\", \"tabRadioButton\": false, \"prefixEdit\": \"\", "
+  "\"qResolutionCheckBox\": false, \"fileFormatComboBox\": 0}, \"runsView\": "
+  "{\"comboSearchInstrument\": 0, \"runsTable\": {\"projectSave\": true, "
+  "\"filterBox\": \"\", \"runsTableModel\": [{\"rows\": "
+  "[{\"reductionWorkspaces\": {\"inputRunNumbers\": [\"13460\"], \"iVsQ\": "
+  "\"\", \"transPair\": {\"firstTransRuns\": [], \"secondTransRuns\": []}, "
+  "\"iVsLambda\": \"\", \"iVsQBinned\": \"\"}, \"transRunNums\": "
+  "{\"firstTransRuns\": [], \"secondTransRuns\": []}, \"scaleFactorPresent\": "
+  "false, \"qRangeOutput\": {\"maxPresent\": false, \"stepPresent\": false, "
+  "\"minPresent\": false}, \"reductionOptions\": {}, \"theta\": 0.5, "
+  "\"runNumbers\": [\"13460\"], \"qRange\": {\"maxPresent\": false, "
+  "\"stepPresent\": false, \"minPresent\": false}}], \"name\": \"123\", "
+  "\"postprocessedWorkspaceName\": \"\"}]}, \"textSearch\": \"123\"}, "
+  "\"eventView\": {\"disabledSlicingButton\": true, \"customEdit\": \"\", "
+  "\"logValueButton\": false, \"logValueEdit\": \"\", \"uniformEvenButton\": "
+  "false, \"logValueTypeEdit\": \"\", \"uniformButton\": false, "
+  "\"uniformEdit\": 1.0, \"customButton\": false, \"uniformEvenEdit\": 1}, "
+  "\"experimentView\": {\"perAngleDefaults\": {\"columnsNum\": 9, \"rows\": "
+  "[[\"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\"]], \"rowsNum\": 1}, "
+  "\"startOverlapEdit\": 10.0, \"analysisModeComboBox\": 0, "
+  "\"reductionTypeComboBox\": 0, \"stitchEdit\": \"\", "
+  "\"floodWorkspaceWsSelector\": 0, \"includePartialBinsCheckBox\": false, "
+  "\"summationTypeComboBox\": 0, \"transScaleRHSCheckBox\": true, "
+  "\"debugCheckbox\": false, \"transStitchParamsEdit\": \"\", "
+  "\"floodCorComboBox\": 0, \"endOverlapEdit\": 12.0, \"polCorrCheckBox\": "
+  "false}, \"instrumentView\": {\"monBgMaxEdit\": 18.0, \"I0MonitorIndex\": 2, "
+  "\"lamMinEdit\": 1.5, \"monIntMinEdit\": 4.0, \"intMonCheckBox\": true, "
+  "\"monIntMaxEdit\": 10.0, \"detectorCorrectionTypeComboBox\": 0, "
+  "\"correctDetectorsCheckBox\": true, \"lamMaxEdit\": 17.0, \"monBgMinEdit\": "
+  "17.0}}, {\"saveView\": {\"commaRadioButton\": true, \"spaceRadioButton\": "
+  "false, \"regexCheckBox\": false, \"savePathEdit\": \"\", "
+  "\"saveReductionResultsCheckBox\": false, \"titleCheckBox\": false, "
+  "\"filterEdit\": \"\", \"tabRadioButton\": false, \"prefixEdit\": \"\", "
+  "\"qResolutionCheckBox\": false, \"fileFormatComboBox\": 0}, \"runsView\": "
+  "{\"comboSearchInstrument\": 0, \"runsTable\": {\"projectSave\": true, "
+  "\"filterBox\": \"\", \"runsTableModel\": [{\"rows\": [{}], \"name\": "
+  "\"HiddenGroupName1\", \"postprocessedWorkspaceName\": \"\"}]}, "
+  "\"textSearch\": \"\"}, \"eventView\": {\"disabledSlicingButton\": true, "
+  "\"customEdit\": \"\", \"logValueButton\": false, \"logValueEdit\": \"\", "
+  "\"uniformEvenButton\": false, \"logValueTypeEdit\": \"\", "
+  "\"uniformButton\": false, \"uniformEdit\": 1.0, \"customButton\": false, "
+  "\"uniformEvenEdit\": 1}, \"experimentView\": {\"perAngleDefaults\": "
+  "{\"columnsNum\": 9, \"rows\": [[\"\", \"\", \"\", \"\", \"\", \"\", \"\", "
+  "\"\", \"\"]], \"rowsNum\": 1}, \"startOverlapEdit\": 10.0, "
+  "\"analysisModeComboBox\": 0, \"reductionTypeComboBox\": 0, \"stitchEdit\": "
+  "\"\", \"floodWorkspaceWsSelector\": 0, \"includePartialBinsCheckBox\": "
+  "false, \"summationTypeComboBox\": 0, \"transScaleRHSCheckBox\": true, "
+  "\"debugCheckbox\": false, \"transStitchParamsEdit\": \"\", "
+  "\"floodCorComboBox\": 0, \"endOverlapEdit\": 12.0, \"polCorrCheckBox\": "
+  "false}, \"instrumentView\": {\"monBgMaxEdit\": 18.0, \"I0MonitorIndex\": 2, "
+  "\"lamMinEdit\": 1.5, \"monIntMinEdit\": 4.0, \"intMonCheckBox\": true, "
+  "\"monIntMaxEdit\": 10.0, \"detectorCorrectionTypeComboBox\": 0, "
+  "\"correctDetectorsCheckBox\": true, \"lamMaxEdit\": 17.0, \"monBgMinEdit\": "
+  "17.0}}], \"tag\": \"ISIS Reflectometry\"}\" }";
+
+  const static QString BATCH_JSON_STRING{
+      "{\"eventView\":{\"customButton\":false,\"customEdit\":\"\", "
+      "\"disabledSlicingButton\":false,\"logValueButton\":false,"
+      "\"logValueEdit\":"
+      "\"\",\"logValueTypeEdit\":\"\",\"uniformButton\":true,\"uniformEdit\":3,"
+      "\"uniformEvenButton\":false,\"uniformEvenEdit\":2},\"experimentView\":{"
+      "\"analysisModeComboBox\":1,\"debugCheckbox\":true,\"endOverlapEdit\":13,"
+      "\"floodCorComboBox\":1,\"floodWorkspaceWsSelector\":0,"
+      "\"includePartialBinsCheckBox\":true,\"perAngleDefaults\":{"
+      "\"columnsNum\":"
+      "9,\"rows\":[[\"123\",\"123\",\"213\",\"123\",\"123\",\"123\",\"123\","
+      "\"123\",\"123\"]],\"rowsNum\":1},\"polCorrCheckBox\":false,"
+      "\"reductionTypeComboBox\":2,\"startOverlapEdit\":12,\"stitchEdit\":\"\","
+      "\"summationTypeComboBox\":1,\"transScaleRHSCheckBox\":true,"
+      "\"transStitchParamsEdit\":\"1\"},\"instrumentView\":{\"I0MonitorIndex\":"
+      "3,"
+      "\"correctDetectorsCheckBox\":false,\"detectorCorrectionTypeComboBox\":1,"
+      "\"intMonCheckBox\":false,\"lamMaxEdit\":18,\"lamMinEdit\":2.5,"
+      "\"monBgMaxEdit\":20,\"monBgMinEdit\":19,\"monIntMaxEdit\":11,"
+      "\"monIntMinEdit\":5},\"runsView\":{\"comboSearchInstrument\":0,"
+      "\"runsTable\":{\"filterBox\":\"123\",\"projectSave\":false,"
+      "\"runsTableModel\":[{\"name\":\"123\",\"postprocessedWorkspaceName\":"
+      "\"\","
+      "\"rows\":[{\"qRange\":{\"max\":0.1,\"maxPresent\":true,\"min\":0.1,"
+      "\"minPresent\":true,\"step\":0.1,\"stepPresent\":true},\"qRangeOutput\":"
+      "{"
+      "\"maxPresent\":false,\"minPresent\":false,\"stepPresent\":false},"
+      "\"reductionOptions\":{\"ProcessingInstructions\":\"1-4\"},"
+      "\"reductionWorkspaces\":{\"iVsLambda\":\"\",\"iVsQ\":\"\","
+      "\"iVsQBinned\":"
+      "\"\",\"inputRunNumbers\":[\"13460\"],\"transPair\":{\"firstTransRuns\":["
+      "\"123\"],\"secondTransRuns\":[\"1234\"]}},\"runNumbers\":[\"13460\"],"
+      "\"scaleFactor\":2,\"scaleFactorPresent\":true,\"theta\":0.5,"
+      "\"transRunNums\":{\"firstTransRuns\":[\"123\"],\"secondTransRuns\":["
+      "\"1234\"]}}]}]},\"textSearch\":\"1120015\"},\"saveView\":{"
+      "\"commaRadioButton\":false,\"fileFormatComboBox\":1,\"filterEdit\":"
+      "\"123\",\"prefixEdit\":\"123\",\"qResolutionCheckBox\":true,"
+      "\"regexCheckBox\":true,\"savePathEdit\":\"123\","
+      "\"saveReductionResultsCheckBox\":false,\"spaceRadioButton\":true,"
+      "\"tabRadioButton\":false,\"titleCheckBox\":true}}"};
+} // namespace
 
 /**
  * QApplication
@@ -100,7 +165,7 @@ public:
 
   void test_decodeBatch() {
     CoderCommonTester tester;
-    auto map = MantidQt::API::loadJSONFromString(JSON_STRING);
+    auto map = MantidQt::API::loadJSONFromString(BATCH_JSON_STRING);
     QtMainWindowView mwv;
     mwv.initLayout();
     auto gui = dynamic_cast<QtBatchView *>(mwv.batches()[0]);