vtkSISourceProxy is the server-side helper for a vtkSMSourceProxy. More...

#include <vtkSISourceProxy.h>

Inheritance diagram for vtkSISourceProxy:

[legend]

Collaboration diagram for vtkSISourceProxy:

Public Types
typedef vtkSIProxy	Superclass

Public Types inherited from vtkSIProxy
typedef vtkSIObject	Superclass

Public Types inherited from vtkSIObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkAlgorithmOutput *	GetOutputPort (int port)
	Returns the vtkAlgorithmOutput for an output port, if valid. More...

virtual void	UpdatePipelineInformation ()
	Triggers UpdateInformation() on vtkObject if possible. More...

virtual void	UpdatePipeline (int port, double time, bool doTime)
	Triggers UpdatePipeline(). More...

virtual void	SetupSelectionProxy (int port, vtkSIProxy *extractSelection)
	setups extract selection proxies. More...

virtual void	SetDisablePipelineExecution (bool value)
	Allow to shut down pipeline execution. More...

void	RecreateVTKObjects () VTK_OVERRIDE
	Overridden to update the output ports. More...

Public Member Functions inherited from vtkSIProxy
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	AboutToDelete ()
	This method is called before the deletion of the SIObject. More...

virtual void	Push (vtkSMMessage *msg)
	Push a new state to the underneath implementation. More...

virtual void	Pull (vtkSMMessage *msg)
	Pull the current state of the underneath implementation. More...

vtkSIProperty *	GetSIProperty (const char *name)
	Provides access to the property helper. More...

bool	IsNullProxy ()
	Return true if that Proxy is supposed to have NO vtk class, which means its a NullProxy. More...

vtkObjectBase *	GetVTKObject ()
	Returns access to the VTKObject pointer, if any. More...

void	SetVTKObject (vtkObjectBase *)
	Returns access to the VTKObject pointer, if any. More...

virtual char *	GetVTKClassName ()
	Returns the VTKClassName. More...

virtual char *	GetXMLName ()
	Assigned by the XML parser. More...

virtual char *	GetXMLGroup ()
	Assigned by the XML parser. More...

virtual void	AddInput (int input_port, vtkAlgorithmOutput connection, const char method)
	These methods are called to add/remove input connections by vtkSIInputProperty. More...

virtual void	CleanInputs (const char *method)
	These methods are called to add/remove input connections by vtkSIInputProperty. More...

Public Member Functions inherited from vtkSIObject
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Initialize (vtkPVSessionCore *session)
	Initializes the instance. More...

vtkClientServerInterpreter *	GetInterpreter ()
	Provides access to the Interpreter. More...

vtkSIObject *	GetSIObject (vtkTypeUInt32 globalid) const
	Convenience method to obtain a vtkSIObject subclass given its global id. More...

vtkObject *	GetRemoteObject (vtkTypeUInt32 globalid)
	Convenience method to obtain a vtkObject subclass given its global id. More...

virtual void	SetGlobalID (vtkTypeUInt32)
	Get/Set the global id for this object. More...

virtual vtkTypeUInt32	GetGlobalID ()
	Get/Set the global id for this object. More...

Static Public Member Functions
static vtkSISourceProxy *	New ()

static int	IsTypeOf (const char *type)

static vtkSISourceProxy *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSIProxy
static vtkSIProxy *	New ()

static int	IsTypeOf (const char *type)

static vtkSIProxy *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSIObject
static vtkSIObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSIObject *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkSISourceProxy ()

	~vtkSISourceProxy ()

bool	CreateVTKObjects () VTK_OVERRIDE
	Overridden to setup the output ports and pipelines for the output ports. More...

virtual bool	ReadXMLAttributes (vtkPVXMLElement *element)
	Read xml-attributes. More...

virtual bool	CreateOutputPorts ()
	Create the output ports and add post filters for each output port. More...

virtual void	SetExecutiveName (const char *)


void	MarkStartEvent ()
	Callbacks to add start/end events to the timer log. More...

void	MarkEndEvent ()
	Callbacks to add start/end events to the timer log. More...

Protected Member Functions inherited from vtkSIProxy
	vtkSIProxy ()

	~vtkSIProxy ()

