EnumeratedStringProperty.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 "MantidKernel/EnumeratedString.h"
#include "MantidKernel/Property.h"
#include <vector>
 
namespace Mantid {
 
namespace Kernel {
template <class E, std::vector<std::string> const *const names> class EnumeratedStringProperty : public Property {
 
  using ENUMSTRING = EnumeratedString<E, names>;
 
public:
  // CONSTRUCTORS
  EnumeratedStringProperty(std::string const &name, ENUMSTRING const &defaultValue = static_cast<E>(0),
                           Direction::Type const direction = Direction::Input);
  EnumeratedStringProperty(EnumeratedStringProperty const &right);
  EnumeratedStringProperty *clone() const override;
  EnumeratedStringProperty &operator=(EnumeratedStringProperty const &right);
 
  // GETTERS
  std::string value() const override;
  std::string valueAsPrettyStr(size_t const maxLength = 0, bool const collapseLists = true) const override;
  Json::Value valueAsJson() const override;
 
  bool operator==(EnumeratedStringProperty const &rhs) const;
  bool operator!=(EnumeratedStringProperty const &rhs) const;
  int size() const override;
  std::string getDefault() const override;
 
  operator ENUMSTRING() const { return this->m_value; };
  operator E() const { return static_cast<E>(m_value); };
  operator std::string() const { return static_cast<std::string>(m_value); };
 
  ENUMSTRING operator()() const;
  std::string isValid() const override;
  bool isDefault() const override;
  std::vector<std::string> allowedValues() const override;
 
  // SETTERS
  std::string setValue(E const value);
  std::string setValue(std::string const &value) override;
  std::string setValue(ENUMSTRING const &value);
  std::string setValueFromJson(const Json::Value &value) override;
  std::string setDataItem(const std::shared_ptr<DataItem> &data) override;
  EnumeratedStringProperty const &operator=(E const value);
  EnumeratedStringProperty const &operator=(std::string const &value);
  EnumeratedStringProperty const &operator=(ENUMSTRING const &value);
 
  // MUTATORS AND SUNDRY
  EnumeratedStringProperty &operator+=(Property const *right) override;
  void saveProperty(Nexus::File *file) override;
 
protected:
  ENUMSTRING m_value;
  ENUMSTRING m_initialValue;
 
private:
  std::string setValueFromProperty(Property const &right) override;
 
  template <typename U> std::string setTypedValue(U const &value, std::true_type const &);
 
  template <typename U> std::string setTypedValue(U const &value, std::false_type const &);
};
 
// template <typename TYPE> Logger PropertyWithValue<TYPE>::g_logger("PropertyWithValue");
 
} // namespace Kernel
} // namespace Mantid
 
#include "EnumeratedStringProperty.hxx"