pqOutputPort is a server manager model item for an output port of any pqPipelineSource item. More...

#include <pqOutputPort.h>

Inheritance diagram for pqOutputPort:

Collaboration diagram for pqOutputPort:

Public Slots
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. More...

Signals
void	connectionAdded (pqOutputPort port, pqPipelineSource consumer)
	Fired when a connection is added between this output port and a consumer. More...

void	preConnectionAdded (pqOutputPort port, pqPipelineSource consumer)

void	connectionRemoved (pqOutputPort port, pqPipelineSource consumer)
	Fired when a connection is removed between this output port and a consumer. More...

void	preConnectionRemoved (pqOutputPort port, pqPipelineSource consumer)

void	representationAdded (pqOutputPort source, pqDataRepresentation repr)
	fired when a representation is added. More...

void	representationRemoved (pqOutputPort source, pqDataRepresentation repr)
	fired when a representation is removed. More...

void	visibilityChanged (pqOutputPort source, pqDataRepresentation repr)
	Fired when the visbility of a representation for the source changes. More...

Signals inherited from pqProxy
void	nameChanged (pqServerManagerModelItem *)
	Fired when the name of the proxy is changed. More...

void	modifiedStateChanged (pqServerManagerModelItem *)
	Fired when the modified status changes for the proxy. More...

Public Member Functions
	pqOutputPort (pqPipelineSource *source, int portno)

	~pqOutputPort () override

vtkSMOutputPort *	getOutputPortProxy () const
	Returns the vtkSMOutputPort proxy for this port. More...

pqPipelineSource *	getSource () const
	Returns the pqPipelineSource whose output port this is. More...

vtkSMSourceProxy *	getSourceProxy () const
	Return the vtkSMSourceProxy for the source. More...

pqServer *	getServer () const
	Returns the server connection on which this output port exists. More...

int	getPortNumber () const
	Returns the port number of the output port which this item represents. More...

QString	getPortName () const
	Returns the port name for this output port. More...

int	getNumberOfConsumers () const
	Returns the number of consumers connected to this output port. More...

pqPipelineSource *	getConsumer (int index) const
	Get the consumer at a particular index on this output port. More...

QList< pqPipelineSource * >	getConsumers () const
	Returns a list of consumers. More...

QList< pqDataRepresentation * >	getRepresentations (pqView *view) const
	Returns a list of representations for this output port in the given view. More...

pqDataRepresentation *	getRepresentation (pqView *view) const
	Returns the first representation for this output port in the given view. More...

QList< pqView * >	getViews () const
	Returns a list of render modules in which this output port has representations added (the representations may not be visible). More...

vtkPVDataInformation *	getDataInformation () const
	Returns the current data information at this output port. More...

vtkPVDataInformation *	getRankDataInformation (int rank) const
	Returns rank-specific data information. More...

vtkPVTemporalDataInformation *	getTemporalDataInformation ()
	Collects data information over time. More...

vtkPVDataInformation *	getSelectedDataInformation (int es_port=0) const
	Returns the current data information for the selected data from this output port. More...

const char *	getDataClassName () const
	Returns the class name of the output data. More...

vtkSMSourceProxy *	getSelectionInput ()
	Calls vtkSMSourceProxy::GetSelectionInput() on the underlying source proxy. More...

unsigned int	getSelectionInputPort ()
	Calls vtkSMSourceProxy::GetSelectionInputPort() on the underlying source proxy. More...

void	setSelectionInput (vtkSMSourceProxy *src, int port)
	Set the selection input. More...

QString	prettyName () const
	Returns a user friendly name for this port. More...

Public Member Functions inherited from pqProxy
	pqProxy (const QString &group, const QString &name, vtkSMProxy proxy, pqServer server, QObject *parent=nullptr)

	~pqProxy () override

pqServer *	getServer () const
	Get the server on which this proxy exists. More...

void	rename (const QString &newname)
	This is a convenience method. More...

const QString &	getSMName ()
	Get the name with which this proxy is registered on the server manager. More...

const QString &	getSMGroup ()

vtkSMProxy *	getProxy () const
	Get the vtkSMProxy this object stands for. More...

ModifiedState	modifiedState () const
	Gets whether or not the source has been modified. More...

void	setModifiedState (ModifiedState modified)
	Sets whether or not the source has been modified. More...

vtkPVXMLElement *	getHints () const
	Returns the hints for this proxy, if any. More...

QList< vtkSMProxy * >	getHelperProxies () const
	Returns a list of all helper proxies. More...

QList< vtkSMProxy * >	getHelperProxies (const QString &key) const
	Returns a list of all the helper proxies added with a given key. More...

QList< QString >	getHelperKeys () const
	Returns the keys for helper proxies. More...

virtual void	addHelperProxy (const QString &key, vtkSMProxy *)
	Concept of helper proxies: A pqProxy is created for every important vtkSMProxy registered. More...

void	removeHelperProxy (const QString &key, vtkSMProxy *)

void	updateHelperProxies () const
	Updates the internal datastructures using the proxies currently registered under the group that would be used for helper proxies. More...

