ADSValidator.cpp

Go to the documentation of this file.

// 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/ADSValidator.h"
#include "MantidAPI/AnalysisDataService.h"
#include "MantidKernel/StringTokenizer.h"
#include "MantidKernel/TypedValidator.h"
#include <memory>
#include <sstream>
 
namespace Mantid::API {
 
ADSValidator::ADSValidator(const bool allowMultiSelection, const bool isOptional)
    : TypedValidator<std::vector<std::string>>(), m_AllowMultiSelection(allowMultiSelection), m_isOptional(isOptional) {
}
 
Kernel::IValidator_sptr ADSValidator::clone() const { return std::make_shared<ADSValidator>(*this); }
 
bool ADSValidator::isMultipleSelectionAllowed() { return m_AllowMultiSelection; }
 
void ADSValidator::setMultipleSelectionAllowed(const bool isMultiSelectionAllowed) {
  m_AllowMultiSelection = isMultiSelectionAllowed;
}
 
bool ADSValidator::isOptional() const { return m_isOptional; }
 
void ADSValidator::setOptional(const bool setOptional) { m_isOptional = setOptional; }
 
std::string ADSValidator::checkValidity(const std::vector<std::string> &value) const {
  if (!m_isOptional && value.empty())
    return "Select a value";
  if (!m_AllowMultiSelection && (value.size() > 1)) {
    return "Only one workspace was expected.";
  }
  auto &ads = AnalysisDataService::Instance();
  std::ostringstream os;
  for (const auto &wsName : value) {
    if (!ads.doesExist(wsName)) {
      os << "The workspace \"" << wsName << "\" is not in the workspace list.\n";
    }
  }
  return os.str();
}
 
std::vector<std::string> ADSValidator::allowedValues() const {
  // Get the list of workspaces currently in the ADS
  auto vals = AnalysisDataService::Instance().getObjectNames(Mantid::Kernel::DataServiceSort::Sorted);
  if (isOptional()) // Insert an empty option
  {
    vals.emplace_back("");
  }
  return vals;
}
 
} // namespace Mantid::API