singleton/facade to vtkSMSessionProxyManager More...

#include <vtkSMProxyManager.h>

Inheritance diagram for vtkSMProxyManager:

Collaboration diagram for vtkSMProxyManager:

[legend]

Classes
struct	LoadStateInformation

struct	ModifiedPropertyInformation

struct	RegisteredProxyInformation

struct	StateChangedInformation

Public Types
enum	eventId { ActiveSessionChanged = 9753 }

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

vtkSMSession *	GetActiveSession ()
	Returns the current active session. More...

vtkSMSessionProxyManager *	GetActiveSessionProxyManager ()
	Convenient method to get the active vtkSMSessionProxyManager. More...

vtkSMSessionProxyManager *	GetSessionProxyManager (vtkSMSession *session)
	Return the corresponding vtkSMSessionProxyManager and if any, then create a new one. More...

virtual void	SetBlockProxyDefinitionUpdates (bool)

virtual bool	GetBlockProxyDefinitionUpdates ()

virtual void	BlockProxyDefinitionUpdatesOn ()

virtual void	BlockProxyDefinitionUpdatesOff ()

void	UpdateProxyDefinitions ()

std::string	GetUniqueProxyName (const char groupname, const char prefix, bool alwaysAppend=true)
	Given a group, returns a name not already used for proxies registered in the given group. More...


void	SetActiveSession (vtkSMSession *session)
	Set the active session. More...

void	SetActiveSession (vtkIdType sessionId)
	Set the active session. More...


vtkSMProxy *	NewProxy (const char groupName, const char proxyName, const char *subProxyName=nullptr)
	Calls forwarded to the active vtkSMSessionProxyManager, if any. More...

void	RegisterProxy (const char groupname, const char name, vtkSMProxy *proxy)
	Calls forwarded to the active vtkSMSessionProxyManager, if any. More...

vtkSMProxy *	GetProxy (const char groupname, const char name)
	Calls forwarded to the active vtkSMSessionProxyManager, if any. More...

void	UnRegisterProxy (const char groupname, const char name, vtkSMProxy *)
	Calls forwarded to the active vtkSMSessionProxyManager, if any. More...

const char *	GetProxyName (const char *groupname, unsigned int idx)
	Calls forwarded to the active vtkSMSessionProxyManager, if any. More...

const char *	GetProxyName (const char groupname, vtkSMProxy proxy)
	Calls forwarded to the active vtkSMSessionProxyManager, if any. More...


void	SetUndoStackBuilder (vtkSMUndoStackBuilder *builder)
	Get/Set the undo-stack builder if the application is using undo-redo mechanism to track changes. More...

virtual vtkSMUndoStackBuilder *	GetUndoStackBuilder ()
	Get/Set the undo-stack builder if the application is using undo-redo mechanism to track changes. More...


virtual vtkSMPluginManager *	GetPluginManager ()
	PluginManager keeps track of plugins loaded on various sessions. More...


virtual vtkSMReaderFactory *	GetReaderFactory ()
	Provides access to the reader factory. More...


virtual vtkSMWriterFactory *	GetWriterFactory ()
	Provides access to the writer factory. 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 vtkSMProxyManager *	SafeDownCast (vtkObject *o)

static vtkSMProxyManager *	GetProxyManager ()
	Provides access to the global ProxyManager. More...

static void	Finalize ()
	Free the singleton. More...

static bool	IsInitialized ()
	Allow to check if the Singleton has been initialized and has a reference to a valid ProxyManager. More...

static int	GetVersionMajor ()
	These methods can be used to obtain the ProxyManager version number. More...

static int	GetVersionMinor ()
	These methods can be used to obtain the ProxyManager version number. More...

static int	GetVersionPatch ()
	These methods can be used to obtain the ProxyManager version number. More...

static const char *	GetParaViewSourceVersion ()
	Returns a string with the format "paraview version x.x.x, Date: YYYY-MM-DD". More...

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: 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
	vtkSMProxyManager ()

	~vtkSMProxyManager () override

void	ConnectionsUpdated (vtkObject , unsigned long, void )
	Connections updated. More...

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () 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 &)

Static Protected Member Functions
static vtkSMProxyManager *	New ()

Protected Attributes
vtkSMUndoStackBuilder *	UndoStackBuilder

vtkSMPluginManager *	PluginManager

vtkSMReaderFactory *	ReaderFactory

vtkSMWriterFactory *	WriterFactory

bool	BlockProxyDefinitionUpdates

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkSMSessionProxyManager

Detailed Description

singleton/facade to vtkSMSessionProxyManager

vtkSMProxyManager is a singleton/facade that creates and manages proxies. It maintains a map of vtkSMSessionProxyManager and delegate all proxy related call to the appropriate one based on the provided session.

See also: vtkSMSessionProxyManager, vtkSMProxyDefinitionManager

Definition at line 35 of file vtkSMProxyManager.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMProxyManager::Superclass

Definition at line 38 of file vtkSMProxyManager.h.

Member Enumeration Documentation

◆ eventId

enum vtkSMProxyManager::eventId

Enumerator
ActiveSessionChanged

