ParaView
Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions
pqPipelineFilter Class Reference

#include <pqPipelineFilter.h>

Inheritance diagram for pqPipelineFilter:
Inheritance graph
[legend]
Collaboration diagram for pqPipelineFilter:
Collaboration graph
[legend]

List of all members.

Signals

void producerChanged (const QString &inputportname)
 fired whenever an input connection changes.

Public Member Functions

 pqPipelineFilter (QString name, vtkSMProxy *proxy, pqServer *server, QObject *parent=NULL)
virtual ~pqPipelineFilter ()
int getNumberOfInputPorts () const
 Returns the number of input ports available on this filter.
QString getInputPortName (int index) const
 Returns the name of the input port at a given index.
int getNumberOfInputs (const QString &portname) const
 Returns the number of input proxies connected to given named input port.
QList< pqOutputPort * > getInputs (const QString &portname) const
 Returns the input proxies connected to the given named input port.
QList< pqOutputPort * > getAllInputs () const
 Returns inputs connected to all input ports connections.
QMap< QString, QList
< pqOutputPort * > > 
getNamedInputs () const
 Returns a map of input port name to the list of output ports that are set as the input to that port.
pqOutputPortgetInput (const QString &portname, int index) const
 Returns a pair (input, output port) at the given index on the given named input port.
int getInputCount () const
 Get number of inputs.
QList< pqOutputPort * > getInputs () const
pqPipelineSourcegetInput (int index) const
int replaceInput () const
 "Replace input" is a hint given to the GUI to turn off input visibility when the filter is created.
void hideInputIfRequired (pqView *view)
 Hides the representations for the input if required, in the given view.

Static Public Member Functions

static QList< const char * > getInputPorts (vtkSMProxy *)
 Returns the inputs ports on any proxy.
static QList< const char * > getRequiredInputPorts (vtkSMProxy *)
 Returns the required inputs ports on any proxy.

Protected Slots

void inputChanged (vtkObject *, unsigned long, void *client_data)
 process some change in the input property for the proxy.

Protected Member Functions

virtual void initialize ()
void inputChanged (const QString &portname)
 Called when a input property changes.

Detailed Description

Definition at line 45 of file pqPipelineFilter.h.


Constructor & Destructor Documentation

pqPipelineFilter::pqPipelineFilter ( QString  name,
vtkSMProxy proxy,
pqServer server,
QObject *  parent = NULL 
)
virtual pqPipelineFilter::~pqPipelineFilter ( ) [virtual]

Member Function Documentation

static QList<const char*> pqPipelineFilter::getInputPorts ( vtkSMProxy ) [static]

Returns the inputs ports on any proxy.

static QList<const char*> pqPipelineFilter::getRequiredInputPorts ( vtkSMProxy ) [static]

Returns the required inputs ports on any proxy.

This is generally same as getInputPorts() except if the property has a "hint" saying it's optional.

int pqPipelineFilter::getNumberOfInputPorts ( ) const

Returns the number of input ports available on this filter.

QString pqPipelineFilter::getInputPortName ( int  index) const

Returns the name of the input port at a given index.

int pqPipelineFilter::getNumberOfInputs ( const QString &  portname) const

Returns the number of input proxies connected to given named input port.

QList<pqOutputPort*> pqPipelineFilter::getInputs ( const QString &  portname) const

Returns the input proxies connected to the given named input port.

QList<pqOutputPort*> pqPipelineFilter::getAllInputs ( ) const

Returns inputs connected to all input ports connections.

QMap<QString, QList<pqOutputPort*> > pqPipelineFilter::getNamedInputs ( ) const

Returns a map of input port name to the list of output ports that are set as the input to that port.

pqOutputPort* pqPipelineFilter::getInput ( const QString &  portname,
int  index 
) const

Returns a pair (input, output port) at the given index on the given named input port.

int pqPipelineFilter::getInputCount ( ) const [inline]

Get number of inputs.

Definition at line 86 of file pqPipelineFilter.h.

QList<pqOutputPort*> pqPipelineFilter::getInputs ( ) const [inline]

Definition at line 90 of file pqPipelineFilter.h.

pqPipelineSource* pqPipelineFilter::getInput ( int  index) const
int pqPipelineFilter::replaceInput ( ) const

"Replace input" is a hint given to the GUI to turn off input visibility when the filter is created.

Returns if this proxy replaces input on creation. This checks the "Hints" for the proxy, if any. If a <Visibility> element is present with replace_input="0", then this method returns false, otherwise true.

void pqPipelineFilter::hideInputIfRequired ( pqView view)

Hides the representations for the input if required, in the given view.

void pqPipelineFilter::producerChanged ( const QString &  inputportname) [signal]

fired whenever an input connection changes.

void pqPipelineFilter::inputChanged ( vtkObject ,
unsigned  long,
void *  client_data 
) [protected, slot]

process some change in the input property for the proxy.

virtual void pqPipelineFilter::initialize ( ) [protected, virtual]

Reimplemented from pqProxy.

void pqPipelineFilter::inputChanged ( const QString &  portname) [protected]

Called when a input property changes.

portname is the name of the input port represented by the property.


The documentation for this class was generated from the following file: