union of proxies. More...
#include <vtkSMProxyListDomain.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| unsigned int | GetNumberOfProxyTypes () |
| const char * | GetProxyGroup (unsigned int index) |
| const char * | GetProxyName (unsigned int index) |
| virtual int | IsInDomain (vtkSMProperty *property) |
| void | AddProxy (vtkSMProxy *) |
| bool | HasProxy (vtkSMProxy *) |
| unsigned int | GetNumberOfProxies () |
| vtkSMProxy * | GetProxy (unsigned int index) |
| int | RemoveProxy (vtkSMProxy *proxy) |
| int | RemoveProxy (unsigned int index) |
Static Public Member Functions | |
| static vtkSMProxyListDomain * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkSMProxyListDomain * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) |
| void | AddProxy (const char *group, const char *name) |
| virtual void | ChildSaveState (vtkPVXMLElement *propertyElement) |
| virtual int | LoadState (vtkPVXMLElement *domainElement, vtkSMProxyLocator *loader) |
| virtual int | SetDefaultValues (vtkSMProperty *prop) |
| vtkSMProxyListDomain () | |
| ~vtkSMProxyListDomain () | |
Detailed Description
union of proxies.
This domain is a collection of proxies that can be assigned as the value to a vtkSMProxyProperty. The Server Mananger configuration defines the proxy types that form this list, while the value of this domain is the list of instances of proxies.
- See also:
- vtkSMDomain vtkSMProxyProperty
Definition at line 36 of file vtkSMProxyListDomain.h.
Constructor & Destructor Documentation
| vtkSMProxyListDomain::vtkSMProxyListDomain | ( | ) | [protected] |
A vtkSMProperty is often defined with a default value in the XML itself. However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property.
| vtkSMProxyListDomain::~vtkSMProxyListDomain | ( | ) | [protected] |
A vtkSMProperty is often defined with a default value in the XML itself. However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property.
Member Function Documentation
| static vtkSMProxyListDomain* vtkSMProxyListDomain::New | ( | ) | [static] |
Reimplemented from vtkSMSessionObject.
| virtual const char* vtkSMProxyListDomain::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMDomain.
| static int vtkSMProxyListDomain::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMDomain.
| virtual int vtkSMProxyListDomain::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMDomain.
| static vtkSMProxyListDomain* vtkSMProxyListDomain::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMDomain.
| void vtkSMProxyListDomain::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMDomain.
| unsigned int vtkSMProxyListDomain::GetNumberOfProxyTypes | ( | ) |
Returns the number of proxies in the domain.
| const char* vtkSMProxyListDomain::GetProxyGroup | ( | unsigned int | index | ) |
Returns the xml group name for the proxy at a given index.
| const char* vtkSMProxyListDomain::GetProxyName | ( | unsigned int | index | ) |
Returns the xml type name for the proxy at a given index.
| virtual int vtkSMProxyListDomain::IsInDomain | ( | vtkSMProperty * | property | ) | [virtual] |
This always returns true.
Implements vtkSMDomain.
| void vtkSMProxyListDomain::AddProxy | ( | vtkSMProxy * | ) |
Add a proxy to the domain.
| bool vtkSMProxyListDomain::HasProxy | ( | vtkSMProxy * | ) |
Returns if the proxy is present in the domain.
| unsigned int vtkSMProxyListDomain::GetNumberOfProxies | ( | ) |
Get number of proxies in the domain.
| vtkSMProxy* vtkSMProxyListDomain::GetProxy | ( | unsigned int | index | ) |
Get proxy at a given index.
| int vtkSMProxyListDomain::RemoveProxy | ( | vtkSMProxy * | proxy | ) |
Removes the first occurence of the proxy in the domain. Returns if the proxy was removed.
Removes the proxy at the given index. Returns if the proxy was removed.
| virtual int vtkSMProxyListDomain::SetDefaultValues | ( | vtkSMProperty * | prop | ) | [virtual] |
A vtkSMProperty is often defined with a default value in the XML itself. However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property.
Reimplemented from vtkSMDomain.
| int vtkSMProxyListDomain::ReadXMLAttributes | ( | vtkSMProperty * | prop, |
| vtkPVXMLElement * | element | ||
| ) | [protected, virtual] |
Set the appropriate ivars from the xml element. Should be overwritten by subclass if adding ivars.
Reimplemented from vtkSMDomain.
| void vtkSMProxyListDomain::AddProxy | ( | const char * | group, |
| const char * | name | ||
| ) | [protected] |
Adds a proxy type, used by ReadXMLAttributes().
| virtual void vtkSMProxyListDomain::ChildSaveState | ( | vtkPVXMLElement * | propertyElement | ) | [protected, virtual] |
Save state for this domain.
Reimplemented from vtkSMDomain.
| virtual int vtkSMProxyListDomain::LoadState | ( | vtkPVXMLElement * | domainElement, |
| vtkSMProxyLocator * | loader | ||
| ) | [protected, virtual] |
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMProxyListDomain.h
