SpinStateValidator.h

Go to the documentation of this file.

// 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 +
 
#pragma once
 
#include "MantidKernel/DllConfig.h"
#include "MantidKernel/IValidator.h"
#include "MantidKernel/TypedValidator.h"
#include <unordered_set>
 
namespace Mantid::Kernel {
 
/*
Will check that a string matches the form 01,00 or 00,10,11,01, for example. This is used for
specifying the order of input workspaces relative to spin states. There is also a method to
extract the relevant workspace for a given spin state from a group workspace, given a
particular ordering.
*/
class MANTID_KERNEL_DLL SpinStateValidator : public Kernel::TypedValidator<std::string> {
public:
  SpinStateValidator(std::unordered_set<int> allowedNumbersOfSpins, const bool acceptSingleStates = false,
                     const std::string &paraIndicator = "0", const std::string &antiIndicator = "1",
                     const bool optional = false, const std::string &extraIndicator = "");
  SpinStateValidator(std::unordered_set<int> allowedNumbersOfSpins, const bool acceptSingleStates,
                     const std::string &paraIndicator, const std::string &antiIndicator, const bool optional,
                     const std::string &extraIndicator, const bool rejectRepeatedSpinStates);
  Kernel::IValidator_sptr clone() const override;
 
  static bool anyOfIsInSet(const std::vector<std::string> &anyOf, const std::unordered_set<std::string> &set);
  static bool setContains(const std::unordered_set<std::string> &set, const std::string &s) {
    return set.find(s) != set.cend();
  }
 
private:
  std::string checkValidity(const std::string &input) const override;
  std::unordered_set<int> m_allowedNumbersOfSpins = {1, 2, 3, 4};
  const std::unordered_set<std::string> getAllowedPairStates() const;
  const std::unordered_set<std::string> getAllowedSingleStates() const;
  bool m_acceptSingleStates = false;
  const std::string m_para;
  const std::string m_anti;
  bool m_optional = false;
  // Extra value to indicate a third spin state (for example 0)
  const std::string m_extra;
  const bool m_rejectRepeatedSpinStates;
};
} // namespace Mantid::Kernel