Definition at line 164 of file vtkSMProxyManager.h.

Constructor & Destructor Documentation

◆ vtkSMProxyManager()

vtkSMProxyManager::vtkSMProxyManager ( )

protected

◆ ~vtkSMProxyManager()

vtkSMProxyManager::~vtkSMProxyManager ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkSMProxyManager::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMObject.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

◆ GetProxyManager()

static vtkSMProxyManager* vtkSMProxyManager::GetProxyManager ( )

static

Provides access to the global ProxyManager.

◆ Finalize()

static void vtkSMProxyManager::Finalize ( )

static

Free the singleton.

◆ IsInitialized()

static bool vtkSMProxyManager::IsInitialized ( )

static

Allow to check if the Singleton has been initialized and has a reference to a valid ProxyManager.

◆ GetVersionMajor()

static int vtkSMProxyManager::GetVersionMajor ( )

static

These methods can be used to obtain the ProxyManager version number.

Returns the major version number eg. if version is 2.9.1 this method will return 2.

◆ GetVersionMinor()

static int vtkSMProxyManager::GetVersionMinor ( )

static

These methods can be used to obtain the ProxyManager version number.

Returns the minor version number eg. if version is 2.9.1 this method will return 9.

◆ GetVersionPatch()

static int vtkSMProxyManager::GetVersionPatch ( )

static

These methods can be used to obtain the ProxyManager version number.

Returns the patch version number eg. if version is 2.9.1 this method will return 1.

◆ GetParaViewSourceVersion()

static const char* vtkSMProxyManager::GetParaViewSourceVersion ( )

static

Returns a string with the format "paraview version x.x.x, Date: YYYY-MM-DD".

◆ GetActiveSession()

vtkSMSession* vtkSMProxyManager::GetActiveSession ( )

Returns the current active session.

If no active session is set, and there's only one registered vtkSMSession with vtkProcessModule, then that session is automatically treated as the active session.

◆ SetActiveSession() [1/2]

void vtkSMProxyManager::SetActiveSession ( vtkSMSession * session )

Set the active session.

It's acceptable to set the active session as nullptr (or 0 in case of sessionId), however GetActiveSession() may automatically pick an active session if none is provided.

◆ SetActiveSession() [2/2]

void vtkSMProxyManager::SetActiveSession ( vtkIdType sessionId )

Set the active session.

It's acceptable to set the active session as nullptr (or 0 in case of sessionId), however GetActiveSession() may automatically pick an active session if none is provided.

◆ GetActiveSessionProxyManager()

vtkSMSessionProxyManager* vtkSMProxyManager::GetActiveSessionProxyManager ( )

Convenient method to get the active vtkSMSessionProxyManager.

If no

◆ GetSessionProxyManager()

vtkSMSessionProxyManager* vtkSMProxyManager::GetSessionProxyManager ( vtkSMSession * session )

Return the corresponding vtkSMSessionProxyManager and if any, then create a new one.

◆ NewProxy()

vtkSMProxy* vtkSMProxyManager::NewProxy	(	const char *	groupName,
		const char *	proxyName,
		const char *	subProxyName = `nullptr`
	)

Calls forwarded to the active vtkSMSessionProxyManager, if any.

Raises errors if no active session manager can be determined (using GetActiveSessionProxyManager()).

◆ RegisterProxy()

void vtkSMProxyManager::RegisterProxy	(	const char *	groupname,
		const char *	name,
		vtkSMProxy *	proxy
	)

Calls forwarded to the active vtkSMSessionProxyManager, if any.

Raises errors if no active session manager can be determined (using GetActiveSessionProxyManager()).

◆ GetProxy()

vtkSMProxy* vtkSMProxyManager::GetProxy	(	const char *	groupname,
		const char *	name
	)

Calls forwarded to the active vtkSMSessionProxyManager, if any.

Raises errors if no active session manager can be determined (using GetActiveSessionProxyManager()).

◆ UnRegisterProxy()

void vtkSMProxyManager::UnRegisterProxy	(	const char *	groupname,
		const char *	name,
		vtkSMProxy *
	)

Calls forwarded to the active vtkSMSessionProxyManager, if any.

Raises errors if no active session manager can be determined (using GetActiveSessionProxyManager()).

◆ GetProxyName() [1/2]

const char* vtkSMProxyManager::GetProxyName	(	const char *	groupname,
		unsigned int	idx
	)

Calls forwarded to the active vtkSMSessionProxyManager, if any.

Raises errors if no active session manager can be determined (using GetActiveSessionProxyManager()).

◆ GetProxyName() [2/2]

const char* vtkSMProxyManager::GetProxyName	(	const char *	groupname,
		vtkSMProxy *	proxy
	)

Calls forwarded to the active vtkSMSessionProxyManager, if any.

Raises errors if no active session manager can be determined (using GetActiveSessionProxyManager()).

◆ SetBlockProxyDefinitionUpdates()

virtual void vtkSMProxyManager::SetBlockProxyDefinitionUpdates ( bool )

virtual

◆ GetBlockProxyDefinitionUpdates()

