|
ParaView
|
#include <vtkSMSessionProxyManager.h>


responsible for creating and managing proxies for a given session
vtkSMSessionProxyManager is an instance that creates and manages proxies for a given session/server. It maintains a map of XML elements (populated by the XML parser) from which it can create and initialize proxies and properties. Once a proxy is created, it can either be managed by the user code or the proxy manager. For latter, pass the control of the proxy to the manager with RegisterProxy() and unregister it. At destruction, proxy manager deletes all managed proxies.
vtkSMSessionProxyManager is designed to work with only one session. When the session on which is attach close, it has no meaning to live and should be deleted right away.
Definition at line 131 of file vtkSMSessionProxyManager.h.
| vtkSMSessionProxyManager::vtkSMSessionProxyManager | ( | vtkSMSession * | ) | [protected] |
| vtkSMSessionProxyManager::~vtkSMSessionProxyManager | ( | ) | [protected] |
| static vtkSMSessionProxyManager* vtkSMSessionProxyManager::New | ( | vtkSMSession * | session | ) | [static] |
vtkSMSessionProxyManager requires a session and cannot be created without one.
| virtual const char* vtkSMSessionProxyManager::GetClassName | ( | ) | [virtual] |
vtkSMSessionProxyManager requires a session and cannot be created without one.
Reimplemented from vtkSMSessionObject.
| static int vtkSMSessionProxyManager::IsTypeOf | ( | const char * | type | ) | [static] |
vtkSMSessionProxyManager requires a session and cannot be created without one.
Reimplemented from vtkSMSessionObject.
| virtual int vtkSMSessionProxyManager::IsA | ( | const char * | type | ) | [virtual] |
vtkSMSessionProxyManager requires a session and cannot be created without one.
Reimplemented from vtkSMSessionObject.
| static vtkSMSessionProxyManager* vtkSMSessionProxyManager::SafeDownCast | ( | vtkObject * | o | ) | [static] |
vtkSMSessionProxyManager requires a session and cannot be created without one.
Reimplemented from vtkSMSessionObject.
| void vtkSMSessionProxyManager::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
vtkSMSessionProxyManager requires a session and cannot be created without one.
Reimplemented from vtkSMSessionObject.
| static vtkTypeUInt32 vtkSMSessionProxyManager::GetReservedGlobalID | ( | ) | [static] |
Return the GlobalID that should be used to refer to the ProxyManager state
| vtkSMProxy* vtkSMSessionProxyManager::NewProxy | ( | const char * | groupName, |
| const char * | proxyName, | ||
| const char * | subProxyName = NULL |
||
| ) |
Given a group and proxy name, create and return a proxy instance. The user has to delete the proxy when done. NOTE: If this method is called from a scripting language, it may not be possible to delete the returned object with Delete. The VTK wrappers handle New and Delete specially and may not allow the deletion of object created through other methods. Use UnRegister instead.
| vtkSMDocumentation* vtkSMSessionProxyManager::GetProxyDocumentation | ( | const char * | groupName, |
| const char * | proxyName | ||
| ) |
Returns a vtkSMDocumentation object with the documentation for the proxy with given name and group name. Note that the name and group name are not those with the which the proxy is registered, but those with which the proxy is created i.e. the arguments used for NewProxy().
| vtkSMDocumentation* vtkSMSessionProxyManager::GetPropertyDocumentation | ( | const char * | groupName, |
| const char * | proxyName, | ||
| const char * | propertyName | ||
| ) |
Returns a vtkSMDocumentation object with the documentation for the given property of the proxy with given name and group name. Note that the name and group name are not those with the which the proxy is registered, but those with which the proxy is created i.e. the arguments used for NewProxy(). Also, the property name is the name of an exposed property.
| void vtkSMSessionProxyManager::RegisterProxy | ( | const char * | groupname, |
| const char * | name, | ||
| vtkSMProxy * | proxy | ||
| ) |
Used to pass the control of the proxy to the manager. The user code can then release its reference count and not care about what happens to the proxy. Managed proxies are deleted at destruction. NOTE: The name has to be unique (per group). If not, the existing proxy will be replaced (and unregistered). The proxy instances are grouped in collections (not necessarily the same as the group in the XML configuration file). These collections can be used to separate proxies based on their functionality. For example, implicit planes can be grouped together and the acceptable values of a proxy property can be restricted (using a domain) to this collection.
| vtkSMProxy* vtkSMSessionProxyManager::GetProxy | ( | const char * | groupname, |
| const char * | name | ||
| ) |
Given its name (and group) returns a proxy. If not a managed proxy, returns 0.
| vtkSMProxy* vtkSMSessionProxyManager::GetProxy | ( | const char * | name | ) |
Given its name (and group) returns a proxy. If not a managed proxy, returns 0.
| void vtkSMSessionProxyManager::GetProxies | ( | const char * | groupname, |
| const char * | name, | ||
| vtkCollection * | collection | ||
| ) |
Returns all proxies registered under the given group with the given name. The collection is cleared before the proxies are added to it.
| void vtkSMSessionProxyManager::GetProxies | ( | const char * | groupname, |
| vtkCollection * | collection | ||
| ) | [inline] |
Returns all proxies registered under the given group with the given name. The collection is cleared before the proxies are added to it.
Definition at line 203 of file vtkSMSessionProxyManager.h.
| vtkSMProxy* vtkSMSessionProxyManager::GetPrototypeProxy | ( | const char * | groupname, |
| const char * | name | ||
| ) |
Returns the prototype proxy for the given type. This method may create a new prototype proxy, is one does not already exist.
| unsigned int vtkSMSessionProxyManager::GetNumberOfProxies | ( | const char * | groupname | ) |
Returns the number of proxies in a group.
| const char* vtkSMSessionProxyManager::GetProxyName | ( | const char * | groupname, |
| unsigned int | idx | ||
| ) |
Given a group and an index, returns the name of a proxy. NOTE: This operation is slow.
| const char* vtkSMSessionProxyManager::GetProxyName | ( | const char * | groupname, |
| vtkSMProxy * | proxy | ||
| ) |
Given a group and a proxy, return it's name. The proxy may be registered as two different names under the same group, this only returns the first hit name, use GetProxyNames() to obtain the list of names for the proxy. NOTE: This operation is slow.
| void vtkSMSessionProxyManager::GetProxyNames | ( | const char * | groupname, |
| vtkSMProxy * | proxy, | ||
| vtkStringList * | names | ||
| ) |
Given a group and a proxy, return all its names. This clears the names list before populating it with the names for the proxy under the group. NOTE: This operation is slow.
| const char* vtkSMSessionProxyManager::IsProxyInGroup | ( | vtkSMProxy * | proxy, |
| const char * | groupname | ||
| ) |
Is the proxy is in the given group, return it's name, otherwise return null. NOTE: Any following call to proxy manager might make the returned pointer invalid.
| void vtkSMSessionProxyManager::UnRegisterProxy | ( | const char * | groupname, |
| const char * | name, | ||
| vtkSMProxy * | |||
| ) |
Given its name, unregisters a proxy and remove it from the list of managed proxies.
| void vtkSMSessionProxyManager::UnRegisterProxy | ( | const char * | name | ) |
Given its name, unregisters a proxy and remove it from the list of managed proxies.
| void vtkSMSessionProxyManager::UnRegisterProxy | ( | vtkSMProxy * | proxy | ) |
Given a proxy, unregisters it. This method unregisters the proxy from all the groups it has been registered in.
| void vtkSMSessionProxyManager::UnRegisterProxies | ( | ) |
Unregisters all managed proxies.
| void vtkSMSessionProxyManager::UpdateRegisteredProxies | ( | const char * | groupname, |
| int | modified_only = 1 |
||
| ) |
Calls UpdateVTKObjects() on all managed proxies. If modified_only flag is set, then UpdateVTKObjects will be called only those proxies that have any properties that were modifed i.e. not pushed to the VTK objects.
| void vtkSMSessionProxyManager::UpdateRegisteredProxies | ( | int | modified_only = 1 | ) |
Calls UpdateVTKObjects() on all managed proxies. If modified_only flag is set, then UpdateVTKObjects will be called only those proxies that have any properties that were modifed i.e. not pushed to the VTK objects.
| void vtkSMSessionProxyManager::UpdateRegisteredProxiesInOrder | ( | int | modified_only = 1 | ) |
Updates all registered proxies in order, respecting dependencies among each other. This is used after loading state or after instantiating a compound proxy. This uses the "UpdateInputProxies" flag which vtkSMProxy checks in UpdateVTKObjects() to call UpdateVTKObjects() on the input proxies as well if the flag is set.
| void vtkSMSessionProxyManager::UpdateProxyInOrder | ( | vtkSMProxy * | proxy | ) |
Updates all registered proxies in order, respecting dependencies among each other. This is used after loading state or after instantiating a compound proxy. This uses the "UpdateInputProxies" flag which vtkSMProxy checks in UpdateVTKObjects() to call UpdateVTKObjects() on the input proxies as well if the flag is set.
| int vtkSMSessionProxyManager::GetNumberOfLinks | ( | ) |
Get the number of registered links with the server manager.
| const char* vtkSMSessionProxyManager::GetLinkName | ( | int | index | ) |
Get the name of a link.
| void vtkSMSessionProxyManager::RegisterLink | ( | const char * | linkname, |
| vtkSMLink * | link | ||
| ) |
Register proxy/property links with the server manager. The linknames must be unique, if a link with the given name already exists, it will be replaced.
| void vtkSMSessionProxyManager::UnRegisterLink | ( | const char * | linkname | ) |
Unregister a proxy or property link previously registered with the given name.
| vtkSMLink* vtkSMSessionProxyManager::GetRegisteredLink | ( | const char * | linkname | ) |
Get the link registered with the given name. If no such link exists, returns NULL.
| void vtkSMSessionProxyManager::UnRegisterAllLinks | ( | ) |
Unregister all registered proxy/property links.
| void vtkSMSessionProxyManager::RegisterCustomProxyDefinition | ( | const char * | group, |
| const char * | name, | ||
| vtkPVXMLElement * | top | ||
| ) |
Register a custom proxy definition with the proxy manager. This can be a compound proxy definition (look at vtkSMCompoundSourceProxy.h) or a regular proxy definition. For all practical purposes, there's no difference between a proxy definition added using this method or by parsing a server manager configuration file.
| void vtkSMSessionProxyManager::UnRegisterCustomProxyDefinition | ( | const char * | group, |
| const char * | name | ||
| ) |
Given its name, unregisters a custom proxy definition. Note that this can only be used to remove definitions added using RegisterCustomProxyDefinition(), cannot be used to remove definitions loaded using vtkSMXMLParser.
| void vtkSMSessionProxyManager::UnRegisterCustomProxyDefinitions | ( | ) |
Unregisters all registered custom proxy definitions. Note that this can only be used to remove definitions added using RegisterCustomProxyDefinition(), cannot be used to remove definitions loaded using vtkSMXMLParser.
| vtkPVXMLElement* vtkSMSessionProxyManager::GetProxyDefinition | ( | const char * | group, |
| const char * | name | ||
| ) |
Returns a registered proxy definition.
| void vtkSMSessionProxyManager::LoadCustomProxyDefinitions | ( | const char * | filename | ) |
Load custom proxy definitions and register them.
| void vtkSMSessionProxyManager::LoadCustomProxyDefinitions | ( | vtkPVXMLElement * | root | ) |
Load custom proxy definitions and register them.
| void vtkSMSessionProxyManager::SaveCustomProxyDefinitions | ( | vtkPVXMLElement * | root | ) |
Save registered custom proxy definitions.
| void vtkSMSessionProxyManager::LoadXMLState | ( | const char * | filename, |
| vtkSMStateLoader * | loader = NULL |
||
| ) |
Loads the state of the server manager from XML. If loader is not specified, a vtkSMStateLoader instance is used.
| void vtkSMSessionProxyManager::LoadXMLState | ( | vtkPVXMLElement * | rootElement, |
| vtkSMStateLoader * | loader = NULL, |
||
| bool | keepOriginalIds = false |
||
| ) |
Loads the state of the server manager from XML. If loader is not specified, a vtkSMStateLoader instance is used.
| void vtkSMSessionProxyManager::SaveXMLState | ( | const char * | filename | ) |
Save the state of the server manager in XML format in a file. This saves the state of all proxies and properties.
| vtkPVXMLElement* vtkSMSessionProxyManager::SaveXMLState | ( | ) |
Saves the state of the server manager as XML, and returns the vtkPVXMLElement for the root of the state. Note this this method allocates a new vtkPVXMLElement object, it's the caller's responsibility to free it by calling Delete().
| void vtkSMSessionProxyManager::InstantiateGroupPrototypes | ( | const char * | groupName | ) |
Given a group name, create prototypes and store them in a instance group called groupName_prototypes. Prototypes have their ConnectionID set to the SelfConnection.
| void vtkSMSessionProxyManager::InstantiatePrototypes | ( | ) |
Creates protytpes for all known proxy types.
| bool vtkSMSessionProxyManager::HasDefinition | ( | const char * | groupName, |
| const char * | proxyName | ||
| ) |
Return true if the XML Definition was found by vtkSMProxyDefinitionManager
| int vtkSMSessionProxyManager::AreProxiesModified | ( | ) |
Get if there are any registered proxies that have their properties in a modified state.
| vtkPVXMLElement* vtkSMSessionProxyManager::GetProxyHints | ( | const char * | xmlgroup, |
| const char * | xmlname | ||
| ) |
The server manager configuration XML may define <Hints> element for a proxy/property. Hints are metadata associated with the proxy/property. The Server Manager does not (and should not) interpret the hints. Hints provide a mechanism to add GUI pertinant information to the server manager XML. Returns the XML element for the hints associated with this proxy/property, if any, otherwise returns NULL.
| vtkPVXMLElement* vtkSMSessionProxyManager::GetPropertyHints | ( | const char * | groupName, |
| const char * | proxyName, | ||
| const char * | propertyName | ||
| ) |
The server manager configuration XML may define <Hints> element for a proxy/property. Hints are metadata associated with the proxy/property. The Server Manager does not (and should not) interpret the hints. Hints provide a mechanism to add GUI pertinant information to the server manager XML. Returns the XML element for the hints associated with this proxy/property, if any, otherwise returns NULL.
| virtual int vtkSMSessionProxyManager::GetUpdateInputProxies | ( | ) | [virtual] |
Check if UpdateInputProxies flag is set. This is used after loading state or after instantiating a compound proxy. This uses the "UpdateInputProxies" flag which vtkSMProxy checks in UpdateVTKObjects() to call UpdateVTKObjects() on the input proxies as well if the flag is set.
| void vtkSMSessionProxyManager::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 vtkSMSessionProxyManager::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 vtkSMSessionProxyManager::GetNumberOfGlobalPropertiesManagers | ( | ) |
Accessors for global properties managers.
| vtkSMGlobalPropertiesManager* vtkSMSessionProxyManager::GetGlobalPropertiesManager | ( | unsigned int | index | ) |
Accessors for global properties managers.
| vtkSMGlobalPropertiesManager* vtkSMSessionProxyManager::GetGlobalPropertiesManager | ( | const char * | name | ) |
Accessors for global properties managers.
| const char* vtkSMSessionProxyManager::GetGlobalPropertiesManagerName | ( | vtkSMGlobalPropertiesManager * | ) |
Accessors for global properties managers.
| bool vtkSMSessionProxyManager::LoadConfigurationXML | ( | const char * | xmlcontents | ) |
Loads server-manager configuration xml.
| virtual vtkSMProxyDefinitionManager* vtkSMSessionProxyManager::GetProxyDefinitionManager | ( | ) | [virtual] |
Get the proxy definition manager. Proxy definition manager maintains all the information about proxy definitions.
| vtkSMProxySelectionModel* vtkSMSessionProxyManager::GetSelectionModel | ( | const char * | name | ) |
Get a registered selection model. Will return null if no such model is registered. This will forward the call to the ProxyManager singleton
| vtkIdType vtkSMSessionProxyManager::GetNumberOfSelectionModel | ( | ) |
Return the number of Selections models registered
| vtkSMProxySelectionModel* vtkSMSessionProxyManager::GetSelectionModelAt | ( | int | idx | ) |
Return the selection model present at the index idx.
| void vtkSMSessionProxyManager::RegisterSelectionModel | ( | const char * | name, |
| vtkSMProxySelectionModel * | |||
| ) |
Register/UnRegister a selection model. A selection model can be typically used by applications to keep track of active sources, filters, views etc. This will forward the call to the ProxyManager singleton
| void vtkSMSessionProxyManager::UnRegisterSelectionModel | ( | const char * | name | ) |
Register/UnRegister a selection model. A selection model can be typically used by applications to keep track of active sources, filters, views etc. This will forward the call to the ProxyManager singleton
| void vtkSMSessionProxyManager::UpdateFromRemote | ( | ) |
Method used to fetch the last state of the ProxyManager from the pvserver. This is used in the collaboration context when the user connect to a remote server and wants to update it state before doing anything.
| bool vtkSMSessionProxyManager::IsStateUpdateNotificationEnabled | ( | ) |
Those methods allow the user to make atomic change set in the notification collaboration in term of set of proxy registration. This allow us to prevent deletion on remote sites of proxies that will end up in the ProxyManager but have not been set into it yet.
| void vtkSMSessionProxyManager::DisableStateUpdateNotification | ( | ) |
Those methods allow the user to make atomic change set in the notification collaboration in term of set of proxy registration. This allow us to prevent deletion on remote sites of proxies that will end up in the ProxyManager but have not been set into it yet.
| void vtkSMSessionProxyManager::EnableStateUpdateNotification | ( | ) |
Those methods allow the user to make atomic change set in the notification collaboration in term of set of proxy registration. This allow us to prevent deletion on remote sites of proxies that will end up in the ProxyManager but have not been set into it yet.
| void vtkSMSessionProxyManager::TriggerStateUpdate | ( | ) |
Those methods allow the user to make atomic change set in the notification collaboration in term of set of proxy registration. This allow us to prevent deletion on remote sites of proxies that will end up in the ProxyManager but have not been set into it yet.
| virtual const vtkSMMessage* vtkSMSessionProxyManager::GetFullState | ( | ) | [virtual] |
This method return the full object state that can be used to create that object from scratch. This method will be used to fill the undo stack. If not overriden this will return NULL.
| virtual void vtkSMSessionProxyManager::LoadState | ( | const vtkSMMessage * | msg, |
| vtkSMProxyLocator * | locator | ||
| ) | [virtual] |
This method is used to initialise the ProxyManager to the given state
| vtkSMProxy* vtkSMSessionProxyManager::NewProxy | ( | vtkPVXMLElement * | element, |
| const char * | groupname, | ||
| const char * | proxyname, | ||
| const char * | subProxyName = NULL |
||
| ) | [protected] |
Given an XML element and group name create a proxy and all of it's properties.
| vtkPVXMLElement* vtkSMSessionProxyManager::GetProxyElement | ( | const char * | groupName, |
| const char * | proxyName, | ||
| const char * | subProxyName = NULL |
||
| ) | [protected] |
Given the proxy name and group name, returns the XML element for the proxy.
| virtual void vtkSMSessionProxyManager::ExecuteEvent | ( | vtkObject * | obj, |
| unsigned long | event, | ||
| void * | data | ||
| ) | [protected, virtual] |
Handles events.
| void vtkSMSessionProxyManager::RemovePrototype | ( | const char * | groupname, |
| const char * | proxyname | ||
| ) | [protected] |
Removes a prototype. Used internally to cleanup obsolete prototypes.
| void vtkSMSessionProxyManager::MarkProxyAsModified | ( | vtkSMProxy * | ) | [protected] |
Mark/UnMark a proxy as modified.
| void vtkSMSessionProxyManager::UnMarkProxyAsModified | ( | vtkSMProxy * | ) | [protected] |
Mark/UnMark a proxy as modified.
| void vtkSMSessionProxyManager::SaveRegisteredLinks | ( | vtkPVXMLElement * | root | ) | [protected] |
Save/Load registered link states.
| void vtkSMSessionProxyManager::SaveGlobalPropertiesManagers | ( | vtkPVXMLElement * | root | ) | [protected] |
Save global property managers.
| vtkPVXMLElement* vtkSMSessionProxyManager::AddInternalState | ( | vtkPVXMLElement * | parentElement | ) | [protected] |
Internal method to save server manager state in an XML and return the created vtkPVXMLElement for it. The caller has the responsibility of freeing the vtkPVXMLElement returned IF the parentElement is NULL.
| void vtkSMSessionProxyManager::CollectReferredProxies | ( | vtkSMProxyManagerProxySet & | setOfProxies, |
| vtkSMProxy * | proxy | ||
| ) | [protected] |
friend class vtkSMGlobalPropertiesManager [friend] |
Definition at line 462 of file vtkSMSessionProxyManager.h.
friend class vtkSMProxy [friend] |
Definition at line 463 of file vtkSMSessionProxyManager.h.
friend class vtkPVProxyDefinitionIterator [friend] |
Definition at line 464 of file vtkSMSessionProxyManager.h.
friend class vtkSMProxyIterator [friend] |
Definition at line 465 of file vtkSMSessionProxyManager.h.
friend class vtkSMProxyManagerObserver [friend] |
Definition at line 466 of file vtkSMSessionProxyManager.h.
int vtkSMSessionProxyManager::UpdateInputProxies [protected] |
Definition at line 510 of file vtkSMSessionProxyManager.h.
Definition at line 511 of file vtkSMSessionProxyManager.h.
Definition at line 512 of file vtkSMSessionProxyManager.h.
Definition at line 513 of file vtkSMSessionProxyManager.h.
bool vtkSMSessionProxyManager::StateUpdateNotification [protected] |
Definition at line 514 of file vtkSMSessionProxyManager.h.
1.7.5.1