InstrumentValidator.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/InstrumentValidator.h"
#include "MantidAPI/ExperimentInfo.h"
#include "MantidGeometry/Instrument.h"
#include "MantidKernel/Strings.h"
#include <list>
#include <memory>
 
namespace Mantid::API {
using Kernel::Strings::join;
 
InstrumentValidator::InstrumentValidator(const unsigned int flags) : m_requires(flags) {}
 
std::string InstrumentValidator::getType() const { return "Instrument"; }
 
Kernel::IValidator_sptr InstrumentValidator::clone() const { return std::make_shared<InstrumentValidator>(*this); }
 
std::string InstrumentValidator::checkValidity(const std::shared_ptr<ExperimentInfo> &value) const {
  const auto inst = value->getInstrument();
  if (!inst)
    return "The workspace must have an instrument defined";
 
  std::list<std::string> missing;
  if ((m_requires & SourcePosition) && !inst->hasSource()) {
    missing.emplace_back("source");
  }
  if ((m_requires & SamplePosition) && !inst->hasSample()) {
    missing.emplace_back("sample holder");
  }
 
  if (missing.empty())
    return "";
  else {
    return "The instrument is missing the following "
           "components: " +
           join(missing.begin(), missing.end(), ",");
  }
}
 
} // namespace Mantid::API