vtkSIProxy *	GetSubSIProxy (const char *name)
	Returns the subproxy helper for the subproxy with the given name, if any. More...

vtkSIProxyDefinitionManager *	GetProxyDefinitionManager ()
	Provides access to the vtkSIProxyDefinitionManager held by the session. More...

void	DeleteVTKObjects ()
	Called to delete VTK objects. More...

virtual void	OnCreateVTKObjects ()
	Called after CreateVTKObjects(). More...

bool	InitializeAndCreateVTKObjects (vtkSMMessage *message)
	Called by vtkSIProxy::Push() to ensure that the vtkSIProxy has been initialized. More...

void	AddSIProperty (const char name, vtkSIProperty )
	Adds a vtkSMProperty's server-implementation. More...

virtual void	SetVTKClassName (const char *)

virtual void	SetXMLGroup (const char *)

virtual void	SetXMLName (const char *)

virtual void	SetXMLSubProxyName (const char *)

virtual void	SetPostPush (const char *)

virtual void	SetPostCreation (const char *)

unsigned int	GetNumberOfSubSIProxys ()
	API to iterate over subproxy helpers. More...

vtkSIProxy *	GetSubSIProxy (unsigned int cc)
	API to iterate over subproxy helpers. More...

virtual bool	ReadXMLProperty (vtkPVXMLElement *property_element)
	Parses the XML to create property/subproxy helpers. More...

virtual bool	ReadXMLSubProxy (vtkPVXMLElement *subproxy_element)
	Parses the XML to create property/subproxy helpers. More...

Protected Member Functions inherited from vtkSIObject
	vtkSIObject ()

virtual	~vtkSIObject ()

Protected Attributes
char *	ExecutiveName

bool	DisablePipelineExecution

Protected Attributes inherited from vtkSIProxy
char *	VTKClassName

char *	XMLGroup

char *	XMLName

char *	XMLSubProxyName

char *	PostPush

char *	PostCreation

int	NumberOfInputPorts

vtkSmartPointer< vtkObjectBase >	VTKObject

bool	ObjectsCreated

Protected Attributes inherited from vtkSIObject
vtkWeakPointer< vtkClientServerInterpreter >	Interpreter

vtkWeakPointer< vtkPVSessionCore >	SessionCore

vtkSMMessage *	LastPushedMessage

vtkTypeUInt32	GlobalID

Friends
class	vtkSICompoundSourceProxy

Detailed Description

vtkSISourceProxy is the server-side helper for a vtkSMSourceProxy.

It adds support to handle various vtkAlgorithm specific Invoke requests coming from the client. vtkSISourceProxy also inserts post-processing filters for each output port from the vtkAlgorithm. These post-processing filters deal with things like parallelizing the data etc.

Definition at line 34 of file vtkSISourceProxy.h.

Member Typedef Documentation

§ Superclass

typedef vtkSIProxy vtkSISourceProxy::Superclass

Definition at line 38 of file vtkSISourceProxy.h.

Constructor & Destructor Documentation

§ vtkSISourceProxy()

vtkSISourceProxy::vtkSISourceProxy ( )

protected

§ ~vtkSISourceProxy()

vtkSISourceProxy::~vtkSISourceProxy ( )

protected

Member Function Documentation

§ New()

static vtkSISourceProxy* vtkSISourceProxy::New ( )

static

§ GetClassName()

virtual const char* vtkSISourceProxy::GetClassName ( )

virtual

Reimplemented from vtkSIProxy.

Reimplemented in vtkSIMetaReaderProxy, vtkSICompoundSourceProxy, vtkSIImageTextureProxy, and vtkSIWriterProxy.

§ IsTypeOf()

static int vtkSISourceProxy::IsTypeOf ( const char * type )

static

§ IsA()

virtual int vtkSISourceProxy::IsA ( const char * type )

virtual

Reimplemented from vtkSIProxy.

Reimplemented in vtkSIMetaReaderProxy, vtkSICompoundSourceProxy, vtkSIImageTextureProxy, and vtkSIWriterProxy.

§ SafeDownCast()

static vtkSISourceProxy* vtkSISourceProxy::SafeDownCast ( vtkObject * o )

static

§ PrintSelf()

void vtkSISourceProxy::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

§ GetOutputPort()

