Merge pull request #38010 from mantidproject/ewm6817-create-TableWorkspaceValidator

Create TableWorkspaceValidator

Author: KedoKudo

Framework/DataObjects/CMakeLists.txt

@@ -47,6 +47,7 @@ set(SRC_FILES
     src/SplittersWorkspace.cpp
     src/TableColumn.cpp
     src/TableWorkspace.cpp
+    src/TableWorkspaceNotEmptyValidator.cpp
     src/TimeSplitter.cpp
     src/VectorColumn.cpp
     src/Workspace2D.cpp
@@ -128,6 +129,8 @@ set(INC_FILES
     inc/MantidDataObjects/SplittersWorkspace.h
     inc/MantidDataObjects/TableColumn.h
     inc/MantidDataObjects/TableWorkspace.h
+    inc/MantidDataObjects/TableWorkspaceValidator.h
+    inc/MantidDataObjects/TableWorkspaceNotEmptyValidator.h
     inc/MantidDataObjects/TableWorkspace_fwd.h
     inc/MantidDataObjects/TimeSplitter.h
     inc/MantidDataObjects/VectorColumn.h

Framework/DataObjects/inc/MantidDataObjects/TableWorkspaceNotEmptyValidator.h

@@ -0,0 +1,31 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2015 ISIS Rutherford Appleton Laboratory UKRI,
+//   NScD Oak Ridge National Laboratory, European Spallation Source,
+//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
+// SPDX - License - Identifier: GPL - 3.0 +
+#pragma once
+
+#include "MantidDataObjects/TableWorkspaceValidator.h"
+
+namespace Mantid {
+namespace DataObjects {
+
+/**
+  A validator which checks that the table workspace is not empty.
+*/
+class MANTID_DATAOBJECTS_DLL TableWorkspaceNotEmptyValidator : public TableWorkspaceValidator {
+public:
+  explicit TableWorkspaceNotEmptyValidator();
+  /// Gets the type of the validator
+  std::string getType() const { return "notempty"; }
+  /// Clone the current state
+  Kernel::IValidator_sptr clone() const override;
+
+private:
+  /// Check for validity.
+  std::string checkValidity(const TableWorkspace_sptr &value) const override;
+};
+
+} // namespace DataObjects
+} // namespace Mantid

Framework/DataObjects/inc/MantidDataObjects/TableWorkspaceValidator.h

@@ -0,0 +1,22 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2015 ISIS Rutherford Appleton Laboratory UKRI,
+//   NScD Oak Ridge National Laboratory, European Spallation Source,
+//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
+// SPDX - License - Identifier: GPL - 3.0 +
+#pragma once
+
+#include "MantidAPI/DllConfig.h"
+#include "MantidDataObjects/TableWorkspace.h"
+#include "MantidKernel/TypedValidator.h"
+
+namespace Mantid {
+namespace DataObjects {
+
+/**
+  An interface for those validators that require the MatrixWorkspace interface
+*/
+class MANTID_DATAOBJECTS_DLL TableWorkspaceValidator : public Kernel::TypedValidator<TableWorkspace_sptr> {};
+
+} // namespace DataObjects
+} // namespace Mantid

Framework/DataObjects/src/TableWorkspaceNotEmptyValidator.cpp

@@ -0,0 +1,40 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
+//   NScD Oak Ridge National Laboratory, European Spallation Source,
+//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
+// SPDX - License - Identifier: GPL - 3.0 +
+#include <utility>
+
+#include "MantidDataObjects/TableWorkspaceNotEmptyValidator.h"
+
+namespace Mantid::DataObjects {
+
+/** Constructor
+ *
+ */
+TableWorkspaceNotEmptyValidator::TableWorkspaceNotEmptyValidator() : TableWorkspaceValidator() {}
+
+/**
+ * Clone the current state
+ */
+Kernel::IValidator_sptr TableWorkspaceNotEmptyValidator::clone() const {
+  return std::make_shared<TableWorkspaceNotEmptyValidator>(*this);
+}
+
+/** Checks that the workspace is not empty
+ *
+ * @return A user level description of the error or "" for no error
+ */
+std::string TableWorkspaceNotEmptyValidator::checkValidity(const TableWorkspace_sptr &value) const {
+  if (value->columnCount() == 0) {
+    return "The workspace must have at least 1 column";
+  }
+  if (value->rowCount() == 0) {
+    return "The workspace must have at least 1 row";
+  }
+
+  return "";
+}
+
+} // namespace Mantid::DataObjects

Framework/PythonInterface/mantid/dataobjects/CMakeLists.txt

@@ -33,6 +33,7 @@ set(EXPORT_FILES
     src/Exports/NoShape.cpp
     src/Exports/PeakShapeSpherical.cpp
     src/Exports/PeakShapeEllipsoid.cpp
+    src/Exports/WorkspaceValidators.cpp
 )
 
 set(MODULE_DEFINITION ${CMAKE_CURRENT_BINARY_DIR}/dataobjects.cpp)

Framework/PythonInterface/mantid/dataobjects/src/Exports/WorkspaceValidators.cpp

@@ -0,0 +1,52 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
+//   NScD Oak Ridge National Laboratory, European Spallation Source,
+//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
+// SPDX - License - Identifier: GPL - 3.0 +
+
+#include "MantidAPI/ITableWorkspace.h"
+#include "MantidDataObjects/TableWorkspace.h"
+#include "MantidDataObjects/TableWorkspaceNotEmptyValidator.h"
+#include "MantidDataObjects/TableWorkspaceValidator.h"
+#include "MantidPythonInterface/core/TypedValidatorExporter.h"
+#include <boost/python/class.hpp>
+
+using Mantid::API::ITableWorkspace_sptr;
+using Mantid::Kernel::TypedValidator;
+using Mantid::PythonInterface::TypedValidatorExporter;
+using namespace boost::python;
+
+/// This is the base TypedValidator for most of the WorkspaceValidators
+void export_TableWorkspaceValidator() {
+  using Mantid::DataObjects::TableWorkspace_sptr;
+  using Mantid::DataObjects::TableWorkspaceValidator;
+  TypedValidatorExporter<TableWorkspace_sptr>::define("TableWorkspaceValidator");
+  TypedValidatorExporter<ITableWorkspace_sptr>::define("ITableWorkspaceValidator");
+
+  class_<TableWorkspaceValidator, bases<TypedValidator<TableWorkspace_sptr>>, boost::noncopyable>(
+      "TableWorkspaceValidator", no_init);
+
+  class_<TypedValidator<ITableWorkspace_sptr>, boost::noncopyable>("ITableWorkspaceValidator", no_init);
+}
+/// Export a validator derived from a TableWorkspaceValidator that has a no-arg
+/// constructor
+#define EXPORT_WKSP_VALIDATOR_NO_ARG(ValidatorType, DocString)                                                         \
+  class_<ValidatorType, bases<TableWorkspaceValidator>, boost::noncopyable>(#ValidatorType, init<>(DocString));
+/// Export a validator derived from a MatrixWorkspaceValidator that has a
+/// single-arg constructor
+#define EXPORT_WKSP_VALIDATOR_ARG(ValidatorType, ArgType, ArgName, DocString)                                          \
+  class_<ValidatorType, bases<TableWorkspaceValidator>, boost::noncopyable>(#ValidatorType,                            \
+                                                                            init<ArgType>(arg(ArgName), DocString));
+/// Export a validator derived from a MatrixWorkspaceValidator that has a
+/// single-arg constructor
+/// with a default argument
+#define EXPORT_WKSP_VALIDATOR_DEFAULT_ARG(ValidatorType, ArgType, ArgName, DefaultValue, DocString)                    \
+  class_<ValidatorType, bases<TableWorkspaceValidator>, boost::noncopyable>(                                           \
+      #ValidatorType, init<ArgType>(arg(ArgName) = DefaultValue, DocString));
+
+void export_WorkspaceValidators() {
+  using namespace Mantid::DataObjects;
+
+  EXPORT_WKSP_VALIDATOR_NO_ARG(TableWorkspaceNotEmptyValidator, "Checks that the workspace is not empty");
+}

Framework/PythonInterface/test/python/mantid/dataobjects/CMakeLists.txt

@@ -1,7 +1,7 @@
 # mantid.dataobjects tests
 
 set(TEST_PY_FILES EventListTest.py GroupingWorkspaceTest.py SpecialWorkspace2DTest.py Workspace2DPickleTest.py
-                  PeakShapes.py
+                  PeakShapes.py WorkspaceValidatorsTest.py
 )
 
 check_tests_valid(${CMAKE_CURRENT_SOURCE_DIR} ${TEST_PY_FILES})

Framework/PythonInterface/test/python/mantid/dataobjects/WorkspaceValidatorsTest.py

@@ -0,0 +1,70 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2024 ISIS Rutherford Appleton Laboratory UKRI,
+#   NScD Oak Ridge National Laboratory, European Spallation Source,
+#   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
+# SPDX - License - Identifier: GPL - 3.0 +
+"""
+   Test construction of the WorkspaceValidators
+"""
+import unittest
+import testhelpers
+
+from mantid.dataobjects import TableWorkspaceNotEmptyValidator
+
+from mantid.simpleapi import CreateEmptyTableWorkspace
+from mantid.api import ITableWorkspace, PythonAlgorithm, WorkspaceProperty
+from mantid.kernel import Direction
+
+
+class WorkspaceValidatorsTest(unittest.TestCase):
+
+    def test_TableWorkspaceNotEmptyValidator_construction(self):
+        """
+        Test that the TableWorkspaceNotEmptyValidator can be constructed
+        """
+
+        # test the validator can be constructed without error
+        testhelpers.assertRaisesNothing(self, TableWorkspaceNotEmptyValidator)
+
+    def test_TableWorkspaceNotEmptyValidator_usage(self):
+
+        class TestAlgorithm(PythonAlgorithm):
+            """Mock an extended algorithm that uses TableWorkspaceNotEmptyValidator"""
+
+            def PyInit(self):
+                self.declareProperty(
+                    WorkspaceProperty(
+                        name="InputWorkspace", defaultValue="", direction=Direction.Input, validator=TableWorkspaceNotEmptyValidator()
+                    )
+                )
+
+            def PyExec(self):
+                pass
+
+        # setup the algorithm
+        alg = TestAlgorithm()
+        alg.PyInit()
+
+        # setup the table workspace
+        tableWS = CreateEmptyTableWorkspace()
+
+        # test the validator rejects an 0-column 0-row TableWorkspace
+        self.assertRaises(ValueError, alg.setProperty, "InputWorkspace", tableWS)
+
+        # test the validator rejects a n-column, 0-row TableWorkspace
+        tableWS.addColumn("int", "values0")
+        self.assertRaises(ValueError, alg.setProperty, "InputWorkspace", tableWS)
+
+        tableWS.addColumn("int", "values1")
+        tableWS.addColumn("int", "values2")
+        self.assertRaises(ValueError, alg.setProperty, "InputWorkspace", tableWS)
+
+        # test the validator accepts a filled TableWorkspace
+        tableWS.addRow([1, 2, 3])
+        tableWS.addRow([4, 5, 6])
+        testhelpers.assertRaisesNothing(self, alg.setProperty, "InputWorkspace", tableWS)
+
+
+if __name__ == "__main__":
+    unittest.main()

docs/source/release/v6.12.0/Framework/Python/New_features/38010.rst

@@ -0,0 +1 @@
+- Adds `TableWorkspaceNotEmptyValidator`