Defines a handler class for converting a Python mapping type object to a C++ PropertyManager type. More...
#include <MappingTypeHandler.h>
Inheritance diagram for Mantid::PythonInterface::Registry::MappingTypeHandler:
Private Member Functions | |
| std::unique_ptr< Kernel::Property > | create (const std::string &name, const boost::python::api::object &defaultValue, const boost::python::api::object &validator, const unsigned int direction) const override |
| Always throws a runtime_error. More... | |
| void | set (Kernel::IPropertyManager *alg, const std::string &name, const boost::python::api::object &mapping) const override |
| Sets the named property in the PropertyManager by extracting a new PropertyManager from the Python object. More... | |
Additional Inherited Members | |
 Public Member Functions inherited from Mantid::PythonInterface::Registry::PropertyValueHandler | |
| virtual std::unique_ptr< Kernel::Property > | create (const std::string &name, const boost::python::object &value, const boost::python::object &validator, const unsigned int direction) const =0 |
| Overload to create a Property type from the given value with no validation. More... | |
| virtual void | set (Kernel::IPropertyManager *alg, const std::string &name, const boost::python::object &value) const =0 |
| Overload to set the named property's value on the property manager. More... | |
| virtual | ~PropertyValueHandler ()=default |
| Virtual Destructor. More... | |
Detailed Description
Defines a handler class for converting a Python mapping type object to a C++ PropertyManager type.
Definition at line 19 of file MappingTypeHandler.h.
Member Function Documentation
◆ create()
|
overrideprivate |
Always throws a runtime_error.
Use the PropertyManagerProperty directly
- Parameters
-
name The name of the property defaultValue A default value for the property. validator A python object pointing to a validator instance, which can be None. direction The direction of the property
- Returns
- A pointer to a newly constructed property instance
Definition at line 54 of file MappingTypeHandler.cpp.
References Mantid::Kernel::createPropertyManager().
◆ set()
|
overrideprivate |
Sets the named property in the PropertyManager by extracting a new PropertyManager from the Python object.
- Parameters
-
alg A pointer to the PropertyManager containing the named property name The name of the property to update mapping The new value of the property
Definition at line 34 of file MappingTypeHandler.cpp.
References Mantid::Kernel::createPropertyManager(), and Mantid::Kernel::IPropertyManager::setProperty().
The documentation for this class was generated from the following files:
- Framework/PythonInterface/mantid/kernel/inc/MantidPythonInterface/kernel/Registry/MappingTypeHandler.h
- Framework/PythonInterface/mantid/kernel/src/Registry/MappingTypeHandler.cpp
