pqProxy.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause

#ifndef pqProxy_h
#define pqProxy_h

#include "pqServerManagerModelItem.h"
#include <QPointer>

class pqProxyInternal;
class pqServer;
class vtkPVXMLElement;
class vtkSMProxy;
class vtkSMSessionProxyManager;

class PQCORE_EXPORT pqProxy : public pqServerManagerModelItem
{
  Q_OBJECT
public:
  enum ModifiedState
  {
    UNINITIALIZED,
    MODIFIED,
    UNMODIFIED
  };

  pqProxy(const QString& group, const QString& name, vtkSMProxy* proxy, pqServer* server,
    QObject* parent = nullptr);
  ~pqProxy() override;

  pqServer* getServer() const;

  void rename(const QString& newname);

  const QString& getSMName();
  const QString& getSMGroup();

  vtkSMProxy* getProxy() const;

  ModifiedState modifiedState() const { return this->Modified; }

  void setModifiedState(ModifiedState modified);

  vtkPVXMLElement* getHints() const;

  QList<vtkSMProxy*> getHelperProxies() const;

  QList<vtkSMProxy*> getHelperProxies(const QString& key) const;

  QList<QString> getHelperKeys() const;


  static std::string rstToHtml(const char* rstStr);
  static QString rstToHtml(const QString& rstStr);

  virtual void addHelperProxy(const QString& key, vtkSMProxy*);
  void removeHelperProxy(const QString& key, vtkSMProxy*);

  void updateHelperProxies() const;

  vtkSMSessionProxyManager* proxyManager() const;

  static pqProxy* findProxyWithHelper(vtkSMProxy* aproxy, QString& key);

  static pqProxy* findProxy(vtkSMProxy* aproxy);

  bool userModifiedSMName() { return this->UserModifiedSMName; }

Q_SIGNALS:
  void nameChanged(pqServerManagerModelItem*);

  void modifiedStateChanged(pqServerManagerModelItem*);

protected:
  friend class pqServerManagerModel;

  void setSMName(const QString& new_name);

  // Use this method to initialize the pqObject state using the
  // underlying vtkSMProxy. This needs to be done only once,
  // after the object has been created.
  virtual void initialize();

  // Method used to update the internal structure without affecting
  // the ProxyManager proxy registration
  virtual void addInternalHelperProxy(const QString& key, vtkSMProxy*) const;
  virtual void removeInternalHelperProxy(const QString& key, vtkSMProxy*) const;

protected Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  // Used to monitor helper proxy registration when created on other clients
  void onProxyRegistered(const QString&, const QString&, vtkSMProxy*);
  void onProxyUnRegistered(const QString&, const QString&, vtkSMProxy*);

private:
  QPointer<pqServer> Server; 
  QString SMName;
  QString SMGroup;
  pqProxyInternal* Internal;
  ModifiedState Modified;
  bool UserModifiedSMName;
};

#endif