ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSMProxyInitializationHelper Class Referenceabstract

initialization helper for a proxy. More...

#include <vtkSMProxyInitializationHelper.h>

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

Public Types

typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void PostInitializeProxy (vtkSMProxy *proxy, vtkPVXMLElement *xml, unsigned long initializationTimeStamp)=0
 Called during vtkSMParaViewPipelineController::PostInitializeProxy() to initialize a proxy. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSMProxyInitializationHelperSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMProxyInitializationHelper ()
 
 ~vtkSMProxyInitializationHelper ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Detailed Description

initialization helper for a proxy.

vtkSMProxyInitializationHelper is used to add custom initialization logic to the initialization of a proxy done by vtkSMParaViewPipelineController. Developers can create new subclasses of vtkSMProxyInitializationHelper for specific proxy types. vtkSMProxyInitializationHelper will instantiate the helper and call PostInitializeProxy() in vtkSMParaViewPipelineController::PostInitializeProxy().

Helpers are added to a proxy in the XML configuration as follows:

<Proxy ...>
<Hints>
<InitializationHelper class="vtkMyCustomIntializationHelper" />
</Hints>
</Proxy>

Definition at line 44 of file vtkSMProxyInitializationHelper.h.

Member Typedef Documentation

§ Superclass

Definition at line 47 of file vtkSMProxyInitializationHelper.h.

Constructor & Destructor Documentation

§ vtkSMProxyInitializationHelper()

vtkSMProxyInitializationHelper::vtkSMProxyInitializationHelper ( )
protected

§ ~vtkSMProxyInitializationHelper()

vtkSMProxyInitializationHelper::~vtkSMProxyInitializationHelper ( )
protected

Member Function Documentation

§ GetClassName()

virtual const char* vtkSMProxyInitializationHelper::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMPLYWriterProxyInitializationHelper.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMObject.

Reimplemented in vtkSMPLYWriterProxyInitializationHelper.

§ SafeDownCast()

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

§ PrintSelf()

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

§ PostInitializeProxy()

virtual void vtkSMProxyInitializationHelper::PostInitializeProxy ( vtkSMProxy proxy,
vtkPVXMLElement xml,
unsigned long  initializationTimeStamp 
)
pure virtual

Called during vtkSMParaViewPipelineController::PostInitializeProxy() to initialize a proxy.

Parameters
proxy: the proxy being initialized.
xml: the XML configuration from this helper from this Hints for the proxy. This makes it possible to pass additional configuration parameters to the initialization helper.
initializationTimeStampthe timestamp for the proxy initialization. Generally, if a property on the proxy has MTime greater than initializationTimeStamp, the initializer should not modify the property since it was explicitly set by the user during initialization.

Implemented in vtkSMPLYWriterProxyInitializationHelper.


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