Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkSISourceProxy Class Reference

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

#include <vtkSISourceProxy.h>

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

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) override
 
virtual vtkAlgorithmOutputGetOutputPort (int port)
 Returns the vtkAlgorithmOutput for an output port, if valid. More...
 
void UpdatePipelineInformation () override
 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 () override
 Overridden to update the output ports. More...
 
- Public Member Functions inherited from vtkSIProxy
void AboutToDelete () override
 This method is called before the deletion of the SIObject. More...
 
void Push (vtkSMMessage *msg) override
 Push a new state to the underneath implementation. More...
 
void Pull (vtkSMMessage *msg) override
 Pull the current state of the underneath implementation. More...
 
vtkSIPropertyGetSIProperty (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...
 
virtual bool ExtendDefinition (const char *xml)
 Counter part to vtkSMSelfGeneratingSourceProxy::ExtendDefinition(). More...
 
const char * GetLogNameOrDefault ()
 A helper that makes up an default name if none is provided. More...
 
vtkObjectBaseGetVTKObject ()
 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
virtual void Initialize (vtkPVSessionCore *session)
 Initializes the instance. More...
 
vtkClientServerInterpreterGetInterpreter ()
 Provides access to the Interpreter. More...
 
vtkSIObjectGetSIObject (vtkTypeUInt32 globalid) const
 Convenience method to obtain a vtkSIObject subclass given its global id. More...
 
vtkObjectGetRemoteObject (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...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSISourceProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSISourceProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSIProxy
static vtkSIProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSIProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSIObject
static vtkSIObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSIObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSISourceProxy ()
 
 ~vtkSISourceProxy () override
 
bool CreateVTKObjects () override
 Overridden to setup the output ports and pipelines for the output ports. More...
 
bool ReadXMLAttributes (vtkPVXMLElement *element) override
 Read xml-attributes. More...
 
void OnCreateVTKObjects () override
 Called after CreateVTKObjects(). 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 () override
 
virtual vtkObjectBaseNewVTKObject (const char *className)
 Create an instance of the class specified. More...
 
vtkSIProxyGetSubSIProxy (const char *name)
 Returns the subproxy helper for the subproxy with the given name, if any. More...
 
vtkSIProxyDefinitionManagerGetProxyDefinitionManager ()
 Provides access to the vtkSIProxyDefinitionManager held by the session. More...
 
virtual void DeleteVTKObjects ()
 Called to delete VTK objects. 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 *)
 
virtual char * GetLogName ()
 
void SetLogName (const char *name)
 
unsigned int GetNumberOfSubSIProxys ()
 API to iterate over subproxy helpers. More...
 
vtkSIProxyGetSubSIProxy (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 ()
 
 ~vtkSIObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

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< vtkObjectBaseVTKObject
 
bool ObjectsCreated
 
- Protected Attributes inherited from vtkSIObject
vtkWeakPointer< vtkClientServerInterpreterInterpreter
 
vtkWeakPointer< vtkPVSessionCoreSessionCore
 
vtkSMMessageLastPushedMessage
 
vtkTypeUInt32 GlobalID
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 23 of file vtkSISourceProxy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 27 of file vtkSISourceProxy.h.

Constructor & Destructor Documentation

◆ vtkSISourceProxy()

vtkSISourceProxy::vtkSISourceProxy ( )
protected

◆ ~vtkSISourceProxy()

vtkSISourceProxy::~vtkSISourceProxy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSISourceProxy* vtkSISourceProxy::New ( )
static

◆ GetClassName()

virtual const char* vtkSISourceProxy::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkSIProxy.

Reimplemented in vtkSIPythonSourceProxy, vtkSIImageTextureProxy, and vtkSIWriterProxy.

◆ GetOutputPort()

virtual vtkAlgorithmOutput* vtkSISourceProxy::GetOutputPort ( int  port)
virtual

Returns the vtkAlgorithmOutput for an output port, if valid.

Reimplemented in vtkSICompoundSourceProxy.

◆ UpdatePipelineInformation()

void vtkSISourceProxy::UpdatePipelineInformation ( )
overridevirtual

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 particularly useful for a Catalyst session that does not contains any real data.

Definition at line 55 of file vtkSISourceProxy.h.

◆ RecreateVTKObjects()

void vtkSISourceProxy::RecreateVTKObjects ( )
overridevirtual

Overridden to update the output ports.

Reimplemented from vtkSIProxy.

Reimplemented in vtkSIPythonSourceProxy.

◆ CreateVTKObjects()

bool vtkSISourceProxy::CreateVTKObjects ( )
overrideprotectedvirtual

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

Reimplemented from vtkSIProxy.

◆ ReadXMLAttributes()

bool vtkSISourceProxy::ReadXMLAttributes ( vtkPVXMLElement element)
overrideprotectedvirtual

Read xml-attributes.

Reimplemented from vtkSIProxy.

Reimplemented in vtkSIWriterProxy.

◆ OnCreateVTKObjects()

void vtkSISourceProxy::OnCreateVTKObjects ( )
overrideprotectedvirtual

Called after CreateVTKObjects().

The main difference for subclasses when overriding CreateVTKObjects() or OnCreateVTKObjects() is that CreateVTKObjects() is called before ReadXMLAttributes() is called, while OnCreateVTKObjects() is called after ReadXMLAttributes().

Reimplemented from vtkSIProxy.

Reimplemented in vtkSIWriterProxy, and vtkSIImageTextureProxy.

◆ 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 103 of file vtkSISourceProxy.h.

Member Data Documentation

◆ ExecutiveName

char* vtkSISourceProxy::ExecutiveName
protected

Definition at line 99 of file vtkSISourceProxy.h.

◆ DisablePipelineExecution

bool vtkSISourceProxy::DisablePipelineExecution
protected

Definition at line 100 of file vtkSISourceProxy.h.


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