virtual bool vtkSMProxyManager::GetBlockProxyDefinitionUpdates ( )

virtual

◆ BlockProxyDefinitionUpdatesOn()

virtual void vtkSMProxyManager::BlockProxyDefinitionUpdatesOn ( )

virtual

◆ BlockProxyDefinitionUpdatesOff()

virtual void vtkSMProxyManager::BlockProxyDefinitionUpdatesOff ( )

virtual

◆ UpdateProxyDefinitions()

void vtkSMProxyManager::UpdateProxyDefinitions ( )

◆ SetUndoStackBuilder()

void vtkSMProxyManager::SetUndoStackBuilder ( vtkSMUndoStackBuilder * builder )

Get/Set the undo-stack builder if the application is using undo-redo mechanism to track changes.

◆ GetUndoStackBuilder()

virtual vtkSMUndoStackBuilder* vtkSMProxyManager::GetUndoStackBuilder ( )

virtual

Get/Set the undo-stack builder if the application is using undo-redo mechanism to track changes.

◆ GetPluginManager()

virtual vtkSMPluginManager* vtkSMProxyManager::GetPluginManager ( )

virtual

PluginManager keeps track of plugins loaded on various sessions.

This provides access to the application-wide plugin manager.

◆ GetReaderFactory()

virtual vtkSMReaderFactory* vtkSMProxyManager::GetReaderFactory ( )

virtual

Provides access to the reader factory.

Before using the reader factory, it is essential that it's configured correctly.

◆ GetWriterFactory()

virtual vtkSMWriterFactory* vtkSMProxyManager::GetWriterFactory ( )

virtual

Provides access to the writer factory.

Before using the reader factory, it is essential that it's configured correctly.

◆ GetUniqueProxyName()

std::string vtkSMProxyManager::GetUniqueProxyName	(	const char *	groupname,
		const char *	prefix,
		bool	alwaysAppend = `true`
	)

Given a group, returns a name not already used for proxies registered in the given group.

The prefix is used to come up with a new name. if alwaysAppend is true, then a suffix will always be appended, if not, the prefix may be used directly if possible. If there are multiple vtkSMSessionProxyManager instances in the application, this method tries to find a unique name across all of them.

◆ New()

static vtkSMProxyManager* vtkSMProxyManager::New ( )

staticprotected

◆ ConnectionsUpdated()

void vtkSMProxyManager::ConnectionsUpdated	(	vtkObject *	,
		unsigned	long,
		void *
	)

protected

Connections updated.

Update the active session accordingly.

Friends And Related Function Documentation

◆ vtkSMSessionProxyManager

friend class vtkSMSessionProxyManager

friend

Definition at line 222 of file vtkSMProxyManager.h.

Member Data Documentation

◆ UndoStackBuilder

vtkSMUndoStackBuilder* vtkSMProxyManager::UndoStackBuilder

protected

Definition at line 229 of file vtkSMProxyManager.h.

◆ PluginManager

vtkSMPluginManager* vtkSMProxyManager::PluginManager

protected

Definition at line 230 of file vtkSMProxyManager.h.

◆ ReaderFactory

vtkSMReaderFactory* vtkSMProxyManager::ReaderFactory

protected

Definition at line 231 of file vtkSMProxyManager.h.

◆ WriterFactory

vtkSMWriterFactory* vtkSMProxyManager::WriterFactory

protected

Definition at line 232 of file vtkSMProxyManager.h.

◆ BlockProxyDefinitionUpdates

bool vtkSMProxyManager::BlockProxyDefinitionUpdates

protected

Definition at line 234 of file vtkSMProxyManager.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMProxyManager.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ eventId

Constructor & Destructor Documentation

◆ vtkSMProxyManager()

◆ ~vtkSMProxyManager()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetProxyManager()

◆ Finalize()

◆ IsInitialized()

◆ GetVersionMajor()

◆ GetVersionMinor()

◆ GetVersionPatch()

◆ GetParaViewSourceVersion()

◆ GetActiveSession()

◆ SetActiveSession() [1/2]

◆ SetActiveSession() [2/2]

◆ GetActiveSessionProxyManager()

◆ GetSessionProxyManager()

◆ NewProxy()

◆ RegisterProxy()

◆ GetProxy()

◆ UnRegisterProxy()

◆ GetProxyName() [1/2]

◆ GetProxyName() [2/2]

◆ SetBlockProxyDefinitionUpdates()

◆ GetBlockProxyDefinitionUpdates()

◆ BlockProxyDefinitionUpdatesOn()

◆ BlockProxyDefinitionUpdatesOff()

◆ UpdateProxyDefinitions()

◆ SetUndoStackBuilder()

◆ GetUndoStackBuilder()

◆ GetPluginManager()

◆ GetReaderFactory()

◆ GetWriterFactory()

◆ GetUniqueProxyName()

◆ New()

◆ ConnectionsUpdated()

Friends And Related Function Documentation

◆ vtkSMSessionProxyManager

Member Data Documentation

◆ UndoStackBuilder

◆ PluginManager

◆ ReaderFactory

◆ WriterFactory

◆ BlockProxyDefinitionUpdates