vtkSMCompoundSourceProxyDefinitionBuilder.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMCompoundSourceProxyDefinitionBuilder_h
#define vtkSMCompoundSourceProxyDefinitionBuilder_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMObject.h"
 
class vtkSMProxy;
class vtkPVXMLElement;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMCompoundSourceProxyDefinitionBuilder : public vtkSMObject
{
public:
  static vtkSMCompoundSourceProxyDefinitionBuilder* New();
  vtkTypeMacro(vtkSMCompoundSourceProxyDefinitionBuilder, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void Reset();
 
  void AddProxy(const char* name, vtkSMProxy* proxy);
 
  void ExposeProperty(const char* proxyName, const char* propertyName, const char* exposedName);
 
  void ExposeOutputPort(const char* proxyName, const char* portName, const char* exposedName);
 
  void ExposeOutputPort(const char* proxyName, unsigned int portIndex, const char* exposedName);
 
  unsigned int GetNumberOfProxies();
 
  vtkSMProxy* GetProxy(unsigned int cc);
 
  vtkSMProxy* GetProxy(const char* name);
 
  const char* GetProxyName(unsigned int index);
 
  vtkPVXMLElement* SaveDefinition(vtkPVXMLElement* root);
 
protected:
  vtkSMCompoundSourceProxyDefinitionBuilder();
  ~vtkSMCompoundSourceProxyDefinitionBuilder() override;
 
private:
  vtkSMCompoundSourceProxyDefinitionBuilder(
    const vtkSMCompoundSourceProxyDefinitionBuilder&) = delete;
  void operator=(const vtkSMCompoundSourceProxyDefinitionBuilder&) = delete;
 
  class vtkInternals;
  vtkInternals* Internals;
 
  // returns 1 if the value element should be written.
  // proxy property values that point to "outside" proxies
  // are not written
  int ShouldWriteValue(vtkPVXMLElement* valueElem);
  void TraverseForProperties(vtkPVXMLElement* root);
  void StripValues(vtkPVXMLElement* propertyElem);
};
 
#endif