WorkspacePropertyExporter.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 "MantidAPI/WorkspaceProperty.h"
#include "MantidKernel/IValidator.h"
#include "MantidPythonInterface/core/PropertyWithValueExporter.h"
#include <boost/python/args.hpp>
#include <boost/python/make_constructor.hpp>
#include <boost/python/register_ptr_to_python.hpp>
 
namespace Mantid {
namespace PythonInterface {
template <typename WorkspaceType> struct WorkspacePropertyExporter {
  using TypedWorkspaceProperty = Mantid::API::WorkspaceProperty<WorkspaceType>;
  using WorkspaceType_sptr = std::shared_ptr<WorkspaceType>;
 
  static TypedWorkspaceProperty *createPropertyWithValidator(const std::string &name, const std::string &wsName,
                                                             const unsigned int direction,
                                                             Kernel::IValidator const *validator) {
    return new TypedWorkspaceProperty(name, wsName, direction, validator->clone());
  }
 
  static TypedWorkspaceProperty *createPropertyWithOptionalFlag(const std::string &name, const std::string &wsName,
                                                                const unsigned int direction,
                                                                API::PropertyMode::Type optional,
                                                                Kernel::IValidator const *validator) {
    return new TypedWorkspaceProperty(name, wsName, direction, optional, validator->clone());
  }
 
  static TypedWorkspaceProperty *createPropertyWithLockFlag(const std::string &name, const std::string &wsName,
                                                            const unsigned int direction,
                                                            API::PropertyMode::Type optional,
                                                            API::LockMode::Type locking,
                                                            Kernel::IValidator const *validator) {
    return new TypedWorkspaceProperty(name, wsName, direction, optional, locking, validator->clone());
  }
 
  static Mantid::API::Workspace_sptr value(const TypedWorkspaceProperty &self) { return self.operator()(); }
 
  static void define(const char *pythonClassName) {
    using namespace boost::python;
    using Mantid::API::IWorkspaceProperty;
    using Mantid::Kernel::PropertyWithValue;
 
    std::string basePropName = std::string(pythonClassName) + "PropertyWithValue";
    PropertyWithValueExporter<WorkspaceType_sptr>::define(basePropName.c_str());
    register_ptr_to_python<TypedWorkspaceProperty *>();
 
    class_<TypedWorkspaceProperty, bases<PropertyWithValue<WorkspaceType_sptr>, IWorkspaceProperty>,
           boost::noncopyable>(pythonClassName, no_init)
        .def(init<const std::string &, const std::string &, const unsigned int>(
            args("name", "defaultValue", "direction")))
        .def(init<const std::string &, const std::string &, const unsigned int, API::PropertyMode::Type>(
            args("name", "defaultValue", "direction", "optional")))
        .def(init<const std::string &, const std::string &, const unsigned int, API::PropertyMode::Type,
                  API::LockMode::Type>(args("name", "defaultValue", "direction", "optional", "locking")))
        // These variants require the validator object to be cloned
        .def("__init__", make_constructor(&createPropertyWithValidator, default_call_policies(),
                                          (arg("name"), arg("defaultValue"), arg("direction"), arg("validator"))))
        .def("__init__", make_constructor(&createPropertyWithOptionalFlag, default_call_policies(),
                                          args("name", "defaultValue", "direction", "optional", "validator")))
        .def("__init__",
             make_constructor(&createPropertyWithLockFlag, default_call_policies(),
                              args("name", "defaultValue", "direction", "optional", "locking", "validator")))
        .def("isOptional", &TypedWorkspaceProperty::isOptional, arg("self"),
             "Returns true if the property has been marked as optional")
 
        .add_property("value", &value);
  }
};
} // namespace PythonInterface
} // namespace Mantid