ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSIProxy Class Reference

vtkSIProxy is the server-implementation for a vtkSMProxy that helps the vtkSMProxy with managing/updating VTK objects. More...

#include <vtkSIProxy.h>

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

Public Types

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 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...
 
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 void UpdatePipelineInformation ()
 Triggers UpdateInformation() on vtkObject if possible. More...
 
virtual void RecreateVTKObjects ()
 Called by vtkSMProxy::RecreateVTKObjects() to re-create the VTK objects. 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...
 
vtkClientServerInterpreterGetInterpreter ()
 Provides access to the Interpreter. More...
 
vtkSIObjectGetSIObject (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 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)
 

Protected Member Functions

 vtkSIProxy ()
 
 ~vtkSIProxy ()
 
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 bool CreateVTKObjects ()
 Creates the VTK objects. 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...
 
vtkSIProxyGetSubSIProxy (unsigned int cc)
 API to iterate over subproxy helpers. More...
 
virtual bool ReadXMLAttributes (vtkPVXMLElement *element)
 Parses the XML to create property/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 * VTKClassName
 
char * XMLGroup
 
char * XMLName
 
char * XMLSubProxyName
 
char * PostPush
 
char * PostCreation
 
int NumberOfInputPorts
 
vtkSmartPointer< vtkObjectBase > VTKObject
 
bool ObjectsCreated
 
- Protected Attributes inherited from vtkSIObject
vtkWeakPointer< vtkClientServerInterpreterInterpreter
 
vtkWeakPointer< vtkPVSessionCoreSessionCore
 
vtkSMMessageLastPushedMessage
 
vtkTypeUInt32 GlobalID
 

Detailed Description

vtkSIProxy is the server-implementation for a vtkSMProxy that helps the vtkSMProxy with managing/updating VTK objects.

Definition at line 34 of file vtkSIProxy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkSIProxy.h.

Constructor & Destructor Documentation

◆ vtkSIProxy()

vtkSIProxy::vtkSIProxy ( )
protected

◆ ~vtkSIProxy()

vtkSIProxy::~vtkSIProxy ( )
protected

Member Function Documentation

◆ New()

static vtkSIProxy* vtkSIProxy::New ( )
static

◆ GetClassName()

virtual const char* vtkSIProxy::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ AboutToDelete()

virtual void vtkSIProxy::AboutToDelete ( )
virtual

This method is called before the deletion of the SIObject.

Basically this is used to remove all dependency with other SIObject so after a first pass on all SIObject with a AboutToDelete() we can simply delete the remaining SIObjects.

Reimplemented from vtkSIObject.

Reimplemented in vtkSIPVRepresentationProxy.

◆ Push()

virtual void vtkSIProxy::Push ( vtkSMMessage msg)
virtual

Push a new state to the underneath implementation.

Reimplemented from vtkSIObject.

◆ Pull()

virtual void vtkSIProxy::Pull ( vtkSMMessage msg)
virtual

Pull the current state of the underneath implementation.

Reimplemented from vtkSIObject.

Reimplemented in vtkSIDirectoryProxy.

◆ GetVTKObject()

vtkObjectBase* vtkSIProxy::GetVTKObject ( )

Returns access to the VTKObject pointer, if any.

Note this is a raw pointer to the local instance of the VTK object. Any changes you make directly using this object pointer will not be reflected on other processes.

◆ SetVTKObject()

void vtkSIProxy::SetVTKObject ( vtkObjectBase *  )

Returns access to the VTKObject pointer, if any.

Note this is a raw pointer to the local instance of the VTK object. Any changes you make directly using this object pointer will not be reflected on other processes.

◆ GetSIProperty()

vtkSIProperty* vtkSIProxy::GetSIProperty ( const char *  name)

Provides access to the property helper.

◆ GetVTKClassName()

virtual char* vtkSIProxy::GetVTKClassName ( )
virtual

Returns the VTKClassName.

◆ GetXMLName()

virtual char* vtkSIProxy::GetXMLName ( )
virtual

Assigned by the XML parser.

The name assigned in the XML configuration. Can be used to figure out the origin of the proxy.

◆ GetXMLGroup()

virtual char* vtkSIProxy::GetXMLGroup ( )
virtual

Assigned by the XML parser.

The group in the XML configuration that this proxy belongs to. Can be used to figure out the origin of the proxy.

◆ IsNullProxy()

bool vtkSIProxy::IsNullProxy ( )
inline

Return true if that Proxy is supposed to have NO vtk class, which means its a NullProxy.

Definition at line 104 of file vtkSIProxy.h.

◆ AddInput()

virtual void vtkSIProxy::AddInput ( int  input_port,
vtkAlgorithmOutput *  connection,
const char *  method 
)
virtual

These methods are called to add/remove input connections by vtkSIInputProperty.

This indirection makes it possible for subclasses to insert VTK-algorithms in the input pipeline.

Reimplemented in vtkSIWriterProxy.

◆ CleanInputs()

virtual void vtkSIProxy::CleanInputs ( const char *  method)
virtual

These methods are called to add/remove input connections by vtkSIInputProperty.

This indirection makes it possible for subclasses to insert VTK-algorithms in the input pipeline.

Reimplemented in vtkSIWriterProxy.

◆ UpdatePipelineInformation()

virtual void vtkSIProxy::UpdatePipelineInformation ( )
inlinevirtual

