PythonObjectProperty.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidPythonInterface/core/DllConfig.h"
 
#include "MantidKernel/IValidator.h"
#include "MantidKernel/NullValidator.h"
#include "MantidKernel/PropertyWithValue.h"
 
#include <boost/python/object.hpp>
 
// forward declare
namespace Json {
class Value;
}
 
namespace Mantid::Kernel {
using PythonObject = boost::python::object;
 
// Instantiated and exported by PythonObjectProperty.cpp, where boost python is available
MANTID_PYTHONINTERFACE_CORE_EXTERN_TEMPLATE(PropertyWithValue<PythonObject>);
} // namespace Mantid::Kernel
 
namespace Mantid::PythonInterface {
 
using Mantid::Kernel::Direction;
using Mantid::Kernel::IValidator_sptr;
using Mantid::Kernel::NullValidator;
using Mantid::Kernel::PythonObject;
 
class MANTID_PYTHONINTERFACE_CORE_DLL PythonObjectProperty : public Mantid::Kernel::PropertyWithValue<PythonObject> {
public:
  // Convenience typedefs
  using ValueType = PythonObject;
  using BaseClass = Mantid::Kernel::PropertyWithValue<ValueType>;
 
  PythonObjectProperty() = delete;
 
  PythonObjectProperty(std::string const &name, PythonObject const &defaultValue,
                       IValidator_sptr const &validator = std::make_shared<NullValidator>(),
                       unsigned int const direction = Direction::Input)
      : BaseClass(name, defaultValue, validator, direction) {}
 
  PythonObjectProperty(std::string const &name, PythonObject const &defaultValue,
                       unsigned int const direction = Direction::Input)
      : BaseClass(name, defaultValue, std::make_shared<NullValidator>(), direction) {}
 
  PythonObjectProperty(std::string const &name, IValidator_sptr const &validator,
                       unsigned int const direction = Direction::Input)
      : BaseClass(name, PythonObject(), validator, direction) {}
 
  PythonObjectProperty(std::string const &name, unsigned int const direction = Direction::Input)
      : BaseClass(name, PythonObject(), std::make_shared<NullValidator>(), direction) {}
 
  PythonObjectProperty(std::string const &name, std::string const &strvalue,
                       IValidator_sptr const &validator = std::make_shared<NullValidator>(),
                       unsigned int const direction = Direction::Input)
      : BaseClass(name, PythonObject(), strvalue, validator, direction) {}
 
  PythonObjectProperty(PythonObjectProperty const &other) : BaseClass(other) {}
 
  PythonObjectProperty *clone() const override { return new PythonObjectProperty(*this); }
 
  // Unhide the base class assignment operator
  using BaseClass::operator=;
 
  std::string getDefault() const override;
  std::string setValue(PythonObject const &obj);
  std::string setValue(std::string const &value) override;
  std::string setValueFromJson(Json::Value const &value) override;
  std::string setDataItem(std::shared_ptr<Kernel::DataItem> const &value) override;
  bool isDefault() const override;
};
 
} // namespace Mantid::PythonInterface