proxy for a VTK source on a server More...
#include <vtkSMSourceProxy.h>
Detailed Description
proxy for a VTK source on a server
vtkSMSourceProxy manages VTK source(s) that are created on a server using the proxy pattern. In addition to functionality provided by vtkSMProxy, vtkSMSourceProxy provides method to connect and update sources. Each source proxy has one or more output ports (vtkSMOutputPort). Each port represents one output of one filter. These are created automatically (when CreateOutputPorts() is called) by the source. Each vtkSMSourceProxy creates a property called DataInformation. This property is a composite property that provides information about the output(s) of the VTK sources (obtained from the server)
- See also:
- vtkSMProxy vtkSMOutputPort vtkSMInputProperty
Definition at line 47 of file vtkSMSourceProxy.h.
Member Enumeration Documentation
Definition at line 167 of file vtkSMSourceProxy.h.
Constructor & Destructor Documentation
| vtkSMSourceProxy::vtkSMSourceProxy | ( | ) | [protected] |
| vtkSMSourceProxy::~vtkSMSourceProxy | ( | ) | [protected] |
Member Function Documentation
| static vtkSMSourceProxy* vtkSMSourceProxy::New | ( | ) | [static] |
Reimplemented from vtkSMProxy.
Reimplemented in vtkSMCompoundSourceProxy, vtkSMPVRepresentationProxy, vtkSMDataSourceProxy, vtkSMMultiServerSourceProxy, vtkSMWriterProxy, vtkSMPWriterProxy, vtkSMPSWriterProxy, vtkSMChartRepresentationProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMParallelCoordinatesRepresentationProxy, and vtkSMRepresentationProxy.
| virtual const char* vtkSMSourceProxy::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMProxy.
Reimplemented in vtkSMCompoundSourceProxy, vtkSMPVRepresentationProxy, vtkSMDataSourceProxy, vtkSMMultiServerSourceProxy, vtkSMWriterProxy, vtkSMPWriterProxy, vtkSMPSWriterProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMChartRepresentationProxy, vtkSMParallelCoordinatesRepresentationProxy, and vtkSMRepresentationProxy.
| static int vtkSMSourceProxy::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMProxy.
Reimplemented in vtkSMCompoundSourceProxy, vtkSMPVRepresentationProxy, vtkSMDataSourceProxy, vtkSMMultiServerSourceProxy, vtkSMWriterProxy, vtkSMPWriterProxy, vtkSMPSWriterProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMChartRepresentationProxy, vtkSMParallelCoordinatesRepresentationProxy, and vtkSMRepresentationProxy.
| virtual int vtkSMSourceProxy::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMProxy.
Reimplemented in vtkSMCompoundSourceProxy, vtkSMPVRepresentationProxy, vtkSMDataSourceProxy, vtkSMMultiServerSourceProxy, vtkSMWriterProxy, vtkSMPWriterProxy, vtkSMPSWriterProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMChartRepresentationProxy, vtkSMParallelCoordinatesRepresentationProxy, and vtkSMRepresentationProxy.
| static vtkSMSourceProxy* vtkSMSourceProxy::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMProxy.
Reimplemented in vtkSMCompoundSourceProxy, vtkSMPVRepresentationProxy, vtkSMDataSourceProxy, vtkSMMultiServerSourceProxy, vtkSMWriterProxy, vtkSMPWriterProxy, vtkSMPSWriterProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMChartRepresentationProxy, vtkSMParallelCoordinatesRepresentationProxy, and vtkSMRepresentationProxy.
| void vtkSMSourceProxy::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMProxy.
Reimplemented in vtkSMCompoundSourceProxy, vtkSMPVRepresentationProxy, vtkSMDataSourceProxy, vtkSMMultiServerSourceProxy, vtkSMWriterProxy, vtkSMPWriterProxy, vtkSMPSWriterProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMChartRepresentationProxy, vtkSMParallelCoordinatesRepresentationProxy, and vtkSMRepresentationProxy.
| virtual void vtkSMSourceProxy::UpdatePipelineInformation | ( | ) | [virtual] |
Calls UpdateInformation() on all sources.
Reimplemented from vtkSMProxy.
| virtual void vtkSMSourceProxy::UpdatePipeline | ( | ) | [virtual] |
Calls Update() on all sources. It also creates output ports if they are not already created.
Reimplemented in vtkSMRepresentationProxy, and vtkSMWriterProxy.
| virtual void vtkSMSourceProxy::UpdatePipeline | ( | double | time | ) | [virtual] |
Calls Update() on all sources with the given time request. It also creates output ports if they are not already created.
Reimplemented in vtkSMRepresentationProxy, and vtkSMWriterProxy.
| virtual int vtkSMSourceProxy::GetOutputPortsCreated | ( | ) | [virtual] |
Returns if the output port proxies have been created.
| virtual unsigned int vtkSMSourceProxy::GetNumberOfOutputPorts | ( | ) | [virtual] |
Return the number of output ports.
| virtual vtkSMOutputPort* vtkSMSourceProxy::GetOutputPort | ( | unsigned int | idx | ) | [virtual] |
Return an output port.
| virtual vtkSMOutputPort* vtkSMSourceProxy::GetOutputPort | ( | const char * | portname | ) | [virtual] |
Return an output port, given the name for the port. Each output port is assigned a unique name (either using the xml configuration or automatically). The automatically assigned names are of the type Output0, Output1 etc.
| virtual unsigned int vtkSMSourceProxy::GetOutputPortIndex | ( | const char * | portname | ) | [virtual] |
Returns the port index, given the name of an output port. Each output port is assigned a unique name (either using the xml configuration or automatically). The automatically assigned names are of the type Output0, Output1 etc. Returns VTK_UNSIGNED_INT_MAX (i.e. ~0u) when a port with given port name does not exist.
| virtual const char* vtkSMSourceProxy::GetOutputPortName | ( | unsigned int | index | ) | [virtual] |
Returns the output port name given its index. Each output port is assigned an unique name (either using the xml configuration or automatically). The automatically assigned names are of the type Output-0, Output-1 etc.
| vtkSMDocumentation* vtkSMSourceProxy::GetOutputPortDocumentation | ( | unsigned int | index | ) |
It is possible to provide some documentation for each output port in the configuraton xml. These methods provide access to the port specific documentation, if any. If no documentation is present, these methods will return 0.
| vtkSMDocumentation* vtkSMSourceProxy::GetOutputPortDocumentation | ( | const char * | portname | ) |
It is possible to provide some documentation for each output port in the configuraton xml. These methods provide access to the port specific documentation, if any. If no documentation is present, these methods will return 0.
| virtual void vtkSMSourceProxy::CreateOutputPorts | ( | ) | [virtual] |
Creates the output port proxies for this filter. Each output port proxy corresponds to an actual output port on the algorithm.
Reimplemented in vtkSMCompoundSourceProxy.
| vtkPVDataInformation* vtkSMSourceProxy::GetDataInformation | ( | ) | [inline] |
DataInformation is used by the source proxy to obtain information on the output(s) from the server. If update is false the pipeline will not be updated before gathering the data information.
Definition at line 112 of file vtkSMSourceProxy.h.
| vtkPVDataInformation* vtkSMSourceProxy::GetDataInformation | ( | unsigned int | outputIdx | ) |
DataInformation is used by the source proxy to obtain information on the output(s) from the server. If update is false the pipeline will not be updated before gathering the data information.
| virtual void vtkSMSourceProxy::CreateSelectionProxies | ( | ) | [virtual] |
Creates extract selection proxies for each output port if not already created.
Reimplemented in vtkSMCompoundSourceProxy.
| void vtkSMSourceProxy::SetSelectionInput | ( | unsigned int | portIndex, |
| vtkSMSourceProxy * | input, | ||
| unsigned int | outputPort | ||
| ) |
Set/Get the selection input. This is used to set the selection input to the extarction proxy for the output port identified by portIndex. If no extraction proxies are present, this method has no effect.
| vtkSMSourceProxy* vtkSMSourceProxy::GetSelectionInput | ( | unsigned int | portIndex | ) |
API to query selection input set using SetSelectionInput.
API to query selection input set using SetSelectionInput.
| void vtkSMSourceProxy::CleanSelectionInputs | ( | unsigned int | portIndex | ) |
Clean all selection inputs for the given port.
| vtkSMSourceProxy* vtkSMSourceProxy::GetSelectionOutput | ( | unsigned int | portIndex | ) |
Returns the source proxy which provides the selected data from the given output port.
| virtual int vtkSMSourceProxy::GetProcessSupport | ( | ) | [virtual] |
This returns information about whether the VTK algorithm supports multiple processes or not. SINGLE_PROCESS means that this algorithm works only in serial, MULTIPLE_PROCESSES means that it will only work in parallel (or it is useless in serial), BOTH means both :-) Default is BOTH. This ivar is filled from the xml configuration.
| unsigned int vtkSMSourceProxy::GetNumberOfAlgorithmOutputPorts | ( | ) |
Returns the number of output ports provided by the algorithm.
| virtual unsigned int vtkSMSourceProxy::GetNumberOfAlgorithmRequiredInputPorts | ( | ) | [virtual] |
Returns the number of non-optional input ports required by the algorithm. This value is cached after the first call.
| virtual vtkTypeUInt32 vtkSMSourceProxy::GetGlobalID | ( | ) | [virtual] |
Overridden to reserve additional IDs for use by "ExtractSelection" proxies.
Reimplemented from vtkSMRemoteObject.
| virtual void vtkSMSourceProxy::MarkDirty | ( | vtkSMProxy * | modifiedProxy | ) | [virtual] |
Marks the selection proxies dirty as well as chain to superclass.
Reimplemented from vtkSMProxy.
Reimplemented in vtkSMMultiServerSourceProxy, and vtkSMRepresentationProxy.
| virtual void vtkSMSourceProxy::InvalidateDataInformation | ( | ) | [protected, virtual] |
Mark the data information as invalid.
Reimplemented in vtkSMRepresentationProxy.
| virtual void vtkSMSourceProxy::CreateVTKObjects | ( | ) | [protected, virtual] |
Call superclass' and then assigns a new executive (vtkCompositeDataPipeline)
Reimplemented from vtkSMProxy.
Reimplemented in vtkSMCompoundSourceProxy, vtkSMRepresentationProxy, and vtkSMPVRepresentationProxy.
| virtual void vtkSMSourceProxy::SetExecutiveName | ( | const char * | ) | [protected, virtual] |
| virtual int vtkSMSourceProxy::ReadXMLAttributes | ( | vtkSMSessionProxyManager * | pm, |
| vtkPVXMLElement * | element | ||
| ) | [protected, virtual] |
Read attributes from an XML element.
Reimplemented from vtkSMProxy.
Reimplemented in vtkSMCompoundSourceProxy, vtkSMWriterProxy, and vtkSMPVRepresentationProxy.
| void vtkSMSourceProxy::CreateOutputPortsInternal | ( | vtkSMProxy * | op | ) | [protected] |
Internal method which creates the output port proxies using the proxy specified.
| void vtkSMSourceProxy::SetOutputPort | ( | unsigned int | index, |
| const char * | name, | ||
| vtkSMOutputPort * | port, | ||
| vtkSMDocumentation * | doc | ||
| ) | [protected] |
Method to set an output port at the given index. Provided for subclasses to add output ports. It replaces the output port at the given index, if any, The output ports will be resize to fit the specified index.
| void vtkSMSourceProxy::RemoveAllOutputPorts | ( | ) | [protected] |
Method to set an output port at the given index. Provided for subclasses to add output ports. It replaces the output port at the given index, if any, The output ports will be resize to fit the specified index.
| void vtkSMSourceProxy::SetExtractSelectionProxy | ( | unsigned int | index, |
| vtkSMSourceProxy * | proxy | ||
| ) | [protected] |
Method to set an output port at the given index. Provided for subclasses to add output ports. It replaces the output port at the given index, if any, The output ports will be resize to fit the specified index.
| void vtkSMSourceProxy::RemoveAllExtractSelectionProxies | ( | ) | [protected] |
Method to set an output port at the given index. Provided for subclasses to add output ports. It replaces the output port at the given index, if any, The output ports will be resize to fit the specified index.
| virtual void vtkSMSourceProxy::PostUpdateData | ( | ) | [protected, virtual] |
Overwritten from superclass to invoke
Reimplemented from vtkSMProxy.
Reimplemented in vtkSMRepresentationProxy.
Friends And Related Function Documentation
friend class vtkSMInputProperty [friend] |
These classes have been declared as friends to minimize the public interface exposed by vtkSMProxy. Each of these classes use a small subset of protected methods. This should be kept as such.
Reimplemented from vtkSMProxy.
Definition at line 181 of file vtkSMSourceProxy.h.
friend class vtkSMOutputPort [friend] |
Definition at line 182 of file vtkSMSourceProxy.h.
Member Data Documentation
int vtkSMSourceProxy::OutputPortsCreated [protected] |
Definition at line 184 of file vtkSMSourceProxy.h.
int vtkSMSourceProxy::ProcessSupport [protected] |
Definition at line 186 of file vtkSMSourceProxy.h.
char* vtkSMSourceProxy::ExecutiveName [protected] |
Definition at line 195 of file vtkSMSourceProxy.h.
bool vtkSMSourceProxy::DisableSelectionProxies [protected] |
Definition at line 223 of file vtkSMSourceProxy.h.
bool vtkSMSourceProxy::SelectionProxiesCreated [protected] |
Definition at line 224 of file vtkSMSourceProxy.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMSourceProxy.h
