ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkSIProxy Class Reference

#include <vtkSIProxy.h>

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

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void AboutToDelete ()
virtual void Push (vtkSMMessage *msg)
vtkSIPropertyGetSIProperty (const char *name)
bool IsNullProxy ()
virtual void UpdatePipelineInformation ()
virtual void Pull (vtkSMMessage *msg)
vtkObjectBaseGetVTKObject ()
void SetVTKObject (vtkObjectBase *)
virtual char * GetVTKClassName ()
virtual void AddInput (int input_port, vtkAlgorithmOutput *connection, const char *method)
virtual void CleanInputs (const char *method)

Static Public Member Functions

static vtkSIProxyNew ()
static int IsTypeOf (const char *type)
static vtkSIProxySafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSIProxy ()
 ~vtkSIProxy ()
vtkSIProxyGetSubSIProxy (const char *name)
vtkSIProxyDefinitionManagerGetProxyDefinitionManager ()
virtual void OnCreateVTKObjects ()
void AddSIProperty (const char *name, vtkSIProperty *)
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 ()
vtkSIProxyGetSubSIProxy (unsigned int cc)
virtual bool CreateVTKObjects (vtkSMMessage *message)
void DeleteVTKObjects ()
virtual bool ReadXMLAttributes (vtkPVXMLElement *element)
virtual bool ReadXMLProperty (vtkPVXMLElement *property_element)
virtual bool ReadXMLSubProxy (vtkPVXMLElement *subproxy_element)

Protected Attributes

char * VTKClassName
char * XMLGroup
char * XMLName
char * XMLSubProxyName
char * PostPush
char * PostCreation
vtkSmartPointer< vtkObjectBaseVTKObject
bool ObjectsCreated

Detailed Description

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

Definition at line 32 of file vtkSIProxy.h.


Constructor & Destructor Documentation

vtkSIProxy::vtkSIProxy ( ) [protected]
vtkSIProxy::~vtkSIProxy ( ) [protected]

Member Function Documentation

static vtkSIProxy* vtkSIProxy::New ( ) [static]
virtual const char* vtkSIProxy::GetClassName ( ) [virtual]
static int vtkSIProxy::IsTypeOf ( const char *  type) [static]
virtual int vtkSIProxy::IsA ( const char *  type) [virtual]
static vtkSIProxy* vtkSIProxy::SafeDownCast ( vtkObject o) [static]
void vtkSIProxy::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]
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.

virtual void vtkSIProxy::Push ( vtkSMMessage msg) [virtual]

Push a new state to the underneath implementation

Reimplemented from vtkSIObject.

virtual void vtkSIProxy::Pull ( vtkSMMessage msg) [virtual]

Pull the current state of the underneath implementation

Reimplemented from vtkSIObject.

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.

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.

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

Provides access to the property helper.

virtual char* vtkSIProxy::GetVTKClassName ( ) [virtual]

Returns the VTKClassName.

bool vtkSIProxy::IsNullProxy ( ) [inline]

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

Definition at line 74 of file vtkSIProxy.h.

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.

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.

virtual void vtkSIProxy::UpdatePipelineInformation ( ) [inline, virtual]

Triggers UpdateInformation() on vtkObject if possible. Default implementation does pretty much nothing.

Reimplemented in vtkSISourceProxy.

Definition at line 87 of file vtkSIProxy.h.

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

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

unsigned int vtkSIProxy::GetNumberOfSubSIProxys ( ) [protected]

API to iterate over subproxy helpers.

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

API to iterate over subproxy helpers.

vtkSIProxyDefinitionManager* vtkSIProxy::GetProxyDefinitionManager ( ) [protected]

Provides access to the vtkSIProxyDefinitionManager held by the session.

virtual bool vtkSIProxy::CreateVTKObjects ( vtkSMMessage message) [protected, virtual]

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, vtkSIWriterProxy, vtkSIFileSeriesReaderProxy, vtkSIImageTextureProxy, vtkSITextSourceRepresentationProxy, vtkSIUniformGridVolumeRepresentationProxy, vtkSIAMRVolumeRepresentationProxy, vtkSIScalarBarActorProxy, and vtkSISelectionRepresentationProxy.

void vtkSIProxy::DeleteVTKObjects ( ) [protected]

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.

virtual void vtkSIProxy::OnCreateVTKObjects ( ) [protected, virtual]

Called in CreateVTKObjects() after the vtk-object has been created and subproxy-information has been processed, but before the XML is parsed to generate properties and initialize their values.

Reimplemented in vtkSIChartRepresentationProxy, and vtkSIUnstructuredGridVolumeRepresentationProxy.

virtual bool vtkSIProxy::ReadXMLAttributes ( vtkPVXMLElement element) [protected, virtual]

Parses the XML to create property/subproxy helpers.

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

virtual bool vtkSIProxy::ReadXMLProperty ( vtkPVXMLElement property_element) [protected, virtual]

Parses the XML to create property/subproxy helpers.

virtual bool vtkSIProxy::ReadXMLSubProxy ( vtkPVXMLElement subproxy_element) [protected, virtual]

Parses the XML to create property/subproxy helpers.

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

Adds a vtkSMProperty's server-implementation.

virtual void vtkSIProxy::SetVTKClassName ( const char *  ) [protected, virtual]
virtual void vtkSIProxy::SetXMLGroup ( const char *  ) [protected, virtual]
virtual void vtkSIProxy::SetXMLName ( const char *  ) [protected, virtual]
virtual void vtkSIProxy::SetXMLSubProxyName ( const char *  ) [protected, virtual]
virtual void vtkSIProxy::SetPostPush ( const char *  ) [protected, virtual]
virtual void vtkSIProxy::SetPostCreation ( const char *  ) [protected, virtual]

Member Data Documentation

char* vtkSIProxy::VTKClassName [protected]

Definition at line 138 of file vtkSIProxy.h.

char* vtkSIProxy::XMLGroup [protected]

Definition at line 141 of file vtkSIProxy.h.

char* vtkSIProxy::XMLName [protected]

Definition at line 142 of file vtkSIProxy.h.

char* vtkSIProxy::XMLSubProxyName [protected]

Definition at line 143 of file vtkSIProxy.h.

char* vtkSIProxy::PostPush [protected]

Definition at line 144 of file vtkSIProxy.h.

char* vtkSIProxy::PostCreation [protected]

Definition at line 145 of file vtkSIProxy.h.

Definition at line 147 of file vtkSIProxy.h.

bool vtkSIProxy::ObjectsCreated [protected]

Definition at line 148 of file vtkSIProxy.h.


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