EnabledWhenProperty.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/EnabledWhenProperty.h"
#include <boost/python/class.hpp>
#include <boost/python/enum.hpp>
 
using namespace Mantid::Kernel;
using namespace boost::python;
 
void export_EnabledWhenProperty() {
  // State enumeration
  enum_<ePropertyCriterion>("PropertyCriterion")
      .value("IsDefault", IS_DEFAULT)
      .value("IsNotDefault", IS_NOT_DEFAULT)
      .value("IsEqualTo", IS_EQUAL_TO)
      .value("IsNotEqualTo", IS_NOT_EQUAL_TO)
      .value("IsMoreOrEqual", IS_MORE_OR_EQ);
 
  // Logic enumeration
  enum_<eLogicOperator>("LogicOperator").value("And", AND).value("Or", OR).value("Xor", XOR);
 
  class_<EnabledWhenProperty, bases<IPropertySettings>>("EnabledWhenProperty", no_init) // no default constructor
 
      .def(init<std::string, ePropertyCriterion, std::string>(
          (arg("self"), arg("otherPropName"), arg("when"), arg("value")),
          "Enabled otherPropName property when value criterion meets that "
          "given by the 'when' argument"))
 
      .def(init<std::string, ePropertyCriterion>((arg("self"), arg("otherPropName"), arg("when")),
                                                 "Enabled otherPropName property when criterion does not require a "
                                                 "value, i.e isDefault"))
 
      .def(init<EnabledWhenProperty, EnabledWhenProperty, eLogicOperator>(
          (arg("self"), arg("conditionObjOne"), arg("conditionObjTwo"), arg("operator")),
          "Enables property when the two EnabledWhenProperty conditions match"
          " the operator condition"));
}