singleton/facade to vtkSMSessionProxyManager More...

#include <vtkSMProxyManager.h>

Inheritance diagram for vtkSMProxyManager:

Collaboration diagram for vtkSMProxyManager:

Classes
struct	LoadStateInformation
struct	ModifiedPropertyInformation
struct	RegisteredProxyInformation
struct	StateChangedInformation
Public Types
enum	eventId { ActiveSessionChanged = 9753 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkSMSession *	GetActiveSession ()
vtkSMSessionProxyManager *	GetActiveSessionProxyManager ()
vtkSMSessionProxyManager *	GetSessionProxyManager (vtkSMSession *session)

void	SetActiveSession (vtkSMSession *session)
void	SetActiveSession (vtkIdType sessionId)

vtkSMProxy *	NewProxy (const char groupName, const char proxyName, const char *subProxyName=NULL)
void	RegisterProxy (const char groupname, const char name, vtkSMProxy *proxy)
vtkSMProxy *	GetProxy (const char groupname, const char name)
void	UnRegisterProxy (const char groupname, const char name, vtkSMProxy *)
const char *	GetProxyName (const char *groupname, unsigned int idx)
const char *	GetProxyName (const char groupname, vtkSMProxy proxy)

void	SetGlobalPropertiesManager (const char name, vtkSMGlobalPropertiesManager )
void	RemoveGlobalPropertiesManager (const char *name)

unsigned int	GetNumberOfGlobalPropertiesManagers ()
vtkSMGlobalPropertiesManager *	GetGlobalPropertiesManager (unsigned int index)
vtkSMGlobalPropertiesManager *	GetGlobalPropertiesManager (const char *name)
const char *	GetGlobalPropertiesManagerName (vtkSMGlobalPropertiesManager *)

void	SetUndoStackBuilder (vtkSMUndoStackBuilder *builder)
virtual vtkSMUndoStackBuilder *	GetUndoStackBuilder ()

virtual vtkSMPluginManager *	GetPluginManager ()

virtual vtkSMReaderFactory *	GetReaderFactory ()

virtual vtkSMWriterFactory *	GetWriterFactory ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSMProxyManager *	SafeDownCast (vtkObject *o)
static vtkSMProxyManager *	GetProxyManager ()
static void	Finalize ()
static bool	IsInitialized ()
static int	GetVersionMajor ()
static int	GetVersionMinor ()
static int	GetVersionPatch ()
static const char *	GetParaViewSourceVersion ()
Protected Member Functions
	vtkSMProxyManager ()
	~vtkSMProxyManager ()
void	SaveGlobalPropertiesManagers (vtkPVXMLElement *root)
Static Protected Member Functions
static vtkSMProxyManager *	New ()
Protected Attributes
vtkSMUndoStackBuilder *	UndoStackBuilder
vtkSMPluginManager *	PluginManager
vtkSMReaderFactory *	ReaderFactory
vtkSMWriterFactory *	WriterFactory
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 44 of file vtkSMProxyManager.h.

Member Enumeration Documentation

enum vtkSMProxyManager::eventId

Enumerator:

ActiveSessionChanged

Definition at line 157 of file vtkSMProxyManager.h.

Constructor & Destructor Documentation

vtkSMProxyManager::vtkSMProxyManager ( ) [protected]

vtkSMProxyManager::~vtkSMProxyManager ( ) [protected]

Member Function Documentation

virtual const char* vtkSMProxyManager::GetClassName ( ) [virtual]

Reimplemented from vtkSMObject.

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

Reimplemented from vtkSMObject.

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

Reimplemented from vtkSMObject.

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

Reimplemented from vtkSMObject.

void vtkSMProxyManager::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkSMObject.

static vtkSMProxyManager* vtkSMProxyManager::GetProxyManager ( ) [static]

Provides access to the global ProxyManager.

static void vtkSMProxyManager::Finalize ( ) [static]

Free the singleton

static bool vtkSMProxyManager::IsInitialized ( ) [static]

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

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.

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.

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.

static const char* vtkSMProxyManager::GetParaViewSourceVersion ( ) [static]

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

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.

void vtkSMProxyManager::SetActiveSession ( vtkSMSession * session )

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

void vtkSMProxyManager::SetActiveSession ( vtkIdType sessionId )

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

vtkSMSessionProxyManager* vtkSMProxyManager::GetActiveSessionProxyManager ( )

Convenient method to get the active vtkSMSessionProxyManager. If no

vtkSMSessionProxyManager* vtkSMProxyManager::GetSessionProxyManager ( vtkSMSession * session )

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

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

Calls forwarded to the active vtkSMSessionProxyManager, if any. Raises errors if no active session manager can be determined (using GetActiveSessionProxyManager()).

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

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

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

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

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

void vtkSMProxyManager::SetGlobalPropertiesManager	(	const char *	name,
		vtkSMGlobalPropertiesManager *
	)

ParaView has notion of "global properties". These are application wide properties such as foreground color, text color etc. Changing values of these properties affects all objects that are linked to these properties. This class provides convenient API to setup/remove such links.

void vtkSMProxyManager::RemoveGlobalPropertiesManager ( const char * name )

ParaView has notion of "global properties". These are application wide properties such as foreground color, text color etc. Changing values of these properties affects all objects that are linked to these properties. This class provides convenient API to setup/remove such links.

unsigned int vtkSMProxyManager::GetNumberOfGlobalPropertiesManagers ( )

Accessors for global properties managers.

vtkSMGlobalPropertiesManager* vtkSMProxyManager::GetGlobalPropertiesManager ( unsigned int index )

Accessors for global properties managers.

vtkSMGlobalPropertiesManager* vtkSMProxyManager::GetGlobalPropertiesManager ( const char * name )

Accessors for global properties managers.

const char* vtkSMProxyManager::GetGlobalPropertiesManagerName ( vtkSMGlobalPropertiesManager * )

Accessors for global properties managers.

void vtkSMProxyManager::SetUndoStackBuilder ( vtkSMUndoStackBuilder * builder )

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

virtual vtkSMUndoStackBuilder* vtkSMProxyManager::GetUndoStackBuilder ( ) [virtual]

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

virtual vtkSMPluginManager* vtkSMProxyManager::GetPluginManager ( ) [virtual]

PluginManager keeps track of plugins loaded on various sessions. This provides access to the application-wide plugin manager.

virtual vtkSMReaderFactory* vtkSMProxyManager::GetReaderFactory ( ) [virtual]

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

virtual vtkSMWriterFactory* vtkSMProxyManager::GetWriterFactory ( ) [virtual]

Provides access to the writer factory. Before using the reader factory, it is essential that it's configured correctly.

static vtkSMProxyManager* vtkSMProxyManager::New ( ) [static, protected]

Reimplemented from vtkSMObject.

void vtkSMProxyManager::SaveGlobalPropertiesManagers ( vtkPVXMLElement * root ) [protected]

Save global property managers.

Friends And Related Function Documentation

friend class vtkSMSessionProxyManager [friend]

Definition at line 204 of file vtkSMProxyManager.h.

Member Data Documentation

vtkSMUndoStackBuilder* vtkSMProxyManager::UndoStackBuilder [protected]

Definition at line 209 of file vtkSMProxyManager.h.

vtkSMPluginManager* vtkSMProxyManager::PluginManager [protected]

Definition at line 210 of file vtkSMProxyManager.h.

vtkSMReaderFactory* vtkSMProxyManager::ReaderFactory [protected]

Definition at line 211 of file vtkSMProxyManager.h.

vtkSMWriterFactory* vtkSMProxyManager::WriterFactory [protected]

Definition at line 212 of file vtkSMProxyManager.h.

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

dox/ParaViewCore/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 Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation