WorkspaceUnitValidator.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 <utility>
 
#include "MantidAPI/Axis.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/WorkspaceUnitValidator.h"
#include "MantidKernel/Unit.h"
 
namespace Mantid::API {
 
WorkspaceUnitValidator::WorkspaceUnitValidator(std::string unitID)
    : MatrixWorkspaceValidator(), m_unitID(std::move(unitID)) {}
 
Kernel::IValidator_sptr WorkspaceUnitValidator::clone() const {
  return std::make_shared<WorkspaceUnitValidator>(*this);
}
 
std::string WorkspaceUnitValidator::checkValidity(const MatrixWorkspace_sptr &value) const {
  // This effectively checks for single-valued workspaces
  if (value->axes() == 0)
    return "A single valued workspace has no unit, which is required for "
           "this algorithm";
 
  Kernel::Unit_const_sptr unit = value->getAxis(0)->unit();
  // If m_unitID is empty it means that the workspace must have units, which
  // can be anything
  if (m_unitID.empty()) {
    return (unit && (!std::dynamic_pointer_cast<const Kernel::Units::Empty>(unit)) ? ""
                                                                                   : "The workspace must have units");
  }
  // now check if the units of the workspace is correct
  else {
    if ((!unit) || (unit->unitID().compare(m_unitID))) {
      return "The workspace must have units of " + m_unitID; //+ "; its unit is: " + unit->caption();
    } else
      return "";
  }
}
 
} // namespace Mantid::API