vtkSMCompoundSourceProxy.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkSMCompoundSourceProxy.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.

=========================================================================*/
#ifndef vtkSMCompoundSourceProxy_h
#define vtkSMCompoundSourceProxy_h

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

class vtkSMProxyLocator;
class vtkPVXMLElement;
class vtkSMProxyManager;

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

  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() { return this->GetNumberOfSubProxies(); }

  vtkSMProxy* GetProxy(unsigned int cc) { return this->GetSubProxy(cc); }

  vtkSMProxy* GetProxy(const char* name) { return this->GetSubProxy(name); }

  const char* GetProxyName(unsigned int index) { return this->GetSubProxyName(index); }

  void CreateOutputPorts() override;

  void CreateSelectionProxies() override;

  void UpdateVTKObjects() override;

  vtkPVXMLElement* SaveDefinition(vtkPVXMLElement* root);

protected:
  vtkSMCompoundSourceProxy();
  ~vtkSMCompoundSourceProxy() override;

  int ReadXMLAttributes(vtkSMSessionProxyManager* pm, vtkPVXMLElement* element) override;

  void CreateVTKObjects() override;

  // 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);

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

  class vtkInternals;
  vtkInternals* CSInternals;
};

#endif