packages a Python module into a ParaView plugin. More...

#include <vtkPVPythonAlgorithmPlugin.h>

Inheritance diagram for vtkPVPythonAlgorithmPlugin:

Collaboration diagram for vtkPVPythonAlgorithmPlugin:

Public Member Functions
	~vtkPVPythonAlgorithmPlugin () override


	vtkPVPythonAlgorithmPlugin (const char *filePath)
	Constructors for the object. More...

	vtkPVPythonAlgorithmPlugin (const char moduleName, const char pythonSourceCode)
	Constructors for the object. More...


const char *	GetPluginName () override

const char *	GetPluginVersionString () override

bool	GetRequiredOnServer () override

bool	GetRequiredOnClient () override

const char *	GetRequiredPlugins () override

const char *	GetDescription () override

const char *	GetEULA () override


void	GetXMLs (std::vector< std::string > &xmls) override

vtkClientServerInterpreterInitializer::InterpreterInitializationCallback	GetInitializeInterpreterCallback () override

Public Member Functions inherited from vtkPVPlugin
	vtkPVPlugin ()

virtual	~vtkPVPlugin ()

const char *	GetFileName ()

virtual void	GetBinaryResources (std::vector< std::string > &resources)
	Provides access to binary resources compiled into the plugin. More...

void	SetOnLoadCheckCallbackFunction (OnLoadCheckCallback callback)
	Get/Set the callback function for on load check. More...

OnLoadCheckCallback	GetOnLoadCheckCallbackFunction () const
	Get/Set the callback function for on load check. More...

Public Member Functions inherited from vtkPVServerManagerPluginInterface
virtual	~vtkPVServerManagerPluginInterface ()

virtual void	GetXMLs (std::vector< std::string > &vtkNotUsed(xmls))=0
	Obtain the server-manager configuration xmls, if any. More...

virtual bool	GetEnsurePluginLoaded ()
	Return if the plugin should be ensured when using a proxy provided by the XMLs Useful for delayed load plugin. More...

Static Public Member Functions
static bool	InitializeFromStringAndGetXMLs (const char moduleName, const char pythonSourceCode, std::vector< std::string > &xmls)
	Creates the object from Python source code and gets the servermanager XMLs from all the Python filters included in the 'moduleName'. More...

Static Public Member Functions inherited from vtkPVPlugin
static bool	ImportPlugin (vtkPVPlugin *plugin)
	Used when import plugins programmatically. More...

static void	SetEULAConfirmationCallback (EULAConfirmationCallback callback)
	Get/Set the static callback to call to confirm EULA. More...

static EULAConfirmationCallback	GetEULAConfirmationCallback ()
	Type for EULAConfirmationCallback. More...

Friends
class	vtkPVPythonAlgorithmPluginLoaderInitializer

Additional Inherited Members
Public Types inherited from vtkPVPlugin
typedef bool(*	OnLoadCheckCallback) ()
	Function pointer for the on load callback check. More...

typedef bool(*	EULAConfirmationCallback) (vtkPVPlugin *)
	Type for EULAConfirmationCallback. More...

Protected Member Functions inherited from vtkPVPlugin
void	SetFileName (const char *filename)
	Set the filename the plugin is loaded from, if any. More...

Detailed Description

packages a Python module into a ParaView plugin.

vtkPVPythonAlgorithmPlugin helps us support loading a Python module as a ParaView plugin. The only supported type of plugin is a server-manager plugin that adds support for algorithm proxies i.e. readers, filters, and writers.

Definition at line 25 of file vtkPVPythonAlgorithmPlugin.h.

Constructor & Destructor Documentation

◆ vtkPVPythonAlgorithmPlugin() [1/2]

vtkPVPythonAlgorithmPlugin::vtkPVPythonAlgorithmPlugin ( const char * filePath )

Constructors for the object.

The first version reads the python plugin from the .py file at 'filePath'. The second version is used for plugins that include both C++ and Python filters (the Python source code is included in the .so in this case)

◆ vtkPVPythonAlgorithmPlugin() [2/2]

vtkPVPythonAlgorithmPlugin::vtkPVPythonAlgorithmPlugin	(	const char *	moduleName,
		const char *	pythonSourceCode
	)

Constructors for the object.

The first version reads the python plugin from the .py file at 'filePath'. The second version is used for plugins that include both C++ and Python filters (the Python source code is included in the .so in this case)

◆ ~vtkPVPythonAlgorithmPlugin()

vtkPVPythonAlgorithmPlugin::~vtkPVPythonAlgorithmPlugin ( )

override