vtkPVServerManagerPluginInterface.h 1.78 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*=========================================================================

  Program:   ParaView
  Module:    vtkPVServerManagerPluginInterface.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
15 16 17 18 19 20 21
/**
 * @class   vtkPVServerManagerPluginInterface
 *
 * vtkPVServerManagerPluginInterface defines the interface needed to be
 * implemented by a server-manager plugin i.e. a plugin that adds new
 * filters/readers/proxies etc. to ParaView.
*/
22

23 24
#ifndef vtkPVServerManagerPluginInterface_h
#define vtkPVServerManagerPluginInterface_h
25

26
#include "vtkClientServerInterpreterInitializer.h"
27 28 29
#include "vtkPVClientServerCoreCoreModule.h" //needed for exports
#include <string>                            // STL Header
#include <vector>                            // STL Header
30

31
class VTKPVCLIENTSERVERCORECORE_EXPORT vtkPVServerManagerPluginInterface
32 33
{
public:
34
  virtual ~vtkPVServerManagerPluginInterface();
Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
35

36 37 38
  /**
   * Obtain the server-manager configuration xmls, if any.
   */
39
  virtual void GetXMLs(std::vector<std::string>& vtkNotUsed(xmls)) = 0;
40

41 42 43 44 45 46
  //@{
  /**
   * Returns the callback function to call to initialize the interpretor for the
   * new vtk/server-manager classes added by this plugin. Returning NULL is
   * perfectly valid.
   */
47
  virtual vtkClientServerInterpreterInitializer::InterpreterInitializationCallback
Kitware Robot's avatar
Kitware Robot committed
48
  GetInitializeInterpreterCallback() = 0;
49
};
Kitware Robot's avatar
Kitware Robot committed
50
//@}
51 52 53

#endif

54
// VTK-HeaderTest-Exclude: vtkPVServerManagerPluginInterface.h