vtkPVPythonAlgorithmPlugin.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVPythonAlgorithmPlugin_h
#define vtkPVPythonAlgorithmPlugin_h
 
#include "vtkPVPlugin.h"
 
#include "vtkPVServerManagerPluginInterface.h"    // for vtkPVServerManagerPluginInterface
#include "vtkRemotingServerManagerPythonModule.h" // for exports
 
#include <memory> //for std::unique_ptr.
 
class vtkPVPluginLoaderCleanerInitializer;
 
class VTKREMOTINGSERVERMANAGERPYTHON_EXPORT vtkPVPythonAlgorithmPlugin
  : public vtkPVPlugin
  , public vtkPVServerManagerPluginInterface
{
public:
  vtkPVPythonAlgorithmPlugin(const char* pythonmodule);
  ~vtkPVPythonAlgorithmPlugin() override;
 
  const char* GetPluginName() override;
  const char* GetPluginVersionString() override;
  bool GetRequiredOnServer() override { return true; }
  bool GetRequiredOnClient() override { return false; }
  const char* GetRequiredPlugins() override { return ""; }
  const char* GetDescription() override { return ""; }
  const char* GetEULA() override { return nullptr; }
 
  void GetXMLs(std::vector<std::string>& xmls) override;
  vtkClientServerInterpreterInitializer::InterpreterInitializationCallback
  GetInitializeInterpreterCallback() override
  {
    return nullptr;
  }
 
private:
  vtkPVPythonAlgorithmPlugin(const vtkPVPythonAlgorithmPlugin&) = delete;
  void operator=(const vtkPVPythonAlgorithmPlugin&) = delete;
 
  class vtkInternals;
  std::unique_ptr<vtkInternals> Internals;
 
  friend class vtkPVPythonAlgorithmPluginLoaderInitializer;
  static bool LoadPlugin(const char* pname);
};
 
// Schwartz counter idiom to register loader for Python plugins (based on Python
// algorithm).
static class VTKREMOTINGSERVERMANAGERPYTHON_EXPORT vtkPVPythonAlgorithmPluginLoaderInitializer
{
public:
  vtkPVPythonAlgorithmPluginLoaderInitializer();
  ~vtkPVPythonAlgorithmPluginLoaderInitializer();
 
} PythonAlgorithmPluginInitializerInstance;
 
#endif
// VTK-HeaderTest-Exclude: vtkPVPythonAlgorithmPlugin.h