vtkSMSessionProxyManager *	proxyManager () const
	Returns the proxy manager by calling this->getProxy()->GetProxyManager();. More...

bool	userModifiedSMName ()
	Return whether or not the user has modified the GUI name of the source. More...

Public Member Functions inherited from pqServerManagerModelItem
	pqServerManagerModelItem (QObject *parent=nullptr)

	~pqServerManagerModelItem () override

Protected Slots
void	onRepresentationVisibilityChanged ()

Protected Slots inherited from pqProxy
void	onProxyRegistered (const QString &, const QString &, vtkSMProxy *)

void	onProxyUnRegistered (const QString &, const QString &, vtkSMProxy *)

Protected Member Functions
void	removeConsumer (pqPipelineSource *)
	called by pqPipelineSource when the connections change. More...

void	addConsumer (pqPipelineSource *)

void	addRepresentation (pqDataRepresentation *)
	Called by pqPipelineSource when the representations are added/removed. More...

void	removeRepresentation (pqDataRepresentation *)

Protected Member Functions inherited from pqProxy
void	setSMName (const QString &new_name)
	Make this pqProxy take on a new identity. More...

virtual void	initialize ()

virtual void	addInternalHelperProxy (const QString &key, vtkSMProxy *) const

virtual void	removeInternalHelperProxy (const QString &key, vtkSMProxy *) const

Protected Member Functions inherited from pqServerManagerModelItem
vtkEventQtSlotConnect *	getConnector ()
	All subclasses generally need some vtkEventQtSlotConnect instance to connect to VTK events. More...

Protected Attributes
pqPipelineSource *	Source

int	PortNumber

Friends
class	pqPipelineFilter

class	pqDataRepresentation

Additional Inherited Members
Public Types inherited from pqProxy
enum	ModifiedState { UNINITIALIZED, MODIFIED, UNMODIFIED }
	The modification state of this proxy. More...

Static Public Member Functions inherited from pqProxy
static pqProxy *	findProxyWithHelper (vtkSMProxy *aproxy, QString &key)
	Returns a pqProxy instance, of any, whose helper proxy is the aproxy. More...

static std::string	rstToHtml (const char *rstStr)
	convert proxy documentation from RST to HTML (so that it can be used in Qt) More...

static QString	rstToHtml (const QString &rstStr)
	convert proxy documentation from RST to HTML (so that it can be used in Qt) More...

Detailed Description

pqOutputPort is a server manager model item for an output port of any pqPipelineSource item.

This makes it possible to refer to a particular output port in the server manager model. The pqPipelineSource keeps references to all its output ports. The only way to access pqOutputPort items is through the pqPipelineSource. One can obtain the pqPipelineSource item from a pqOutputPort using getSource(). Once the outputs can be named, we will change this class to use output port names instead of numbers.

Definition at line 29 of file pqOutputPort.h.

Constructor & Destructor Documentation

◆ pqOutputPort()

pqOutputPort::pqOutputPort	(	pqPipelineSource *	source,
		int	portno
	)

◆ ~pqOutputPort()

pqOutputPort::~pqOutputPort ( )

override

Member Function Documentation

◆ getOutputPortProxy()

vtkSMOutputPort* pqOutputPort::getOutputPortProxy ( ) const

Returns the vtkSMOutputPort proxy for this port.

◆ getSource()

pqPipelineSource* pqOutputPort::getSource ( ) const

inline

Returns the pqPipelineSource whose output port this is.

Definition at line 46 of file pqOutputPort.h.

◆ getSourceProxy()

vtkSMSourceProxy* pqOutputPort::getSourceProxy ( ) const

Return the vtkSMSourceProxy for the source.

◆ getServer()

pqServer* pqOutputPort::getServer ( ) const

Returns the server connection on which this output port exists.

◆ getPortNumber()

int pqOutputPort::getPortNumber ( ) const

inline

Returns the port number of the output port which this item represents.

Definition at line 61 of file pqOutputPort.h.

◆ getPortName()

QString pqOutputPort::getPortName ( ) const

Returns the port name for this output port.

◆ getNumberOfConsumers()

int pqOutputPort::getNumberOfConsumers ( ) const

Returns the number of consumers connected to this output port.

◆ getConsumer()

pqPipelineSource* pqOutputPort::getConsumer ( int index ) const

Get the consumer at a particular index on this output port.

◆ getConsumers()

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

Returns a list of consumers.

◆ getRepresentations()

QList<pqDataRepresentation*> pqOutputPort::getRepresentations ( pqView * view ) const

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

If view == nullptr, returns all representations of this port.

◆ getRepresentation()

pqDataRepresentation* pqOutputPort::getRepresentation ( pqView * view ) const

Returns the first representation for this output port in the given view.

If view is nullptr, returns 0.

◆ getViews()

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

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

◆ getDataInformation()

vtkPVDataInformation* pqOutputPort::getDataInformation ( ) const

Returns the current data information at this output port.

This does not update the pipeline, it simply returns the data information for data currently present on the output port on the server.

◆ getRankDataInformation()

