a proxy excapsulation a pipeline of proxies. More...
#include <vtkSMCompoundSourceProxy.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | AddProxy (const char *name, vtkSMProxy *proxy) |
| virtual void | CreateOutputPorts () |
| virtual void | CreateSelectionProxies () |
| virtual void | UpdateVTKObjects () |
| vtkPVXMLElement * | SaveDefinition (vtkPVXMLElement *root) |
| void | ExposeProperty (const char *proxyName, const char *propertyName, const char *exposedName) |
| void | ExposeOutputPort (const char *proxyName, const char *portName, const char *exposedName) |
| void | ExposeOutputPort (const char *proxyName, unsigned int portIndex, const char *exposedName) |
| unsigned int | GetNumberOfProxies () |
| vtkSMProxy * | GetProxy (unsigned int cc) |
| vtkSMProxy * | GetProxy (const char *name) |
| const char * | GetProxyName (unsigned int index) |
Static Public Member Functions | |
| static vtkSMCompoundSourceProxy * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkSMCompoundSourceProxy * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkSMCompoundSourceProxy () | |
| ~vtkSMCompoundSourceProxy () | |
| virtual int | ReadXMLAttributes (vtkSMSessionProxyManager *pm, vtkPVXMLElement *element) |
| virtual void | CreateVTKObjects () |
| int | ShouldWriteValue (vtkPVXMLElement *valueElem) |
| void | TraverseForProperties (vtkPVXMLElement *root) |
| void | StripValues (vtkPVXMLElement *propertyElem) |
Detailed Description
a proxy excapsulation a pipeline of proxies.
vtkSMCompoundSourceProxy is a proxy that allows grouping of multiple proxies. vtkSMProxy has also this capability since a proxy can have sub-proxies. However, vtkSMProxy does not allow public access to these proxies. The only access is through exposed properties. The main reason behind this is consistency. There are proxies that will not work if the program accesses the sub-proxies directly. The main purpose of vtkSMCompoundSourceProxy is to provide an interface to access the sub-proxies. The compound proxy also maintains the connections between subproxies. This makes it possible to encapsulate a pipeline into a single proxy. Since vtkSMCompoundSourceProxy is a vtkSMSourceProxy, it can be directly used to input to other filters, representations etc. vtkSMCompoundSourceProxy provides API to exposed properties from sub proxies as well as output ports of the subproxies.
Definition at line 42 of file vtkSMCompoundSourceProxy.h.
Constructor & Destructor Documentation
| vtkSMCompoundSourceProxy::vtkSMCompoundSourceProxy | ( | ) | [protected] |
| vtkSMCompoundSourceProxy::~vtkSMCompoundSourceProxy | ( | ) | [protected] |
Member Function Documentation
| static vtkSMCompoundSourceProxy* vtkSMCompoundSourceProxy::New | ( | ) | [static] |
Reimplemented from vtkSMSourceProxy.
| virtual const char* vtkSMCompoundSourceProxy::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMSourceProxy.
| static int vtkSMCompoundSourceProxy::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMSourceProxy.
| virtual int vtkSMCompoundSourceProxy::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMSourceProxy.
| static vtkSMCompoundSourceProxy* vtkSMCompoundSourceProxy::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMSourceProxy.
| void vtkSMCompoundSourceProxy::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMSourceProxy.
| void vtkSMCompoundSourceProxy::AddProxy | ( | const char * | name, |
| vtkSMProxy * | proxy | ||
| ) |
Add a proxy to be included in this compound proxy. The name must be unique to each proxy added, otherwise the previously added proxy will be replaced.
| void vtkSMCompoundSourceProxy::ExposeProperty | ( | const char * | proxyName, |
| const char * | propertyName, | ||
| const char * | exposedName | ||
| ) |
Expose a property from the sub proxy (added using AddProxy). Only exposed properties are accessible externally. Note that the sub proxy whose property is being exposed must have been already added using AddProxy().
| void vtkSMCompoundSourceProxy::ExposeOutputPort | ( | const char * | proxyName, |
| const char * | portName, | ||
| const char * | exposedName | ||
| ) |
Expose an output port from a subproxy. Exposed output ports are treated as output ports of the vtkSMCompoundSourceProxy itself. This method does not may the output port available. One must call CreateOutputPorts().
| void vtkSMCompoundSourceProxy::ExposeOutputPort | ( | const char * | proxyName, |
| unsigned int | portIndex, | ||
| const char * | exposedName | ||
| ) |
Expose an output port from a subproxy. Exposed output ports are treated as output ports of the vtkSMCompoundSourceProxy itself. This method does not may the output port available. One must call CreateOutputPorts().
| unsigned int vtkSMCompoundSourceProxy::GetNumberOfProxies | ( | ) | [inline] |
Returns the number of sub-proxies.
Definition at line 86 of file vtkSMCompoundSourceProxy.h.
| vtkSMProxy* vtkSMCompoundSourceProxy::GetProxy | ( | unsigned int | cc | ) | [inline] |
Returns the sub proxy at a given index.
Definition at line 92 of file vtkSMCompoundSourceProxy.h.
| vtkSMProxy* vtkSMCompoundSourceProxy::GetProxy | ( | const char * | name | ) | [inline] |
Returns the subproxy with the given name.
Definition at line 98 of file vtkSMCompoundSourceProxy.h.
| const char* vtkSMCompoundSourceProxy::GetProxyName | ( | unsigned int | index | ) | [inline] |
Returns the name used to store sub-proxy. Returns 0 if sub-proxy does not exist.
Definition at line 105 of file vtkSMCompoundSourceProxy.h.
| virtual void vtkSMCompoundSourceProxy::CreateOutputPorts | ( | ) | [virtual] |
Creates the output port proxiess for this filter. Each output port proxy corresponds to an actual output port on the algorithm.
Reimplemented from vtkSMSourceProxy.
| virtual void vtkSMCompoundSourceProxy::CreateSelectionProxies | ( | ) | [virtual] |
Creates extract selection proxies for each output port if not already created. Overridden to update the selection proxies.
Reimplemented from vtkSMSourceProxy.
| virtual void vtkSMCompoundSourceProxy::UpdateVTKObjects | ( | ) | [virtual] |
Update the VTK object on the server by pushing the values of all modifed properties (un-modified properties are ignored). If the object has not been created, it will be created first.
Reimplemented from vtkSMProxy.
| vtkPVXMLElement* vtkSMCompoundSourceProxy::SaveDefinition | ( | vtkPVXMLElement * | root | ) |
This is the same as save state except it will remove all references to "outside" proxies. Outside proxies are proxies that are not contained in the compound proxy. As a result, the saved state will be self contained. Returns the top element created. It is the caller's responsibility to delete the returned element. If root is NULL, the returned element will be a top level element.
| virtual int vtkSMCompoundSourceProxy::ReadXMLAttributes | ( | vtkSMSessionProxyManager * | pm, |
| vtkPVXMLElement * | element | ||
| ) | [protected, virtual] |
Read attributes from an XML element.
Reimplemented from vtkSMSourceProxy.
| virtual void vtkSMCompoundSourceProxy::CreateVTKObjects | ( | ) | [protected, virtual] |
Call superclass' and then assigns a new executive (vtkCompositeDataPipeline)
Reimplemented from vtkSMSourceProxy.
| int vtkSMCompoundSourceProxy::ShouldWriteValue | ( | vtkPVXMLElement * | valueElem | ) | [protected] |
| void vtkSMCompoundSourceProxy::TraverseForProperties | ( | vtkPVXMLElement * | root | ) | [protected] |
| void vtkSMCompoundSourceProxy::StripValues | ( | vtkPVXMLElement * | propertyElem | ) | [protected] |
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMCompoundSourceProxy.h
