PQ representation for a vtkSMProxy that can be involved in a pipeline. More...

#include <pqPipelineSource.h>

Inheritance diagram for pqPipelineSource:

Collaboration diagram for pqPipelineSource:

Signals
void	connectionAdded (pqPipelineSource source, pqPipelineSource consumer, int srcOutputPort)
	fired when a connection is created between two pqPipelineSources.
void	preConnectionAdded (pqPipelineSource source, pqPipelineSource consumer, int srcOutputPort)
void	connectionRemoved (pqPipelineSource source, pqPipelineSource consumer, int srcOutputPort)
	fired when a connection is broken between two pqPipelineSources.
void	preConnectionRemoved (pqPipelineSource source, pqPipelineSource consumer, int srcOutputPort)
void	representationAdded (pqPipelineSource source, pqDataRepresentation repr, int srcOutputPort)
	fired when a representation is added.
void	representationRemoved (pqPipelineSource source, pqDataRepresentation repr, int srcOutputPort)
	fired when a representation is removed.
void	visibilityChanged (pqPipelineSource source, pqDataRepresentation repr)
	Fired when the visbility of a representation for the source changes.
void	dataUpdated (pqPipelineSource *source)
	Fired right after the underlying algorithm updates (executes).
Public Member Functions
	pqPipelineSource (const QString &name, vtkSMProxy proxy, pqServer server, QObject *parent=NULL)
virtual	~pqPipelineSource ()
int	getNumberOfOutputPorts () const
	A source may have multiple output ports.
pqOutputPort *	getOutputPort (int outputport) const
	Returns the pqOutputPort for the given output port.
pqOutputPort *	getOutputPort (const QString &portName) const
	Returns the pqOutputPort given the name of the port.
QList< pqOutputPort * >	getOutputPorts () const
	Returns all the output ports.
int	getNumberOfConsumers (int outputport) const
	Returns the number of consumers connected to the given output port.
int	getNumberOfConsumers () const
	Get the number of consumers connected to output port 0.
pqPipelineSource *	getConsumer (int outputport, int index) const
	Get the consumer at a particulat index on a given output port.
pqPipelineSource *	getConsumer (int index) const
	Get consumer at a particular index on output port 0.
QList< pqPipelineSource * >	getAllConsumers () const
	Returns a list of consumers for all output ports.
QList< pqDataRepresentation * >	getRepresentations (int outputport, pqView *view) const
	Returns a list of representations for this source in the given view.
QList< pqDataRepresentation * >	getRepresentations (pqView *view) const
pqDataRepresentation *	getRepresentation (int outputport, pqView *view) const
	Returns the first representation for this source in the given view.
pqDataRepresentation *	getRepresentation (pqView *view) const
QList< pqView * >	getViews () const
	Returns a list of render modules in which this source has representations added (the representations may not be visible).
void	renderAllViews (bool force=false)
	This method updates all render modules to which all representations for this source belong, if force is true, it for an immediate render otherwise render on idle.
void	setDefaultPropertyValues ()
	Sets default values for the underlying proxy.
void	updatePipeline ()
	Update the pipeline with the current time.
void	createAnimationHelpersIfNeeded ()
	Animation helper is used to animate display properties for this source.
Protected Slots
void	onRepresentationVisibilityChanged ()
	Called when the visibility of any representation for this source changes.
Protected Member Functions
void	createProxiesForProxyListDomains ()
	For every source registered if it has any property that defines a proxy_list domain, we create and register proxies for every type of proxy indicated in that domain.
void	processProxyListHints (vtkSMProxy *proxy_list_proxy)
virtual void	addInternalHelperProxy (const QString &key, vtkSMProxy *) const
	Overridden to add the proxies to the domain as well.
virtual void	removeInternalHelperProxy (const QString &key, vtkSMProxy *) const
void	removeConsumer (int outputport, pqPipelineSource *)
	called by pqPipelineFilter when the connections change.
void	addConsumer (int outputport, pqPipelineSource *)
Friends
class	pqPipelineFilter

Detailed Description

PQ representation for a vtkSMProxy that can be involved in a pipeline.

i.e that can have input and/or output. The public API is to observe the object, changes to the pipeline structure are only through protected function. These changes happen automatically as a reflection of the SM state.

Definition at line 54 of file pqPipelineSource.h.

Constructor & Destructor Documentation

pqPipelineSource::pqPipelineSource	(	const QString &	name,
		vtkSMProxy *	proxy,
		pqServer *	server,
		QObject *	parent = `NULL`
	)

virtual pqPipelineSource::~pqPipelineSource ( ) [virtual]

Member Function Documentation

int pqPipelineSource::getNumberOfOutputPorts ( ) const

A source may have multiple output ports.

This method returns the number of output ports supported by this source.

pqOutputPort* pqPipelineSource::getOutputPort ( int outputport ) const

Returns the pqOutputPort for the given output port.

pqOutputPort* pqPipelineSource::getOutputPort ( const QString & portName ) const

Returns the pqOutputPort given the name of the port.

QList<pqOutputPort*> pqPipelineSource::getOutputPorts ( ) const

Returns all the output ports.

int pqPipelineSource::getNumberOfConsumers ( int outputport ) const

Returns the number of consumers connected to the given output port.

int pqPipelineSource::getNumberOfConsumers ( ) const [inline]

Get the number of consumers connected to output port 0.

Equivalent to calling getNumberOfConsumers(0);

Definition at line 81 of file pqPipelineSource.h.

