Mantid::PythonInterface::Registry::PropertyValueHandler Struct Reference

This class provides a base-class objects that are able to take a python object and set it on an algorithm property. More...

#include <PropertyValueHandler.h>

Inheritance diagram for Mantid::PythonInterface::Registry::PropertyValueHandler:

Public Member Functions
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

This class provides a base-class objects that are able to take a python object and set it on an algorithm property.

The set function should call the setProperty method once it has the correct C++ type from the Python object

Definition at line 30 of file PropertyValueHandler.h.

Constructor & Destructor Documentation

~PropertyValueHandler()

virtual Mantid::PythonInterface::Registry::PropertyValueHandler::~PropertyValueHandler ( )

virtualdefault

Virtual Destructor.

Member Function Documentation

create()

virtual std::unique_ptr< Kernel::Property > Mantid::PythonInterface::Registry::PropertyValueHandler::create ( const std::string &  name, const boost::python::object &  value, const boost::python::object &  validator, const unsigned int  direction  ) const

pure virtual

Overload to create a Property type from the given value with no validation.

Implemented in Mantid::PythonInterface::Registry::TypedPropertyValueHandler< std::shared_ptr< T >, std::enable_if< std::is_base_of< API::Workspace, T >::value >::type >, Mantid::PythonInterface::Registry::SequenceTypeHandler< ContainerType >, Mantid::PythonInterface::Registry::TypedPropertyValueHandler< ValueType, Enable >, and Mantid::PythonInterface::Registry::TypedPropertyValueHandler< ContainerType >.

set()

virtual void Mantid::PythonInterface::Registry::PropertyValueHandler::set ( Kernel::IPropertyManager *  alg, const std::string &  name, const boost::python::object &  value  ) const

pure virtual

Overload to set the named property's value on the property manager.

Implemented in Mantid::PythonInterface::Registry::TypedPropertyValueHandler< std::shared_ptr< T >, std::enable_if< std::is_base_of< API::Workspace, T >::value >::type >, Mantid::PythonInterface::Registry::SequenceTypeHandler< ContainerType >, Mantid::PythonInterface::Registry::TypedPropertyValueHandler< ValueType, Enable >, and Mantid::PythonInterface::Registry::TypedPropertyValueHandler< ContainerType >.

---

The documentation for this struct was generated from the following file:

• Framework/PythonInterface/mantid/kernel/inc/MantidPythonInterface/kernel/Registry/PropertyValueHandler.h