Servers/ServerManager/vtkSMProxyManager.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    $RCSfile: vtkSMProxyManager.h,v $

  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.

=========================================================================*/
#ifndef __vtkSMProxyManager_h
#define __vtkSMProxyManager_h

#include "vtkSMObject.h"

class vtkPVXMLElement;
class vtkSMProperty;
class vtkSMProxy;
//BTX
struct vtkSMProxyManagerInternals;
//ETX

class VTK_EXPORT vtkSMProxyManager : public vtkSMObject
{
public:
  static vtkSMProxyManager* New();
  vtkTypeRevisionMacro(vtkSMProxyManager, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  vtkSMProxy* NewProxy(const char* groupName, const char* proxyName);

  void RegisterProxy(const char* groupname, const char* name, vtkSMProxy* proxy);


  vtkSMProxy* GetProxy(const char* groupname, const char* name);
  vtkSMProxy* GetProxy(const char* name);

  unsigned int GetNumberOfProxies(const char* groupname);

  const char* GetProxyName(const char* groupname, unsigned int idx);

  const char* GetProxyName(const char* groupname, vtkSMProxy* proxy);
  
  const char* IsProxyInGroup(vtkSMProxy* proxy, const char* groupname);


  void UnRegisterProxy(const char* groupname, const char* name);
  void UnRegisterProxy(const char* name);

  void UnRegisterProxies();


  void UpdateRegisteredProxies(const char* groupname);
  void UpdateRegisteredProxies();

  void SaveState(const char* filename);

  virtual void SaveState(const char*, ostream*, vtkIndent);

  void InstantiateGroupPrototypes(const char* groupName);

  unsigned int GetNumberOfXMLGroups();

  const char* GetXMLGroupName(unsigned int n);

  int ProxyElementExists(const char* groupName,  const char* proxyName);

protected:
  vtkSMProxyManager();
  ~vtkSMProxyManager();


  void AddElement(
    const char* groupName, const char* name, vtkPVXMLElement* element);

//BTX
  friend class vtkSMXMLParser;
  friend class vtkSMProxyIterator;
  friend class vtkSMProxy;
//ETX

  vtkSMProxy* NewProxy(vtkPVXMLElement* element, const char* groupname);


  vtkPVXMLElement* GetProxyElement(const char* groupName,
    const char* proxyName);

private:
  vtkSMProxyManagerInternals* Internals;

private:
  vtkSMProxyManager(const vtkSMProxyManager&); // Not implemented
  void operator=(const vtkSMProxyManager&); // Not implemented
};

#endif

---