Signals | Public Member Functions | Protected Member Functions | List of all members
pqExtractor Class Reference

pqProxy subclass for extractors More...

#include <pqExtractor.h>

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

Signals

void enabledStateChanged ()
 Fired when the enabled state for the extractor changes. More...
 
void producerAdded (pqServerManagerModelItem *producer, pqExtractor *self)
 Fired when the producer changes. More...
 
void producerRemoved (pqServerManagerModelItem *producer, pqExtractor *self)
 Fired when the producer 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

 pqExtractor (const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent=nullptr)
 
 ~pqExtractor () override
 
pqServerManagerModelItemproducer () const
 Returns the producer that provides the data or rendering results to this extractor. More...
 
bool isImageExtractor () const
 Returns true if this extractor is an image extract producer. More...
 
bool isDataExtractor () const
 Returns true if this extractor is a data extractor. More...
 
bool isEnabled () const
 Returns true if this extractor is enabled. More...
 
void toggleEnabledState (pqView *view)
 Convenience method to toggle enabled state. More...
 
- Public Member Functions inherited from pqProxy
 pqProxy (const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent=nullptr)
 
 ~pqProxy () override
 
pqServergetServer () 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 ()
 
vtkSMProxygetProxy () 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...
 
vtkPVXMLElementgetHints () 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...
 
vtkSMSessionProxyManagerproxyManager () 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 Member Functions

void initialize () override
 
- Protected Member Functions inherited from pqProxy
void setSMName (const QString &new_name)
 Make this pqProxy take on a new identity. More...
 
virtual void addInternalHelperProxy (const QString &key, vtkSMProxy *) const
 
virtual void removeInternalHelperProxy (const QString &key, vtkSMProxy *) const
 
- Protected Member Functions inherited from pqServerManagerModelItem
vtkEventQtSlotConnectgetConnector ()
 All subclasses generally need some vtkEventQtSlotConnect instance to connect to VTK events. More...
 

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 pqProxyfindProxyWithHelper (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...
 
- Protected Slots inherited from pqProxy
void onProxyRegistered (const QString &, const QString &, vtkSMProxy *)
 
void onProxyUnRegistered (const QString &, const QString &, vtkSMProxy *)
 

Detailed Description

pqProxy subclass for extractors

pqExtractor is an Qt-adaptor for an extractor proxy. Extractors are used in ParaView to generate data or image extracts. This class is used to represent such a proxy. It simply provides convenience API to make it easier to monitor an extractor proxy in the Qt code.

Definition at line 21 of file pqExtractor.h.

Constructor & Destructor Documentation

◆ pqExtractor()

pqExtractor::pqExtractor ( const QString &  group,
const QString &  name,
vtkSMProxy proxy,
pqServer server,
QObject *  parent = nullptr 
)

◆ ~pqExtractor()

pqExtractor::~pqExtractor ( )
override

Member Function Documentation

◆ producer()

pqServerManagerModelItem* pqExtractor::producer ( ) const

Returns the producer that provides the data or rendering results to this extractor.

When non-null, the returned value may be a pqOutputPort for generators producing data extracts or pqView for generators producing image extracts.

◆ isImageExtractor()

bool pqExtractor::isImageExtractor ( ) const

Returns true if this extractor is an image extract producer.

◆ isDataExtractor()

bool pqExtractor::isDataExtractor ( ) const

Returns true if this extractor is a data extractor.

◆ isEnabled()

bool pqExtractor::isEnabled ( ) const

Returns true if this extractor is enabled.

◆ toggleEnabledState()

void pqExtractor::toggleEnabledState ( pqView view)

Convenience method to toggle enabled state.

If view is non-null and the extractor is an image-extractor, then the view must be same as the producer for the extractor for this method to have any effect. For data-extractors, view is simply ignored.

◆ producerAdded

void pqExtractor::producerAdded ( pqServerManagerModelItem producer,
pqExtractor self 
)
signal

Fired when the producer changes.

These signals are fired after the change has been made i.e. this->producer() will return the new producer for both signals.

◆ producerRemoved

void pqExtractor::producerRemoved ( pqServerManagerModelItem producer,
pqExtractor self 
)
signal

Fired when the producer changes.

These signals are fired after the change has been made i.e. this->producer() will return the new producer for both signals.

◆ enabledStateChanged

void pqExtractor::enabledStateChanged ( )
signal

Fired when the enabled state for the extractor changes.

◆ initialize()

void pqExtractor::initialize ( )
overrideprotectedvirtual

Reimplemented from pqProxy.


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