ParaView
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
vtkSMProxyManager Class Reference

singleton/facade to vtkSMSessionProxyManager More...

#include <vtkSMProxyManager.h>

Inheritance diagram for vtkSMProxyManager:
Inheritance graph
[legend]
Collaboration diagram for vtkSMProxyManager:
Collaboration graph
[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)
 
vtkSMSessionGetActiveSession ()
 Returns the current active session. More...
 
vtkSMSessionProxyManagerGetActiveSessionProxyManager ()
 Convenient method to get the active vtkSMSessionProxyManager. More...
 
vtkSMSessionProxyManagerGetSessionProxyManager (vtkSMSession *session)
 Return the corresponding vtkSMSessionProxyManager and if any, then create a new one. More...
 
void SetActiveSession (vtkSMSession *session)
 Set the active session. More...
 
void SetActiveSession (vtkIdType sessionId)
 Set the active session. More...
 
vtkSMProxyNewProxy (const char *groupName, const char *proxyName, const char *subProxyName=NULL)
 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...
 
vtkSMProxyGetProxy (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 vtkSMUndoStackBuilderGetUndoStackBuilder ()
 Get/Set the undo-stack builder if the application is using undo-redo mechanism to track changes. More...
 
virtual vtkSMPluginManagerGetPluginManager ()
 PluginManager keeps track of plugins loaded on various sessions. More...
 
virtual vtkSMReaderFactoryGetReaderFactory ()
 Provides access to the reader factory. More...
 
virtual vtkSMWriterFactoryGetWriterFactory ()
 Provides access to the writer factory. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSMProxyManagerSafeDownCast (vtkObject *o)
 
static vtkSMProxyManagerGetProxyManager ()
 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 vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMProxyManager ()
 
 ~vtkSMProxyManager ()
 
void ConnectionsUpdated (vtkObject *, unsigned long, void *)
 Connections updated. More...
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Static Protected Member Functions

static vtkSMProxyManagerNew ()
 

Protected Attributes

vtkSMUndoStackBuilderUndoStackBuilder
 
vtkSMPluginManagerPluginManager
 
vtkSMReaderFactoryReaderFactory
 
vtkSMWriterFactoryWriterFactory
 

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 45 of file vtkSMProxyManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkSMProxyManager.h.

Member Enumeration Documentation

◆ eventId

Enumerator
ActiveSessionChanged 

Definition at line 169 of file vtkSMProxyManager.h.

Constructor & Destructor Documentation

◆ vtkSMProxyManager()

vtkSMProxyManager::vtkSMProxyManager ( )
protected

◆ ~vtkSMProxyManager()

vtkSMProxyManager::~vtkSMProxyManager ( )
protected

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 
)

◆ 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 NULL (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 NULL (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 = NULL 
)

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

◆ 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.

◆ 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 216 of file vtkSMProxyManager.h.

Member Data Documentation

◆ UndoStackBuilder

vtkSMUndoStackBuilder* vtkSMProxyManager::UndoStackBuilder
protected

Definition at line 223 of file vtkSMProxyManager.h.

◆ PluginManager

vtkSMPluginManager* vtkSMProxyManager::PluginManager
protected

Definition at line 224 of file vtkSMProxyManager.h.

◆ ReaderFactory

vtkSMReaderFactory* vtkSMProxyManager::ReaderFactory
protected

Definition at line 225 of file vtkSMProxyManager.h.

◆ WriterFactory

vtkSMWriterFactory* vtkSMProxyManager::WriterFactory
protected

Definition at line 226 of file vtkSMProxyManager.h.


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