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

 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 bool CreateVTKObjects ()
 Creates the VTK objects. More...
 
virtual 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 *)
 
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 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 ()
 
 ~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 * 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
 

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 ( )
overrideprotected

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 
)
overridevirtual

◆ AboutToDelete()

void vtkSIProxy::AboutToDelete ( )
overridevirtual

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()

void vtkSIProxy::Push ( vtkSMMessage msg)
overridevirtual

Push a new state to the underneath implementation.

Reimplemented from vtkSIObject.

Reimplemented in vtkSIPythonSourceProxy.

◆ Pull()

void vtkSIProxy::Pull ( vtkSMMessage msg)
overridevirtual

Pull the current state of the underneath implementation.

Reimplemented from vtkSIObject.

Reimplemented in vtkSIPythonSourceProxy.

◆ 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, and vtkSIPythonSourceProxy.

◆ ExtendDefinition()

virtual bool vtkSIProxy::ExtendDefinition ( const char *  xml)
virtual

Counter part to vtkSMSelfGeneratingSourceProxy::ExtendDefinition().

Called by that method to let the vtkSIProxy know about the extended definition.

◆ GetLogNameOrDefault()

const char* vtkSIProxy::GetLogNameOrDefault ( )

A helper that makes up an default name if none is provided.

◆ NewVTKObject()

virtual vtkObjectBase* vtkSIProxy::NewVTKObject ( const char *  className)
protectedvirtual

Create an instance of the class specified.

Default implementation uses this->Interpreter->NewInstance().

Reimplemented in vtkSIPythonSourceProxy.

◆ 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, and vtkSIUnstructuredGridVolumeRepresentationProxy.

◆ DeleteVTKObjects()

virtual void vtkSIProxy::DeleteVTKObjects ( )
protectedvirtual

Called to delete VTK objects.

Reimplemented in vtkSIPythonSourceProxy.

◆ 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 vtkSISourceProxy, vtkSIWriterProxy, vtkSIImageTextureProxy, 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

◆ GetLogName()

virtual char* vtkSIProxy::GetLogName ( )
protectedvirtual

◆ SetLogName()

void vtkSIProxy::SetLogName ( const char *  name)
protected

Member Data Documentation

◆ VTKClassName

char* vtkSIProxy::VTKClassName
protected

Definition at line 218 of file vtkSIProxy.h.

◆ XMLGroup

char* vtkSIProxy::XMLGroup
protected

Definition at line 219 of file vtkSIProxy.h.

◆ XMLName

char* vtkSIProxy::XMLName
protected

Definition at line 220 of file vtkSIProxy.h.

◆ XMLSubProxyName

char* vtkSIProxy::XMLSubProxyName
protected

Definition at line 221 of file vtkSIProxy.h.

◆ PostPush

char* vtkSIProxy::PostPush
protected

Definition at line 222 of file vtkSIProxy.h.

◆ PostCreation

char* vtkSIProxy::PostCreation
protected

Definition at line 223 of file vtkSIProxy.h.

◆ NumberOfInputPorts

int vtkSIProxy::NumberOfInputPorts
protected

Definition at line 224 of file vtkSIProxy.h.

◆ VTKObject

vtkSmartPointer<vtkObjectBase> vtkSIProxy::VTKObject
protected

Definition at line 226 of file vtkSIProxy.h.

◆ ObjectsCreated

bool vtkSIProxy::ObjectsCreated
protected

Definition at line 227 of file vtkSIProxy.h.


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