vtkClientServerInterpreterInitializer Class Reference

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

#include <vtkClientServerInterpreterInitializer.h>

Inheritance diagram for vtkClientServerInterpreterInitializer:

Collaboration diagram for vtkClientServerInterpreterInitializer:

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) override
vtkClientServerInterpreter *	NewInterpreter ()
	Creates (and registers) a new interpreter. More...
void	RegisterCallback (InterpreterInitializationCallback callback)
	Use this method register an interpreter initializer function. 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)
vtkCommand *	GetCommand (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)
vtkCommand *	GetCommand (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 int	IsTypeOf (const char *type)
static vtkClientServerInterpreterInitializer *	SafeDownCast (vtkObject *o)
static vtkClientServerInterpreter *	GetGlobalInterpreter ()
	Get the interpreter for this process. More...
static vtkClientServerInterpreterInitializer *	GetInitializer ()
	Provides access to the singleton. More...
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
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 vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkClientServerInterpreterInitializer ()
	~vtkClientServerInterpreterInitializer () override
void	RegisterInterpreter (vtkClientServerInterpreter *)
	Registers an interpreter. More...
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 &)

Static Protected Member Functions
static vtkClientServerInterpreterInitializer *	New ()

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 24 of file vtkClientServerInterpreterInitializer.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkClientServerInterpreterInitializer::Superclass

Definition at line 27 of file vtkClientServerInterpreterInitializer.h.

InterpreterInitializationCallback

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

Definition at line 51 of file vtkClientServerInterpreterInitializer.h.

Constructor & Destructor Documentation

vtkClientServerInterpreterInitializer()

vtkClientServerInterpreterInitializer::vtkClientServerInterpreterInitializer ( )

protected

~vtkClientServerInterpreterInitializer()

vtkClientServerInterpreterInitializer::~vtkClientServerInterpreterInitializer ( )

overrideprotected

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

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

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:

• /builds/gitlab-kitware-sciviz-ci/Remoting/ClientServerStream/vtkClientServerInterpreterInitializer.h