IPropertySettings.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 "MantidKernel/IPropertySettings.h"
#include "MantidKernel/IPropertyManager.h"
#include "MantidPythonInterface/core/GetPointer.h"
#include <boost/python/class.hpp>
#include <boost/python/register_ptr_to_python.hpp>
 
using Mantid::Kernel::IPropertySettings;
using namespace boost::python;
 
GET_POINTER_SPECIALIZATION(IPropertySettings)
 
void export_IPropertySettings() {
  register_ptr_to_python<IPropertySettings *>();
 
  class_<IPropertySettings, boost::noncopyable>("IPropertySettings", no_init)
      .def("isEnabled", &IPropertySettings::isEnabled, (arg("self"), arg("alg")),
           "Is the property to be shown as enabled in the GUI. Default true.")
 
      .def("isVisible", &IPropertySettings::isVisible, (arg("self"), arg("alg")),
           "Is the property to be shown in the GUI? Default true.")
 
      .def("dependsOn", &IPropertySettings::dependsOn, (arg("self"), arg("thisProp")),
           "Other properties that this property depends on.")
 
      .def("_isConditionChanged", &IPropertySettings::isConditionChanged,
           (arg("self"), arg("alg"), arg("changedPropName")),
           "Has the dependency condition changed: exported for testing use only")
 
      .def("_applyChanges", &IPropertySettings::applyChanges, (arg("self"), arg("alg"), arg("currentProperty")),
           "Apply the changed criterion to the current property: exported for testing use only");
}