A helper struct to export templated DataService<> types to Python. More...

#include <DataServiceExporter.h>

Public Types
using	PythonType = boost::python::class_< SvcType, boost::noncopyable >

using	WeakPtr = std::weak_ptr< typename SvcPtrType::element_type >

Static Public Member Functions
static void	addItem (SvcType &self, const std::string &name, const boost::python::object &item)
	Add an item into the service, if it exists then an error is raised.

static void	addOrReplaceItem (SvcType &self, const std::string &name, const boost::python::object &item)
	Add or replace an item into the service, if it exists then an error is raised.

static void	clearItems (SvcType &self, const bool silent)
	Remove an item from the service.

static PythonType	define (const char *pythonClassName)
	Define the necessary boost.python framework to expor the templated DataService type Note: This does not add the Instance method as that is on the SingletonHolder typedef.

static SvcPtrType	extractCppValue (const boost::python::object &pyvalue)
	Extract a SvcPtrType C++ value from the Python object.

static boost::python::list	getObjectNamesAsList (SvcType const *const self, const std::string &contain)
	Return a Python list of object names from the ADS as this is far easier to work with than a set.

static void	removeItem (SvcType &self, const std::string &name)
	Remove an item from the service.

static WeakPtr	retrieveOrKeyError (const SvcType *const self, const std::string &name)
	Retrieves a shared_ptr from the ADS and raises a Python KeyError if it does not exist.

Detailed Description

template<typename SvcType, typename SvcPtrType>
struct Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >

A helper struct to export templated DataService<> types to Python.

Template Parameters

SvcType	Type of DataService to export
SvcHeldType	The type held within the DataService map

Definition at line 29 of file DataServiceExporter.h.

Member Typedef Documentation

◆ PythonType

template<typename SvcType , typename SvcPtrType >

using Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::PythonType = boost::python::class_<SvcType, boost::noncopyable>

Definition at line 31 of file DataServiceExporter.h.

◆ WeakPtr

template<typename SvcType , typename SvcPtrType >

using Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::WeakPtr = std::weak_ptr<typename SvcPtrType::element_type>

Definition at line 32 of file DataServiceExporter.h.

Member Function Documentation

◆ addItem()

template<typename SvcType , typename SvcPtrType >

static void Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::addItem	(	SvcType &	self,
		const std::string &	name,
		const boost::python::object &	item
	)

inlinestatic

Add an item into the service, if it exists then an error is raised.

Parameters

self	A reference to the calling object
name	The name to assign to this in the service
item	A boost.python wrapped SvcHeldType object

Definition at line 89 of file DataServiceExporter.h.

References Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::extractCppValue(), and name.

Referenced by Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::define().

◆ addOrReplaceItem()

template<typename SvcType , typename SvcPtrType >

static void Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::addOrReplaceItem	(	SvcType &	self,
		const std::string &	name,
		const boost::python::object &	item
	)

inlinestatic

Add or replace an item into the service, if it exists then an error is raised.

Parameters

self	A reference to the calling object
name	The name to assign to this in the service
item	A boost.python wrapped SvcHeldType object

Definition at line 101 of file DataServiceExporter.h.

References Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::extractCppValue(), and name.

Referenced by Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::define().

◆ clearItems()

template<typename SvcType , typename SvcPtrType >

static void Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::clearItems	(	SvcType &	self,
		const bool	silent
	)

inlinestatic

Remove an item from the service.

Parameters

self	A reference to the calling object
silent	A flag to silence the warning message

Definition at line 121 of file DataServiceExporter.h.

Referenced by Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::define().

◆ define()

template<typename SvcType , typename SvcPtrType >

static PythonType Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::define ( const char * pythonClassName )

inlinestatic

Define the necessary boost.python framework to expor the templated DataService type Note: This does not add the Instance method as that is on the SingletonHolder typedef.

To add this call the following methods on the object this function returns .def("Instance", &SingletonType::Instance, return_value_policy<reference_existing_object>(), "Return a reference to the ADS singleton") .staticmethod("Instance") where SingletonType is the typedef of the SingletonHolder, e.g. AnalysisDataService

Parameters

pythonClassName The name that the class should have in Python

Returns: The new class object that wraps the given C++ type

Definition at line 49 of file DataServiceExporter.h.

References Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::addItem(), Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::addOrReplaceItem(), Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::clearItems(), Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::getObjectNamesAsList(), Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::removeItem(), and Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::retrieveOrKeyError().

◆ extractCppValue()

template<typename SvcType , typename SvcPtrType >

static SvcPtrType Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::extractCppValue ( const boost::python::object & pyvalue )

inlinestatic

Extract a SvcPtrType C++ value from the Python object.

Parameters

pyvalue Value of the

Returns: The extracted value or thows an std::invalid_argument error

Definition at line 136 of file DataServiceExporter.h.

Referenced by Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::addItem(), and Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::addOrReplaceItem().

◆ getObjectNamesAsList()

template<typename SvcType , typename SvcPtrType >

static boost::python::list Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::getObjectNamesAsList	(	SvcType const *const	self,
		const std::string &	contain
	)

inlinestatic

Return a Python list of object names from the ADS as this is far easier to work with than a set.

Parameters

self	:: A reference to the ADS object that called this method
contain	:: If provided, the function will return only names that contain this string

Returns: A python list created from the set of strings

Definition at line 183 of file DataServiceExporter.h.

References Mantid::Kernel::Auto, and Mantid::Kernel::Unsorted.

Referenced by Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::define().

◆ removeItem()

template<typename SvcType , typename SvcPtrType >

static void Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::removeItem	(	SvcType &	self,
		const std::string &	name
	)

inlinestatic

Remove an item from the service.

Parameters

self	A reference to the calling object
name	The name of the item in the service to remove

Definition at line 111 of file DataServiceExporter.h.

References name.

Referenced by Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::define().

◆ retrieveOrKeyError()

template<typename SvcType , typename SvcPtrType >

static WeakPtr Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::retrieveOrKeyError	(	const SvcType *const	self,
		const std::string &	name
	)

inlinestatic

Retrieves a shared_ptr from the ADS and raises a Python KeyError if it does not exist.

Parameters

self	:: A pointer to the object calling this function. Allows it to act as a member function
name	:: The name of the object to retrieve

Returns: A shared_ptr to the named object. If the name does not exist it sets a KeyError error indicator.

Definition at line 160 of file DataServiceExporter.h.

References name.

Referenced by Mantid::PythonInterface::DataServiceExporter< SvcType, SvcPtrType >::define().

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

Framework/PythonInterface/core/inc/MantidPythonInterface/core/DataServiceExporter.h

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ PythonType

◆ WeakPtr

Member Function Documentation

◆ addItem()

◆ addOrReplaceItem()

◆ clearItems()

◆ define()

◆ extractCppValue()

◆ getObjectNamesAsList()

◆ removeItem()

◆ retrieveOrKeyError()