vtkPVDataInformation* pqOutputPort::getRankDataInformation ( int rank ) const

Returns rank-specific data information.

◆ getTemporalDataInformation()

vtkPVTemporalDataInformation* pqOutputPort::getTemporalDataInformation ( )

Collects data information over time.

This can potentially be a very slow process, so use with caution.

◆ getSelectedDataInformation()

vtkPVDataInformation* pqOutputPort::getSelectedDataInformation ( int es_port = 0 ) const

Returns the current data information for the selected data from this output port.

es_port is the output port from the internal vtkPVExtractSelection proxy.

◆ getDataClassName()

const char* pqOutputPort::getDataClassName ( ) const

Returns the class name of the output data.

◆ getSelectionInput()

vtkSMSourceProxy* pqOutputPort::getSelectionInput ( )

Calls vtkSMSourceProxy::GetSelectionInput() on the underlying source proxy.

◆ getSelectionInputPort()

unsigned int pqOutputPort::getSelectionInputPort ( )

Calls vtkSMSourceProxy::GetSelectionInputPort() on the underlying source proxy.

◆ setSelectionInput()

void pqOutputPort::setSelectionInput	(	vtkSMSourceProxy *	src,
		int	port
	)

Set the selection input.

◆ prettyName()

QString pqOutputPort::prettyName ( ) const

Returns a user friendly name for this port.

◆ renderAllViews

void pqOutputPort::renderAllViews ( bool force = false )

slot

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.

◆ connectionAdded

void pqOutputPort::connectionAdded	(	pqOutputPort *	port,
		pqPipelineSource *	consumer
	)

signal

Fired when a connection is added between this output port and a consumer.

◆ preConnectionAdded

void pqOutputPort::preConnectionAdded	(	pqOutputPort *	port,
		pqPipelineSource *	consumer
	)

signal

◆ connectionRemoved

void pqOutputPort::connectionRemoved	(	pqOutputPort *	port,
		pqPipelineSource *	consumer
	)

signal

Fired when a connection is removed between this output port and a consumer.

◆ preConnectionRemoved

void pqOutputPort::preConnectionRemoved	(	pqOutputPort *	port,
		pqPipelineSource *	consumer
	)

signal

◆ representationAdded

void pqOutputPort::representationAdded	(	pqOutputPort *	source,
		pqDataRepresentation *	repr
	)

signal

fired when a representation is added.

◆ representationRemoved

void pqOutputPort::representationRemoved	(	pqOutputPort *	source,
		pqDataRepresentation *	repr
	)

signal

fired when a representation is removed.

◆ visibilityChanged

void pqOutputPort::visibilityChanged	(	pqOutputPort *	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.

◆ onRepresentationVisibilityChanged

void pqOutputPort::onRepresentationVisibilityChanged ( )

protectedslot

◆ removeConsumer()

void pqOutputPort::removeConsumer ( pqPipelineSource * )

protected

called by pqPipelineSource when the connections change.

◆ addConsumer()

void pqOutputPort::addConsumer ( pqPipelineSource * )

protected

◆ addRepresentation()

void pqOutputPort::addRepresentation ( pqDataRepresentation * )

protected

Called by pqPipelineSource when the representations are added/removed.

◆ removeRepresentation()

void pqOutputPort::removeRepresentation ( pqDataRepresentation * )

protected

Friends And Related Function Documentation

◆ pqPipelineFilter

friend class pqPipelineFilter

friend

Definition at line 198 of file pqOutputPort.h.

◆ pqDataRepresentation

friend class pqDataRepresentation

friend

Definition at line 199 of file pqOutputPort.h.

Member Data Documentation

◆ Source

pqPipelineSource* pqOutputPort::Source

protected

Definition at line 213 of file pqOutputPort.h.

◆ PortNumber

int pqOutputPort::PortNumber

protected

Definition at line 214 of file pqOutputPort.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Core/pqOutputPort.h

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqOutputPort()

◆ ~pqOutputPort()

Member Function Documentation

◆ getOutputPortProxy()

◆ getSource()

◆ getSourceProxy()

◆ getServer()

◆ getPortNumber()

◆ getPortName()

◆ getNumberOfConsumers()

◆ getConsumer()

◆ getConsumers()

◆ getRepresentations()

◆ getRepresentation()

◆ getViews()

◆ getDataInformation()

◆ getRankDataInformation()

◆ getTemporalDataInformation()

◆ getSelectedDataInformation()

◆ getDataClassName()

◆ getSelectionInput()

◆ getSelectionInputPort()

◆ setSelectionInput()

◆ prettyName()

◆ renderAllViews

◆ connectionAdded

◆ preConnectionAdded

◆ connectionRemoved

◆ preConnectionRemoved

◆ representationAdded

◆ representationRemoved

◆ visibilityChanged

◆ onRepresentationVisibilityChanged

◆ removeConsumer()

◆ addConsumer()

◆ addRepresentation()

◆ removeRepresentation()

Friends And Related Function Documentation

◆ pqPipelineFilter

◆ pqDataRepresentation

Member Data Documentation

◆ Source

◆ PortNumber