UserInputValidator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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/MatrixWorkspace_fwd.h"
#include "MantidQtWidgets/Common/DataSelector.h"
#include "MantidQtWidgets/Common/DllOption.h"
#include "MantidQtWidgets/Common/FileFinderWidget.h"
#include "MantidQtWidgets/Common/WorkspaceSelector.h"
#include "MantidQtWidgets/Common/WorkspaceUtils.h"
#include <QStringList>
 
using MantidQt::API::FileFinderWidget;
using MantidQt::MantidWidgets::DataSelector;
using MantidQt::MantidWidgets::WorkspaceSelector;
 
class QLineEdit;
class QLabel;
class QString;
 
namespace MantidQt {
namespace CustomInterfaces {
 
class EXPORT_OPT_MANTIDQT_COMMON IUserInputValidator {
public:
  virtual ~IUserInputValidator() = default;
 
  virtual bool checkFieldIsNotEmpty(const QString &name, QLineEdit *field, QLabel *errorLabel = nullptr) = 0;
  virtual bool checkFieldIsValid(const QString &errorMessage, QLineEdit *field, QLabel *errorLabel = nullptr) = 0;
  virtual bool checkWorkspaceSelectorIsNotEmpty(const QString &name, WorkspaceSelector *workspaceSelector) = 0;
  virtual bool checkFileFinderWidgetIsValid(const QString &name, const FileFinderWidget *widget) = 0;
  virtual bool checkDataSelectorIsValid(const QString &name, DataSelector *widget, bool const silent = false,
                                        bool const autoLoad = true) = 0;
  virtual bool checkWorkspaceGroupIsValid(QString const &groupName, QString const &inputType, bool silent = false) = 0;
  virtual bool checkWorkspaceExists(QString const &workspaceName, bool silent = false) = 0;
  virtual bool checkValidRange(const QString &name, std::pair<double, double> range) = 0;
  virtual bool checkRangesDontOverlap(std::pair<double, double> rangeA, std::pair<double, double> rangeB) = 0;
  virtual bool checkRangeIsEnclosed(const QString &outerName, std::pair<double, double> outer, const QString &innerName,
                                    std::pair<double, double> inner) = 0;
  virtual bool checkBins(double lower, double binWidth, double upper, double tolerance = 0.00000001) = 0;
  template <typename T = Mantid::API::MatrixWorkspace>
  bool checkWorkspaceType(QString const &workspaceName, QString const &inputType, QString const &validType,
                          bool silent = false);
 
  virtual void setErrorLabel(QLabel *errorLabel, bool valid) = 0;
 
  virtual void addErrorMessage(const std::string &message, bool const silent = false) = 0;
 
  virtual std::string generateErrorMessage() const = 0;
  virtual bool isAllInputValid() const = 0;
};
 
class EXPORT_OPT_MANTIDQT_COMMON UserInputValidator final : public IUserInputValidator {
public:
  UserInputValidator();
  ~UserInputValidator() override;
 
  bool checkFieldIsNotEmpty(const QString &name, QLineEdit *field, QLabel *errorLabel = nullptr) override;
  bool checkFieldIsValid(const QString &errorMessage, QLineEdit *field, QLabel *errorLabel = nullptr) override;
  bool checkWorkspaceSelectorIsNotEmpty(const QString &name, WorkspaceSelector *workspaceSelector) override;
  bool checkFileFinderWidgetIsValid(const QString &name, const FileFinderWidget *widget) override;
  bool checkDataSelectorIsValid(const QString &name, DataSelector *widget, bool const silent = false,
                                bool const autoLoad = true) override;
  bool checkValidRange(const QString &name, std::pair<double, double> range) override;
  bool checkRangesDontOverlap(std::pair<double, double> rangeA, std::pair<double, double> rangeB) override;
  bool checkRangeIsEnclosed(const QString &outerName, std::pair<double, double> outer, const QString &innerName,
                            std::pair<double, double> inner) override;
  bool checkBins(double lower, double binWidth, double upper, double tolerance = 0.00000001) override;
  bool checkNotEqual(const QString &name, double x, double y = 0.0, double tolerance = 0.00000001);
 
  bool checkWorkspaceExists(QString const &workspaceName, bool silent = false) override;
  bool checkWorkspaceNumberOfHistograms(QString const &workspaceName, std::size_t const &validSize);
  bool checkWorkspaceNumberOfHistograms(const Mantid::API::MatrixWorkspace_sptr &, std::size_t const &validSize);
  bool checkWorkspaceNumberOfBins(QString const &workspaceName, std::size_t const &validSize);
  bool checkWorkspaceNumberOfBins(const Mantid::API::MatrixWorkspace_sptr &, std::size_t const &validSize);
  bool checkWorkspaceGroupIsValid(QString const &groupName, QString const &inputType, bool silent = false) override;
 
  void addErrorMessage(const std::string &message, bool const silent = false) override;
 
  void setErrorLabel(QLabel *errorLabel, bool valid) override;
 
  std::string generateErrorMessage() const override;
  bool isAllInputValid() const override;
 
private:
  QStringList m_errorMessages;
  bool m_error;
};
 
template <typename T>
bool IUserInputValidator::checkWorkspaceType(QString const &workspaceName, QString const &inputType,
                                             QString const &validType, bool silent) {
  if (!checkWorkspaceExists(workspaceName, silent)) {
    return false;
  }
 
  if (!MantidWidgets::WorkspaceUtils::getADSWorkspace<T>(workspaceName.toStdString())) {
    addErrorMessage("The " + inputType.toStdString() + " workspace is not a " + validType.toStdString() + ".", silent);
    return false;
  }
  return true;
}
 
} // namespace CustomInterfaces
} // namespace MantidQt