vtkPVPluginsInformation.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVPluginsInformation_h
#define vtkPVPluginsInformation_h

#include "vtkPVInformation.h"
#include "vtkParaViewDeprecation.h" // needed for deprecation
#include "vtkRemotingCoreModule.h"  // needed for exports

class VTKREMOTINGCORE_EXPORT vtkPVPluginsInformation : public vtkPVInformation
{
public:
  static vtkPVPluginsInformation* New();
  vtkTypeMacro(vtkPVPluginsInformation, vtkPVInformation);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  unsigned int GetNumberOfPlugins();
  const char* GetPluginName(unsigned int);
  const char* GetPluginFileName(unsigned int);
  const char* GetPluginVersion(unsigned int);
  bool GetPluginLoaded(unsigned int);
  const char* GetRequiredPlugins(unsigned int);
  bool GetRequiredOnServer(unsigned int);
  bool GetRequiredOnClient(unsigned int);
  const char* GetDescription(unsigned int);
  bool GetAutoLoad(unsigned int);


  const char* GetPluginStatusMessage(unsigned int);
  void SetPluginStatusMessage(unsigned int, const char*);

  void SetAutoLoad(unsigned int cc, bool);

  void SetAutoLoadAndForce(unsigned int cc, bool);

  void CopyFromObject(vtkObject*) override;

  void AddInformation(vtkPVInformation*) override;

  void Update(vtkPVPluginsInformation* other);


  void CopyToStream(vtkClientServerStream*) override;
  void CopyFromStream(const vtkClientServerStream*) override;


  vtkGetStringMacro(SearchPaths);

  PARAVIEW_DEPRECATED_IN_5_11_0("Use `vtkSMProxyManager::SatisfyPluginRequirements()` instead")
  static bool PluginRequirementsSatisfied(
    vtkPVPluginsInformation* client_plugins, vtkPVPluginsInformation* server_plugins);

protected:
  vtkPVPluginsInformation();
  ~vtkPVPluginsInformation() override;

  char* SearchPaths;
  vtkSetStringMacro(SearchPaths);

private:
  vtkPVPluginsInformation(const vtkPVPluginsInformation&) = delete;
  void operator=(const vtkPVPluginsInformation&) = delete;

  class vtkInternals;
  vtkInternals* Internals;
};

#endif