Public Member Functions | Friends | List of all members
vtkPVPythonAlgorithmPlugin Class Reference

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

#include <vtkPVPythonAlgorithmPlugin.h>

Inheritance diagram for vtkPVPythonAlgorithmPlugin:
Inheritance graph
[legend]
Collaboration diagram for vtkPVPythonAlgorithmPlugin:
Collaboration graph
[legend]

Public Member Functions

 vtkPVPythonAlgorithmPlugin (const char *pythonmodule)
 
 ~vtkPVPythonAlgorithmPlugin () override
 
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...
 
- 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...
 

Friends

class vtkPVPythonAlgorithmPluginLoaderInitializer
 

Additional Inherited Members

- Public Types inherited from vtkPVPlugin
typedef bool(* EULAConfirmationCallback) (vtkPVPlugin *)
 Type for EULAConfirmationCallback. 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...
 
- 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()

vtkPVPythonAlgorithmPlugin::vtkPVPythonAlgorithmPlugin ( const char *  pythonmodule)

◆ ~vtkPVPythonAlgorithmPlugin()

vtkPVPythonAlgorithmPlugin::~vtkPVPythonAlgorithmPlugin ( )
override

Member Function Documentation

◆ GetPluginName()

const char* vtkPVPythonAlgorithmPlugin::GetPluginName ( )
overridevirtual

Implementation of the vtkPVPlugin interface.

Implements vtkPVPlugin.

◆ GetPluginVersionString()

const char* vtkPVPythonAlgorithmPlugin::GetPluginVersionString ( )
overridevirtual

Implementation of the vtkPVPlugin interface.

Implements vtkPVPlugin.

◆ GetRequiredOnServer()

bool vtkPVPythonAlgorithmPlugin::GetRequiredOnServer ( )
inlineoverridevirtual

Implementation of the vtkPVPlugin interface.

Implements vtkPVPlugin.

Definition at line 37 of file vtkPVPythonAlgorithmPlugin.h.

◆ GetRequiredOnClient()

bool vtkPVPythonAlgorithmPlugin::GetRequiredOnClient ( )
inlineoverridevirtual

Implementation of the vtkPVPlugin interface.

Implements vtkPVPlugin.

Definition at line 38 of file vtkPVPythonAlgorithmPlugin.h.

◆ GetRequiredPlugins()

const char* vtkPVPythonAlgorithmPlugin::GetRequiredPlugins ( )
inlineoverridevirtual

Implementation of the vtkPVPlugin interface.

Implements vtkPVPlugin.

Definition at line 39 of file vtkPVPythonAlgorithmPlugin.h.

◆ GetDescription()

const char* vtkPVPythonAlgorithmPlugin::GetDescription ( )
inlineoverridevirtual

Implementation of the vtkPVPlugin interface.

Implements vtkPVPlugin.

Definition at line 40 of file vtkPVPythonAlgorithmPlugin.h.

◆ GetEULA()

const char* vtkPVPythonAlgorithmPlugin::GetEULA ( )
inlineoverridevirtual

Implementation of the vtkPVPlugin interface.

Implements vtkPVPlugin.

Definition at line 41 of file vtkPVPythonAlgorithmPlugin.h.

◆ GetXMLs()

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

Implementation of the vtkPVServerManagerPluginInterface.

◆ GetInitializeInterpreterCallback()

vtkClientServerInterpreterInitializer::InterpreterInitializationCallback vtkPVPythonAlgorithmPlugin::GetInitializeInterpreterCallback ( )
inlineoverridevirtual

Implementation of the vtkPVServerManagerPluginInterface.

Implements vtkPVServerManagerPluginInterface.

Definition at line 48 of file vtkPVPythonAlgorithmPlugin.h.

Friends And Related Function Documentation

◆ vtkPVPythonAlgorithmPluginLoaderInitializer

Definition at line 61 of file vtkPVPythonAlgorithmPlugin.h.


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