vtkSMInputProperty.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkSMInputProperty.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
30 #ifndef vtkSMInputProperty_h
31 #define vtkSMInputProperty_h
32 
33 struct vtkSMInputPropertyInternals;
34 
35 #include "vtkRemotingServerManagerModule.h" //needed for exports
36 #include "vtkSMProxyProperty.h"
37 
38 class vtkSMStateLocator;
39 
41 {
42 public:
43  static vtkSMInputProperty* New();
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
48 
52  vtkSetMacro(MultipleInput, int);
53  vtkGetMacro(MultipleInput, int);
55 
57 
63  void AddInputConnection(vtkSMProxy* proxy, unsigned int outputPort);
64  void SetInputConnection(unsigned int idx, vtkSMProxy* proxy, unsigned int outputPort);
66 
67  void AddUncheckedInputConnection(vtkSMProxy* proxy, unsigned int outputPort);
68  void SetUncheckedInputConnection(unsigned int idx, vtkSMProxy* proxy, unsigned int inputPort);
69 
71 
74  virtual void SetProxies(
75  unsigned int numElements, vtkSMProxy* proxies[], unsigned int outputports[]);
76  using Superclass::SetProxies;
78 
80 
84  unsigned int GetOutputPortForConnection(unsigned int idx);
85  unsigned int GetUncheckedOutputPortForConnection(unsigned int idx);
87 
89 
93  vtkSetMacro(PortIndex, int);
94  vtkGetMacro(PortIndex, int);
96 
97 protected:
99  ~vtkSMInputProperty() override;
100 
105  int ReadXMLAttributes(vtkSMProxy* parent, vtkPVXMLElement* element) override;
106 
111  vtkPVXMLElement* propertyElement, unsigned int idx) override;
112 
115 
116 private:
117  vtkSMInputProperty(const vtkSMInputProperty&) = delete;
118  void operator=(const vtkSMInputProperty&) = delete;
119 };
120 
121 #endif
virtual void SetProxies(unsigned int numElements, vtkSMProxy *proxies[])
Sets the value of the property to the list of proxies specified.
static vtkSMProxyProperty * New()
property representing pointer(s) to vtkObject(s)
#define VTKREMOTINGSERVERMANAGER_EXPORT
int ReadXMLAttributes(vtkSMProxy *parent, vtkPVXMLElement *element) override
Set the appropriate ivars from the xml element.
void PrintSelf(ostream &os, vtkIndent indent) override
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152
This is used by vtkPVXMLParser to represent an XML document starting at the root element.
virtual vtkPVXMLElement * AddProxyElementState(vtkPVXMLElement *prop, unsigned int idx)
Fill state property/proxy XML element with proxy info.
proxy representing inputs to a filter
Class used to retrieve a given message state based on its GlobalID.