Triggers UpdateInformation() on vtkObject if possible.

Default implementation does pretty much nothing.

Reimplemented in vtkSISourceProxy.

Definition at line 120 of file vtkSIProxy.h.

◆ RecreateVTKObjects()

virtual void vtkSIProxy::RecreateVTKObjects ( )
virtual

Called by vtkSMProxy::RecreateVTKObjects() to re-create the VTK objects.

Reimplemented in vtkSISourceProxy.

◆ GetSubSIProxy() [1/2]

vtkSIProxy* vtkSIProxy::GetSubSIProxy ( const char *  name)
protected

Returns the subproxy helper for the subproxy with the given name, if any.

◆ GetNumberOfSubSIProxys()

unsigned int vtkSIProxy::GetNumberOfSubSIProxys ( )
protected

API to iterate over subproxy helpers.

◆ GetSubSIProxy() [2/2]

vtkSIProxy* vtkSIProxy::GetSubSIProxy ( unsigned int  cc)
protected

API to iterate over subproxy helpers.

◆ GetProxyDefinitionManager()

vtkSIProxyDefinitionManager* vtkSIProxy::GetProxyDefinitionManager ( )
protected

Provides access to the vtkSIProxyDefinitionManager held by the session.

◆ CreateVTKObjects()

virtual bool vtkSIProxy::CreateVTKObjects ( )
protectedvirtual

Creates the VTK objects.

This also parses the xml definition for proxy to create property-handlers. Returns true if object are (or have been) created successfully. message is used to obtain information about what proxy helper this is if the objects need to be created.

Reimplemented in vtkSISourceProxy, vtkSIImageTextureProxy, and vtkSIUnstructuredGridVolumeRepresentationProxy.

◆ DeleteVTKObjects()

void vtkSIProxy::DeleteVTKObjects ( )
protected

Called to delete VTK objects.

◆ OnCreateVTKObjects()

virtual void vtkSIProxy::OnCreateVTKObjects ( )
protectedvirtual

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 in vtkSIWriterProxy, and vtkSIMetaReaderProxy.

◆ InitializeAndCreateVTKObjects()

bool vtkSIProxy::InitializeAndCreateVTKObjects ( vtkSMMessage message)
protected

Called by vtkSIProxy::Push() to ensure that the vtkSIProxy has been initialized.

◆ ReadXMLAttributes()

virtual bool vtkSIProxy::ReadXMLAttributes ( vtkPVXMLElement element)
protectedvirtual

Parses the XML to create property/subproxy helpers.

Reimplemented in vtkSISourceProxy, vtkSIWriterProxy, vtkSICompoundSourceProxy, vtkSIMetaReaderProxy, and vtkSIPVRepresentationProxy.

◆ ReadXMLProperty()

virtual bool vtkSIProxy::ReadXMLProperty ( vtkPVXMLElement property_element)
protectedvirtual

Parses the XML to create property/subproxy helpers.

Reimplemented in vtkSIDirectoryProxy.

◆ ReadXMLSubProxy()

virtual bool vtkSIProxy::ReadXMLSubProxy ( vtkPVXMLElement subproxy_element)
protectedvirtual

Parses the XML to create property/subproxy helpers.

◆ AddSIProperty()

void vtkSIProxy::AddSIProperty ( const char *  name,
vtkSIProperty  
)
protected

Adds a vtkSMProperty's server-implementation.

◆ SetVTKClassName()

virtual void vtkSIProxy::SetVTKClassName ( const char *  )
protectedvirtual

◆ SetXMLGroup()

virtual void vtkSIProxy::SetXMLGroup ( const char *  )
protectedvirtual

◆ SetXMLName()

virtual void vtkSIProxy::SetXMLName ( const char *  )
protectedvirtual

◆ SetXMLSubProxyName()

virtual void vtkSIProxy::SetXMLSubProxyName ( const char *  )
protectedvirtual

◆ SetPostPush()

virtual void vtkSIProxy::SetPostPush ( const char *  )
protectedvirtual

◆ SetPostCreation()

virtual void vtkSIProxy::SetPostCreation ( const char *  )
protectedvirtual

Member Data Documentation

◆ VTKClassName

char* vtkSIProxy::VTKClassName
protected

Definition at line 196 of file vtkSIProxy.h.

◆ XMLGroup

char* vtkSIProxy::XMLGroup
protected

Definition at line 199 of file vtkSIProxy.h.

◆ XMLName

char* vtkSIProxy::XMLName
protected

Definition at line 200 of file vtkSIProxy.h.

◆ XMLSubProxyName

char* vtkSIProxy::XMLSubProxyName
protected

Definition at line 201 of file vtkSIProxy.h.

◆ PostPush

char* vtkSIProxy::PostPush
protected

Definition at line 202 of file vtkSIProxy.h.

◆ PostCreation

char* vtkSIProxy::PostCreation
protected

Definition at line 203 of file vtkSIProxy.h.

◆ NumberOfInputPorts

int vtkSIProxy::NumberOfInputPorts
protected

Definition at line 204 of file vtkSIProxy.h.

◆ VTKObject

vtkSmartPointer<vtkObjectBase> vtkSIProxy::VTKObject
protected

Definition at line 206 of file vtkSIProxy.h.

◆ ObjectsCreated

bool vtkSIProxy::ObjectsCreated
protected

Definition at line 207 of file vtkSIProxy.h.


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