pqPipelineFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqPipelineFilter.h
5 
6  Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 =========================================================================*/
32 
38 #ifndef pqPipelineFilter_h
39 #define pqPipelineFilter_h
40 
41 #include "pqCoreModule.h"
42 #include "pqPipelineSource.h"
43 #include <QMap>
44 
45 class pqOutputPort;
46 
48 {
49  Q_OBJECT
51 
52 public:
53  pqPipelineFilter(QString name, vtkSMProxy* proxy, pqServer* server, QObject* parent = nullptr);
54  ~pqPipelineFilter() override;
55 
59  static QList<const char*> getInputPorts(vtkSMProxy*);
60 
66  static QList<const char*> getRequiredInputPorts(vtkSMProxy*);
67 
71  int getNumberOfInputPorts() const;
72 
76  QString getInputPortName(int index) const;
77 
81  int getNumberOfInputs(const QString& portname) const;
82 
86  QList<pqOutputPort*> getInputs(const QString& portname) const;
87 
91  QList<pqOutputPort*> getAllInputs() const;
92 
97  QMap<QString, QList<pqOutputPort*>> getNamedInputs() const;
98 
103  pqOutputPort* getInput(const QString& portname, int index) const;
104 
108  int getInputCount() const { return this->getNumberOfInputs(this->getInputPortName(0)); }
109 
113  QList<pqOutputPort*> getInputs() const { return this->getInputs(this->getInputPortName(0)); }
114 
118  pqPipelineSource* getInput(int index) const;
119 
124  pqOutputPort* getAnyInput() const;
125 
134  int replaceInput() const;
135 
136 Q_SIGNALS:
140  void producerChanged(const QString& inputportname);
141 
142 protected Q_SLOTS:
146  void inputChanged(vtkObject*, unsigned long, void* client_data);
147 
148 protected: // NOLINT(readability-redundant-access-specifiers)
154  void initialize() override;
155 
160  void inputChanged(const QString& portname);
161 
162 private:
163  class pqInternal;
164  pqInternal* Internal;
165 };
166 
167 #endif
pqOutputPort is a server manager model item for an output port of any pqPipelineSource item...
Definition: pqOutputPort.h:57
name
QList< pqOutputPort * > getInputs() const
Get a list of all inputs.
#define PQCORE_EXPORT
Definition: pqCoreModule.h:15
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152
virtual void initialize()
int getInputCount() const
Get number of inputs.
PQ representation for a vtkSMProxy that can be involved in a pipeline.
friend class pqPipelineFilter
index
pqServer (should be renamed to pqSession) is a pqServerManagerModelItem subclass that represents a vt...
Definition: pqServer.h:63