ParaView
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 
35 
36 #ifndef _pqPipelineFilter_h
37 #define _pqPipelineFilter_h
38 
39 #include "pqCoreModule.h"
40 #include "pqPipelineSource.h"
41 #include <QMap>
42 
43 class pqOutputPort;
44 
45 class PQCORE_EXPORT pqPipelineFilter : public pqPipelineSource
46 {
47  Q_OBJECT
49 public:
50  pqPipelineFilter(QString name, vtkSMProxy *proxy, pqServer* server,
51  QObject* parent=NULL);
52  virtual ~pqPipelineFilter();
53 
55  static QList<const char*> getInputPorts(vtkSMProxy*);
56 
60  static QList<const char*> getRequiredInputPorts(vtkSMProxy*);
61 
63  int getNumberOfInputPorts() const;
64 
66  QString getInputPortName(int index) const;
67 
69  int getNumberOfInputs(const QString& portname) const;
70 
72  QList<pqOutputPort*> getInputs(const QString& portname) const;
73 
75  QList<pqOutputPort*> getAllInputs() const;
76 
79  QMap<QString, QList<pqOutputPort*> > getNamedInputs() const;
80 
83  pqOutputPort* getInput(const QString& portname, int index) const;
84 
86  int getInputCount() const
87  { return this->getNumberOfInputs(this->getInputPortName(0)); }
88 
89  // Get a list of all inputs.
90  QList<pqOutputPort*> getInputs() const
91  { return this->getInputs(this->getInputPortName(0)); }
92 
93  // Get input at given index.
94  pqPipelineSource *getInput(int index) const;
95 
102  int replaceInput() const;
103 
104 signals:
106  void producerChanged(const QString& inputportname);
107 
108 protected slots:
110  void inputChanged(vtkObject*, unsigned long, void* client_data);
111 
112 protected:
113  // Use this method to initialize the pqObject state using the
114  // underlying vtkSMProxy. This needs to be done only once,
115  // after the object has been created.
116  virtual void initialize();
117 
120  void inputChanged(const QString& portname);
121 private:
122  class pqInternal;
123  pqInternal* Internal;
124 };
125 
126 #endif
pqOutputPort is a server manager model item for an output port of any pqPipelineSource item...
Definition: pqOutputPort.h:55
QList< pqOutputPort * > getInputs() const
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
pqServer (should be renamed to pqSession) is a pqServerManagerModelItem subclass that represents a vt...
Definition: pqServer.h:62