virtual vtkAlgorithmOutput* vtkSISourceProxy::GetOutputPort ( int port )

virtual

Returns the vtkAlgorithmOutput for an output port, if valid.

Reimplemented in vtkSICompoundSourceProxy.

§ UpdatePipelineInformation()

virtual void vtkSISourceProxy::UpdatePipelineInformation ( )

virtual

Triggers UpdateInformation() on vtkObject if possible.

Reimplemented from vtkSIProxy.

§ UpdatePipeline()

virtual void vtkSISourceProxy::UpdatePipeline	(	int	port,
		double	time,
		bool	doTime
	)

virtual

Triggers UpdatePipeline().

Called from client.

§ SetupSelectionProxy()

virtual void vtkSISourceProxy::SetupSelectionProxy	(	int	port,
		vtkSIProxy *	extractSelection
	)

virtual

setups extract selection proxies.

§ SetDisablePipelineExecution()

virtual void vtkSISourceProxy::SetDisablePipelineExecution ( bool value )

inlinevirtual

Allow to shut down pipeline execution.

This is particulary useful for a Catalyst session that does not contains any real data.

Definition at line 66 of file vtkSISourceProxy.h.

§ RecreateVTKObjects()

void vtkSISourceProxy::RecreateVTKObjects ( )

virtual

Overridden to update the output ports.

Reimplemented from vtkSIProxy.

§ CreateVTKObjects()

bool vtkSISourceProxy::CreateVTKObjects ( )

protectedvirtual

Overridden to setup the output ports and pipelines for the output ports.

Reimplemented from vtkSIProxy.

Reimplemented in vtkSIImageTextureProxy.

§ ReadXMLAttributes()

virtual bool vtkSISourceProxy::ReadXMLAttributes ( vtkPVXMLElement * element )

protectedvirtual

Read xml-attributes.

Reimplemented from vtkSIProxy.

Reimplemented in vtkSIWriterProxy, vtkSICompoundSourceProxy, and vtkSIMetaReaderProxy.

§ CreateOutputPorts()

virtual bool vtkSISourceProxy::CreateOutputPorts ( )

protectedvirtual

Create the output ports and add post filters for each output port.

CreateOutputPorts is only called when an output-port is requested, i.e. GetOutputPort() is called.

Reimplemented in vtkSICompoundSourceProxy.

§ MarkStartEvent()

void vtkSISourceProxy::MarkStartEvent ( )

protected

Callbacks to add start/end events to the timer log.

§ MarkEndEvent()

void vtkSISourceProxy::MarkEndEvent ( )

protected

Callbacks to add start/end events to the timer log.

§ SetExecutiveName()

virtual void vtkSISourceProxy::SetExecutiveName ( const char * )

protectedvirtual

Friends And Related Function Documentation

§ vtkSICompoundSourceProxy

friend class vtkSICompoundSourceProxy

friend

Definition at line 106 of file vtkSISourceProxy.h.

Member Data Documentation

§ ExecutiveName

char* vtkSISourceProxy::ExecutiveName

protected

Definition at line 102 of file vtkSISourceProxy.h.

§ DisablePipelineExecution

bool vtkSISourceProxy::DisablePipelineExecution

protected

Definition at line 103 of file vtkSISourceProxy.h.

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

/builddir/build/BUILD/ParaView-v5.2.0/ParaViewCore/ServerImplementation/Core/vtkSISourceProxy.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

§ Superclass

Constructor & Destructor Documentation

§ vtkSISourceProxy()

§ ~vtkSISourceProxy()

Member Function Documentation

§ New()

§ GetClassName()

§ IsTypeOf()

§ IsA()

§ SafeDownCast()

§ PrintSelf()

§ GetOutputPort()

§ UpdatePipelineInformation()

§ UpdatePipeline()

§ SetupSelectionProxy()

§ SetDisablePipelineExecution()

§ RecreateVTKObjects()

§ CreateVTKObjects()

§ ReadXMLAttributes()

§ CreateOutputPorts()

§ MarkStartEvent()

§ MarkEndEvent()

§ SetExecutiveName()

Friends And Related Function Documentation

§ vtkSICompoundSourceProxy

Member Data Documentation

§ ExecutiveName

§ DisablePipelineExecution