A wrapper class helping to export AnalysisDataServiceObserver to python. More...

#include <AlgorithmFactoryObserverAdapter.h>

Inheritance diagram for Mantid::PythonInterface::AlgorithmFactoryObserverAdapter:

Public Member Functions
	AlgorithmFactoryObserverAdapter (const AlgorithmFactoryObserverAdapter &)=delete

	AlgorithmFactoryObserverAdapter (PyObject *self)

AlgorithmFactoryObserverAdapter &	operator= (const AlgorithmFactoryObserverAdapter &)=delete

void	updateHandle () override
	If something subscribes to the AlgorithmFactory, then this function will trigger. More...

Public Member Functions inherited from Mantid::API::AlgorithmFactoryObserver
	AlgorithmFactoryObserver ()

void	observeUpdate (bool turnOn=true)
	Function will add/remove the observer to the AlgorithmFactory when something is subscribed to it. More...

virtual void	updateHandle ()
	If something subscribes to the AlgorithmFactory, then this function will trigger. More...

virtual	~AlgorithmFactoryObserver ()

Private Member Functions
PyObject *	getSelf () const
	Return the PyObject that owns this wrapper, i.e. self. More...

Private Attributes
PyObject *	m_self
	Value of "self" used by python to refer to an instance of this class. More...

Detailed Description

A wrapper class helping to export AnalysisDataServiceObserver to python.

It provides access from the C++ side to methods defined in python on subclasses of AnalysisDataServiceObserver. This allows the virtual methods to be overriden by python subclasses.

Definition at line 22 of file AlgorithmFactoryObserverAdapter.h.

Constructor & Destructor Documentation

◆ AlgorithmFactoryObserverAdapter() [1/2]

Mantid::PythonInterface::AlgorithmFactoryObserverAdapter::AlgorithmFactoryObserverAdapter ( PyObject * self )

explicit

Definition at line 13 of file AlgorithmFactoryObserverAdapter.cpp.

◆ AlgorithmFactoryObserverAdapter() [2/2]

Mantid::PythonInterface::AlgorithmFactoryObserverAdapter::AlgorithmFactoryObserverAdapter ( const AlgorithmFactoryObserverAdapter & )

delete

Member Function Documentation

◆ getSelf()

PyObject * Mantid::PythonInterface::AlgorithmFactoryObserverAdapter::getSelf ( ) const

inlineprivate

Return the PyObject that owns this wrapper, i.e. self.

Definition at line 32 of file AlgorithmFactoryObserverAdapter.h.

References m_self.

Referenced by updateHandle().

◆ operator=()

AlgorithmFactoryObserverAdapter & Mantid::PythonInterface::AlgorithmFactoryObserverAdapter::operator= ( const AlgorithmFactoryObserverAdapter & )

delete

◆ updateHandle()

void Mantid::PythonInterface::AlgorithmFactoryObserverAdapter::updateHandle ( )

overridevirtual

If something subscribes to the AlgorithmFactory, then this function will trigger.

works by overloading this class and overriding this function.

Reimplemented from Mantid::API::AlgorithmFactoryObserver.

Definition at line 16 of file AlgorithmFactoryObserverAdapter.cpp.

References getSelf().

Member Data Documentation

◆ m_self

PyObject* Mantid::PythonInterface::AlgorithmFactoryObserverAdapter::m_self

private

Value of "self" used by python to refer to an instance of this class.

Definition at line 34 of file AlgorithmFactoryObserverAdapter.h.

The documentation for this class was generated from the following files:

Framework/PythonInterface/mantid/api/inc/MantidPythonInterface/api/Algorithms/AlgorithmFactoryObserverAdapter.h
Framework/PythonInterface/mantid/api/src/Exports/AlgorithmFactoryObserverAdapter.cpp

Public Member Functions

Private Member Functions

Private Attributes