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

vtkClientServerInterpreterInitializer initializes and maintains the global vtkClientServerInterpreter instance for the processes. More...

#include <vtkClientServerInterpreterInitializer.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 
typedef void(* InterpreterInitializationCallback) (vtkClientServerInterpreter *)
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkClientServerInterpreterNewInterpreter ()
 Creates (and registers) a new interpreter. More...
 
void RegisterCallback (InterpreterInitializationCallback callback)
 Use this method register an interpreter initializer function. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkClientServerInterpreterInitializerSafeDownCast (vtkObject *o)
 
static vtkClientServerInterpreterGetGlobalInterpreter ()
 Get the interpreter for this process. More...
 
static vtkClientServerInterpreterInitializerGetInitializer ()
 Provides access to the singleton. More...
 

Protected Member Functions

 vtkClientServerInterpreterInitializer ()
 
 ~vtkClientServerInterpreterInitializer ()
 
void RegisterInterpreter (vtkClientServerInterpreter *)
 Registers an interpreter. More...
 

Static Protected Member Functions

static vtkClientServerInterpreterInitializerNew ()
 

Detailed Description

vtkClientServerInterpreterInitializer initializes and maintains the global vtkClientServerInterpreter instance for the processes.

Use RegisterCallback() to register initialization routines for the interpreter. Use GetInterpreter() to access the interpreter.

This class was originally designed to support and maintain multiple interpreter instances. However ParaView no longer has need for that and hence that functionality is no longer made public.

Definition at line 36 of file vtkClientServerInterpreterInitializer.h.

Member Typedef Documentation

§ Superclass

Definition at line 39 of file vtkClientServerInterpreterInitializer.h.

§ InterpreterInitializationCallback

typedef void(* vtkClientServerInterpreterInitializer::InterpreterInitializationCallback) (vtkClientServerInterpreter *)

Definition at line 63 of file vtkClientServerInterpreterInitializer.h.

Constructor & Destructor Documentation

§ vtkClientServerInterpreterInitializer()

vtkClientServerInterpreterInitializer::vtkClientServerInterpreterInitializer ( )
protected

§ ~vtkClientServerInterpreterInitializer()

vtkClientServerInterpreterInitializer::~vtkClientServerInterpreterInitializer ( )
protected

Member Function Documentation

§ GetClassName()

virtual const char* vtkClientServerInterpreterInitializer::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ NewInterpreter()

vtkClientServerInterpreter* vtkClientServerInterpreterInitializer::NewInterpreter ( )

Creates (and registers) a new interpreter.

§ GetGlobalInterpreter()

static vtkClientServerInterpreter* vtkClientServerInterpreterInitializer::GetGlobalInterpreter ( )
static

Get the interpreter for this process.

Initializing a new interpreter is expensive. So filters that need to use interpreter temporarily to call methods on a vtkObject can simply use the global interpreter. As a rule, if you need to assign ID's to objects, then you're probably better off creating a new interpreter using NewInterpreter() and using it rather than the global interpreter.

§ GetInitializer()

static vtkClientServerInterpreterInitializer* vtkClientServerInterpreterInitializer::GetInitializer ( )
static

Provides access to the singleton.

This will instantiate vtkClientServerInterpreterInitializer the first time it is called.

§ RegisterCallback()

void vtkClientServerInterpreterInitializer::RegisterCallback ( InterpreterInitializationCallback  callback)

Use this method register an interpreter initializer function.

Registering such a callback makes it possible to initialize interpreters created in the lifetime of the application, including those that have already been created (but not destroyed). One cannot unregister a callback. The only reason for doing so would be un-loading a plugin, but that's not supported and never will be :).

§ New()

static vtkClientServerInterpreterInitializer* vtkClientServerInterpreterInitializer::New ( )
staticprotected

§ RegisterInterpreter()

void vtkClientServerInterpreterInitializer::RegisterInterpreter ( vtkClientServerInterpreter )
protected

Registers an interpreter.

This DOES NOT affect the reference count of the interpreter (hence there's no UnRegister).


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