#include <vtkSMProxyDefinitionManager.h>
Detailed Description
vtkSMProxyDefinitionManager is a remote-object that represents the vtkSIProxyDefinitionManager instance on all the processes. ParaView clients should use API on this class to add/update xml definitions to ensure that the xmls are processed/updated correctly on all the processes.
Definition at line 34 of file vtkSMProxyDefinitionManager.h.
Member Enumeration Documentation
Definition at line 54 of file vtkSMProxyDefinitionManager.h.
| anonymous enum |
Definition at line 62 of file vtkSMProxyDefinitionManager.h.
Constructor & Destructor Documentation
| vtkSMProxyDefinitionManager::vtkSMProxyDefinitionManager | ( | ) | [protected] |
| vtkSMProxyDefinitionManager::~vtkSMProxyDefinitionManager | ( | ) | [protected] |
Member Function Documentation
| static vtkSMProxyDefinitionManager* vtkSMProxyDefinitionManager::New | ( | ) | [static] |
Reimplemented from vtkSMSessionObject.
| virtual const char* vtkSMProxyDefinitionManager::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMRemoteObject.
| static int vtkSMProxyDefinitionManager::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMRemoteObject.
| virtual int vtkSMProxyDefinitionManager::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMRemoteObject.
| static vtkSMProxyDefinitionManager* vtkSMProxyDefinitionManager::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMRemoteObject.
| void vtkSMProxyDefinitionManager::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMRemoteObject.
| void vtkSMProxyDefinitionManager::SynchronizeDefinitions | ( | ) |
Synchronizes the client-side definitions using the server-side definitions, if applicable. Call this method after any code that could result in changing of the XML definitions on the server e.g. loading of plugins.
| virtual void vtkSMProxyDefinitionManager::SetSession | ( | vtkSMSession * | ) | [virtual] |
Overridden call SynchronizeDefinitions() when the session changes. Also ensures that the internal references to vtkSIProxyDefinitionManager are updated correctly.
Reimplemented from vtkSMRemoteObject.
| vtkPVXMLElement* vtkSMProxyDefinitionManager::GetProxyDefinition | ( | const char * | group, |
| const char * | name, | ||
| bool | throwError | ||
| ) | [inline] |
Returns a registered proxy definition or return a NULL otherwise. Moreover, error can be throw if the definition was not found if the flag throwError is true.
Definition at line 77 of file vtkSMProxyDefinitionManager.h.
| vtkPVXMLElement* vtkSMProxyDefinitionManager::GetProxyDefinition | ( | const char * | group, |
| const char * | name | ||
| ) | [inline] |
Returns a registered proxy definition or return a NULL otherwise. Moreover, error can be throw if the definition was not found if the flag throwError is true.
Definition at line 84 of file vtkSMProxyDefinitionManager.h.
| vtkPVXMLElement* vtkSMProxyDefinitionManager::GetCollapsedProxyDefinition | ( | const char * | group, |
| const char * | name, | ||
| const char * | subProxyName, | ||
| bool | throwError | ||
| ) | [inline] |
Returns the same thing as GetProxyDefinition in a flatten manner. By flatten, we mean that the class hierarchy has been walked and merged into a single vtkPVXMLElement definition.
Definition at line 95 of file vtkSMProxyDefinitionManager.h.
| bool vtkSMProxyDefinitionManager::HasDefinition | ( | const char * | groupName, |
| const char * | proxyName | ||
| ) | [inline] |
Return true if the XML Definition was found
Definition at line 108 of file vtkSMProxyDefinitionManager.h.
| void vtkSMProxyDefinitionManager::SaveCustomProxyDefinitions | ( | vtkPVXMLElement * | root | ) | [inline] |
Save registered custom proxy definitions. The caller must release the reference to the returned vtkPVXMLElement.
Definition at line 118 of file vtkSMProxyDefinitionManager.h.
| vtkPVProxyDefinitionIterator* vtkSMProxyDefinitionManager::NewIterator | ( | ) | [inline] |
Return a NEW instance of vtkPVProxyDefinitionIterator configured to get through all the definition available for the requested scope. Possible scope defined as enum inside vtkSIProxyDefinitionManager: ALL_DEFINITIONS=0 / CORE_DEFINITIONS=1 / CUSTOM_DEFINITIONS=2 Some extra restriction can be set directly on the iterator itself by setting a set of GroupName...
Definition at line 134 of file vtkSMProxyDefinitionManager.h.
| vtkPVProxyDefinitionIterator* vtkSMProxyDefinitionManager::NewIterator | ( | int | scope | ) | [inline] |
Return a NEW instance of vtkPVProxyDefinitionIterator configured to get through all the definition available for the requested scope. Possible scope defined as enum inside vtkSIProxyDefinitionManager: ALL_DEFINITIONS=0 / CORE_DEFINITIONS=1 / CUSTOM_DEFINITIONS=2 Some extra restriction can be set directly on the iterator itself by setting a set of GroupName...
Definition at line 139 of file vtkSMProxyDefinitionManager.h.
| vtkPVProxyDefinitionIterator* vtkSMProxyDefinitionManager::NewSingleGroupIterator | ( | const char * | groupName | ) | [inline] |
Return a new configured iterator for traversing a set of proxy definition for only one GroupName. Possible scope defined as enum inside vtkSIProxyDefinitionManager: ALL_DEFINITIONS=0 / CORE_DEFINITIONS=1 / CUSTOM_DEFINITIONS=2
Definition at line 151 of file vtkSMProxyDefinitionManager.h.
| vtkPVProxyDefinitionIterator* vtkSMProxyDefinitionManager::NewSingleGroupIterator | ( | const char * | groupName, |
| int | scope | ||
| ) | [inline] |
Return a new configured iterator for traversing a set of proxy definition for only one GroupName. Possible scope defined as enum inside vtkSIProxyDefinitionManager: ALL_DEFINITIONS=0 / CORE_DEFINITIONS=1 / CUSTOM_DEFINITIONS=2
Definition at line 156 of file vtkSMProxyDefinitionManager.h.
| void vtkSMProxyDefinitionManager::AddCustomProxyDefinition | ( | const char * | group, |
| const char * | name, | ||
| vtkPVXMLElement * | top | ||
| ) |
Add/Remove/Clear custom proxy definitions.
| void vtkSMProxyDefinitionManager::RemoveCustomProxyDefinition | ( | const char * | group, |
| const char * | name | ||
| ) |
Add/Remove/Clear custom proxy definitions.
| void vtkSMProxyDefinitionManager::ClearCustomProxyDefinitions | ( | ) |
Add/Remove/Clear custom proxy definitions.
| void vtkSMProxyDefinitionManager::LoadCustomProxyDefinitions | ( | vtkPVXMLElement * | root | ) |
Load custom proxy definitions and register them.
| void vtkSMProxyDefinitionManager::LoadCustomProxyDefinitionsFromString | ( | const char * | xmlContent | ) |
Load custom proxy definitions and register them.
| bool vtkSMProxyDefinitionManager::LoadConfigurationXML | ( | vtkPVXMLElement * | root | ) |
Loads server-manager configuration xml.
| bool vtkSMProxyDefinitionManager::LoadConfigurationXMLFromString | ( | const char * | xmlContent | ) |
Loads server-manager configuration xml.
| virtual void vtkSMProxyDefinitionManager::LoadState | ( | const vtkSMMessage * | msg, |
| vtkSMProxyLocator * | locator | ||
| ) | [virtual] |
This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set. This allow to split the load process in 2 step to prevent invalid state when property refere to a sub-proxy that does not exist yet.
Reimplemented from vtkSMRemoteObject.
Member Data Documentation
Definition at line 202 of file vtkSMProxyDefinitionManager.h.
vtkWeakPointer<vtkSIProxyDefinitionManager> vtkSMProxyDefinitionManager::ProxyDefinitionManager [protected] |
Definition at line 203 of file vtkSMProxyDefinitionManager.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMProxyDefinitionManager.h
