vtkSMProxyListDomain.h

Go to the documentation of this file.

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

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMDomain.h"

#include <string>  // for std::string
#include <utility> // for std::pair
#include <vector>  // for std::vector

class vtkSMProperty;
class vtkSMProxy;
class vtkSMProxyListDomainInternals;
class vtkSMSessionProxyManager;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMProxyListDomain : public vtkSMDomain
{
public:
  static vtkSMProxyListDomain* New();
  vtkTypeMacro(vtkSMProxyListDomain, vtkSMDomain);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  struct ProxyType
  {
    std::string GroupName;
    std::string ProxyName;
    ProxyType() = default;
    ProxyType(const std::string& group, const std::string& name)
      : GroupName(group)
      , ProxyName(name)
    {
    }
  };

  const std::vector<ProxyType>& GetProxyTypes() const;

  unsigned int GetNumberOfProxyTypes();

  const char* GetProxyGroup(unsigned int index);

  const char* GetProxyName(unsigned int index);

  const char* GetProxyName(vtkSMProxy* proxy);

  vtkSMProxy* GetProxyWithName(const char* pname);

  int IsInDomain(vtkSMProperty* property) override;

  void AddProxy(vtkSMProxy*);

  bool HasProxy(vtkSMProxy*);

  unsigned int GetNumberOfProxies();

  vtkSMProxy* GetProxy(unsigned int index);

  vtkSMProxy* FindProxy(const char* xmlgroup, const char* xmlname);

  int RemoveProxy(vtkSMProxy* proxy);

  int RemoveProxy(unsigned int index);

  void CreateProxies(vtkSMSessionProxyManager* pxm);

  int SetDefaultValues(vtkSMProperty* prop, bool use_unchecked_values) override;


  vtkSetMacro(DefaultIndex, unsigned int);
  vtkGetMacro(DefaultIndex, unsigned int);

  void SetLogName(const char* prefix);

protected:
  vtkSMProxyListDomain();
  ~vtkSMProxyListDomain() override;

  int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* element) override;

  void AddProxy(const char* group, const char* name);

  void ChildSaveState(vtkPVXMLElement* propertyElement) override;

  // Load the state of the domain from the XML.
  int LoadState(vtkPVXMLElement* domainElement, vtkSMProxyLocator* loader) override;

  friend class vtkSMProxyProperty;
  void SetProxies(vtkSMProxy** proxies, unsigned int count);

  unsigned int DefaultIndex = 0;

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

  vtkSMProxyListDomainInternals* Internals;
};

#endif