ParFlowPlugin Class Reference

#include <ParFlowPlugin.h>

Inheritance diagram for ParFlowPlugin:

Collaboration diagram for ParFlowPlugin:

Public Member Functions
	ParFlowPlugin ()
const char *	GetPluginName () override
	Returns the name for this plugin. More...
const char *	GetPluginVersionString () override
	Returns the version for this plugin. More...
bool	GetRequiredOnServer () override
	Returns true if this plugin is required on the server. More...
bool	GetRequiredOnClient () override
	Returns true if this plugin is required on the client. More...
const char *	GetRequiredPlugins () override
	Returns a ';' separated list of plugin names required by this plugin. More...
const char *	GetDescription () override
	Returns a description of this plugin. More...
const char *	GetEULA () override
	Returns EULA for the plugin, if any. More...
void	GetBinaryResources (std::vector< std::string > &resources) override
	Provides access to binary resources compiled into the plugin. More...
void	GetXMLs (std::vector< std::string > &xmls) override
	Obtain the server-manager configuration xmls, if any. More...
vtkClientServerInterpreterInitializer::InterpreterInitializationCallback	GetInitializeInterpreterCallback () override
	Returns the callback function to call to initialize the interpretor for the new vtk/server-manager classes added by this plugin. More...
void	GetPythonSourceList (std::vector< std::string > &modules, std::vector< std::string > &sources, std::vector< int > &package_flags) override
Public Member Functions inherited from vtkPVPlugin
	vtkPVPlugin ()
virtual	~vtkPVPlugin ()
const char *	GetFileName ()
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...
Public Member Functions inherited from vtkPVPythonPluginInterface
virtual	~vtkPVPythonPluginInterface ()

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...
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

Definition at line 29 of file ParFlowPlugin.h.

Constructor & Destructor Documentation

ParFlowPlugin()

ParFlowPlugin::ParFlowPlugin

(

)

Member Function Documentation

GetPluginName()

const char* ParFlowPlugin::GetPluginName ( )

inlineoverridevirtual

Returns the name for this plugin.

Implements vtkPVPlugin.

Definition at line 59 of file ParFlowPlugin.h.

GetPluginVersionString()

const char* ParFlowPlugin::GetPluginVersionString ( )

inlineoverridevirtual

Returns the version for this plugin.

Implements vtkPVPlugin.

Definition at line 65 of file ParFlowPlugin.h.

GetRequiredOnServer()

bool ParFlowPlugin::GetRequiredOnServer ( )

inlineoverridevirtual

Returns true if this plugin is required on the server.

Implements vtkPVPlugin.

Definition at line 71 of file ParFlowPlugin.h.

GetRequiredOnClient()

bool ParFlowPlugin::GetRequiredOnClient ( )

inlineoverridevirtual

Returns true if this plugin is required on the client.

Implements vtkPVPlugin.

Definition at line 77 of file ParFlowPlugin.h.

GetRequiredPlugins()

const char* ParFlowPlugin::GetRequiredPlugins ( )

inlineoverridevirtual

Returns a ';' separated list of plugin names required by this plugin.

Implements vtkPVPlugin.

Definition at line 83 of file ParFlowPlugin.h.

GetDescription()

const char* ParFlowPlugin::GetDescription ( )

inlineoverridevirtual

Returns a description of this plugin.

Implements vtkPVPlugin.

Definition at line 89 of file ParFlowPlugin.h.

GetEULA()

const char* ParFlowPlugin::GetEULA ( )

overridevirtual

Returns EULA for the plugin, if any.

If none, this will return nullptr.

Implements vtkPVPlugin.

GetBinaryResources()

void ParFlowPlugin::GetBinaryResources ( std::vector< std::string > &  resources )

overridevirtual

Provides access to binary resources compiled into the plugin.

This is primarily used to compile in icons and compressed help project (qch) files into plugins.

Reimplemented from vtkPVPlugin.

GetXMLs()

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

override

Obtain the server-manager configuration xmls, if any.

GetInitializeInterpreterCallback()

vtkClientServerInterpreterInitializer::InterpreterInitializationCallback ParFlowPlugin::GetInitializeInterpreterCallback ( )

overridevirtual

Returns the callback function to call to initialize the interpretor for the new vtk/server-manager classes added by this plugin.

Returning nullptr is perfectly valid.

Implements vtkPVServerManagerPluginInterface.

GetPythonSourceList()

void ParFlowPlugin::GetPythonSourceList ( std::vector< std::string > &  modules, std::vector< std::string > &  sources, std::vector< int > &  package_flags  )

overridevirtual

Implements vtkPVPythonPluginInterface.

---

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

• /builds/gitlab-kitware-sciviz-ci/build/Plugins/ParFlow/ParFlowPlugin.h