pqPipelineSource* pqPipelineSource::getConsumer	(	int	outputport,
		int	index
	)		const

Get the consumer at a particulat index on a given output port.

pqPipelineSource* pqPipelineSource::getConsumer ( int index ) const [inline]

Get consumer at a particular index on output port 0.

Equivalent to calling getConsumer(0, index);

Definition at line 89 of file pqPipelineSource.h.

QList<pqPipelineSource*> pqPipelineSource::getAllConsumers ( ) const

Returns a list of consumers for all output ports.

QList<pqDataRepresentation*> pqPipelineSource::getRepresentations	(	int	outputport,
		pqView *	view
	)		const

Returns a list of representations for this source in the given view.

If view == NULL, returns all representations of this source.

QList<pqDataRepresentation*> pqPipelineSource::getRepresentations ( pqView * view ) const [inline]

Definition at line 98 of file pqPipelineSource.h.

pqDataRepresentation* pqPipelineSource::getRepresentation	(	int	outputport,
		pqView *	view
	)		const

Returns the first representation for this source in the given view.

If view is NULL, returns 0.

pqDataRepresentation* pqPipelineSource::getRepresentation ( pqView * view ) const [inline]

Definition at line 104 of file pqPipelineSource.h.

QList<pqView*> pqPipelineSource::getViews ( ) const

Returns a list of render modules in which this source has representations added (the representations may not be visible).

void pqPipelineSource::renderAllViews ( bool force = false )

This method updates all render modules to which all representations for this source belong, if force is true, it for an immediate render otherwise render on idle.

void pqPipelineSource::setDefaultPropertyValues ( ) [virtual]

Sets default values for the underlying proxy.

This is during the initialization stage of the pqProxy for proxies created by the GUI itself i.e. for proxies loaded through state or created by python client this method won't be called. The default implementation iterates over all properties of the proxy and sets them to default values.

Reimplemented from pqProxy.

void pqPipelineSource::updatePipeline ( )

Update the pipeline with the current time.

void pqPipelineSource::createAnimationHelpersIfNeeded ( )

Animation helper is used to animate display properties for this source.

void pqPipelineSource::connectionAdded	(	pqPipelineSource *	source,
		pqPipelineSource *	consumer,
		int	srcOutputPort
	)		`[signal]`

fired when a connection is created between two pqPipelineSources.

void pqPipelineSource::preConnectionAdded	(	pqPipelineSource *	source,
		pqPipelineSource *	consumer,
		int	srcOutputPort
	)		`[signal]`

void pqPipelineSource::connectionRemoved	(	pqPipelineSource *	source,
		pqPipelineSource *	consumer,
		int	srcOutputPort
	)		`[signal]`

fired when a connection is broken between two pqPipelineSources.

void pqPipelineSource::preConnectionRemoved	(	pqPipelineSource *	source,
		pqPipelineSource *	consumer,
		int	srcOutputPort
	)		`[signal]`

void pqPipelineSource::representationAdded	(	pqPipelineSource *	source,
		pqDataRepresentation *	repr,
		int	srcOutputPort
	)		`[signal]`

fired when a representation is added.

void pqPipelineSource::representationRemoved	(	pqPipelineSource *	source,
		pqDataRepresentation *	repr,
		int	srcOutputPort
	)		`[signal]`

fired when a representation is removed.

void pqPipelineSource::visibilityChanged	(	pqPipelineSource *	source,
		pqDataRepresentation *	repr
	)		`[signal]`

Fired when the visbility of a representation for the source changes.

Also fired when representationAdded or representationRemoved is fired since that too implies change in source visibility.

void pqPipelineSource::dataUpdated ( pqPipelineSource * source ) [signal]

Fired right after the underlying algorithm updates (executes).

This can be used to update data information and other similar tasks.

void pqPipelineSource::onRepresentationVisibilityChanged ( ) [protected, slot]

Called when the visibility of any representation for this source changes.

void pqPipelineSource::createProxiesForProxyListDomains ( ) [protected]

For every source registered if it has any property that defines a proxy_list domain, we create and register proxies for every type of proxy indicated in that domain.

These are "internal proxies" for this pqProxy. Internal proxies are registered under special groups and are unregistered with the pqProxy object is destroyed i.e. when the vtkSMProxy represented by this pqProxy is unregistered. These internal proxies are used by pqSignalAdaptorProxyList to populate the combox box widget thru which the user can choose one of the available proxies.

void pqPipelineSource::processProxyListHints ( vtkSMProxy * proxy_list_proxy ) [protected]

virtual void pqPipelineSource::addInternalHelperProxy	(	const QString &	key,
		vtkSMProxy *
	)		const `[protected, virtual]`

Overridden to add the proxies to the domain as well.

Reimplemented from pqProxy.

virtual void pqPipelineSource::removeInternalHelperProxy	(	const QString &	key,
		vtkSMProxy *
	)		const `[protected, virtual]`

Reimplemented from pqProxy.

void pqPipelineSource::removeConsumer	(	int	outputport,
		pqPipelineSource *
	)		`[protected]`

called by pqPipelineFilter when the connections change.

void pqPipelineSource::addConsumer	(	int	outputport,
		pqPipelineSource *
	)		`[protected]`

Friends And Related Function Documentation

friend class pqPipelineFilter [friend]

Definition at line 178 of file pqPipelineSource.h.

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

/home/kitware/Dashboards/My Tests/ParaView/Qt/Core/pqPipelineSource.h

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation