ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkSMProxyListDomain Class Reference

union of proxies. More...

#include <vtkSMProxyListDomain.h>

Inheritance diagram for vtkSMProxyListDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMProxyListDomain:
Collaboration graph
[legend]

Public Types

typedef vtkSMDomain Superclass
 
- Public Types inherited from vtkSMDomain
typedef vtkSMSessionObject Superclass
 
- Public Types inherited from vtkSMSessionObject
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)
 
unsigned int GetNumberOfProxyTypes ()
 Returns the number of proxies in the domain. More...
 
const char * GetProxyGroup (unsigned int index)
 Returns the xml group name for the proxy at a given index. More...
 
const char * GetProxyName (unsigned int index)
 Returns the xml type name for the proxy at a given index. More...
 
const char * GetProxyName (vtkSMProxy *proxy)
 If the proxy is part of the domain, then this returns the name used for the proxy in the domain. More...
 
virtual int IsInDomain (vtkSMProperty *property)
 This always returns true. More...
 
void AddProxy (vtkSMProxy *)
 Add a proxy to the domain. More...
 
bool HasProxy (vtkSMProxy *)
 Returns if the proxy is present in the domain. More...
 
unsigned int GetNumberOfProxies ()
 Get number of proxies in the domain. More...
 
vtkSMProxyGetProxy (unsigned int index)
 Get proxy at a given index. More...
 
vtkSMProxyFindProxy (const char *xmlgroup, const char *xmlname)
 Find a proxy in the domain of the given group and type. More...
 
int RemoveProxy (vtkSMProxy *proxy)
 Removes the first occurence of the proxy in the domain. More...
 
int RemoveProxy (unsigned int index)
 Removes the proxy at the given index. More...
 
void CreateProxies (vtkSMSessionProxyManager *pxm)
 Creates and populates the domain with the proxy-types. More...
 
- Public Member Functions inherited from vtkSMDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Update (vtkSMProperty *requestingProperty)
 Update self based on the "unchecked" values of all required properties. More...
 
virtual void SetAnimationValue (vtkSMProperty *, int vtkNotUsed(index), double vtkNotUsed(value))
 Set the value of an element of a property from the animation editor. More...
 
virtual int SetDefaultValues (vtkSMProperty *, bool vtkNotUsed(use_unchecked_values))
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
vtkSMPropertyGetProperty ()
 Provides access to the vtkSMProperty on which this domain is hooked up. More...
 
virtual char * GetXMLName ()
 Assigned by the XML parser. More...
 
virtual bool GetIsOptional ()
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
- Public Member Functions inherited from vtkSMSessionObject
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual void SetSession (vtkSMSession *)
 Get/Set the session on wihch this object exists. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMProxyListDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMProxyListDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDomain
static int IsTypeOf (const char *type)
 
static vtkSMDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
 Set the appropriate ivars from the xml element. More...
 
void AddProxy (const char *group, const char *name)
 Adds a proxy type, used by ReadXMLAttributes(). More...
 
virtual void ChildSaveState (vtkPVXMLElement *propertyElement)
 Save state for this domain. More...
 
virtual int LoadState (vtkPVXMLElement *domainElement, vtkSMProxyLocator *loader)
 
void SetProxies (vtkSMProxy **proxies, unsigned int count)
 
- Protected Member Functions inherited from vtkSMDomain
 vtkSMDomain ()
 
 ~vtkSMDomain ()
 
virtual int LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader))
 Load the state of the domain from the XML. More...
 
vtkSMPropertyGetRequiredProperty (const char *function)
 Returns a given required property of the given function. More...
 
void RemoveRequiredProperty (vtkSMProperty *prop)
 Remove the given property from the required properties list. More...
 
void AddRequiredProperty (vtkSMProperty *prop, const char *function)
 Add a new required property to this domain. More...
 
virtual vtkPVDataInformationGetInputDataInformation (const char *function, int index=0)
 Helper method to get vtkPVDataInformation from input proxy connected to the required property with the given function. More...
 
void DomainModified ()
 Invokes DomainModifiedEvent. More...
 
void InvokeModified ()
 
unsigned int GetNumberOfRequiredProperties ()
 Gets the number of required properties added. More...
 
void SetProperty (vtkSMProperty *)
 Set the domain's property. More...
 
void SaveState (vtkPVXMLElement *parent, const char *uid)
 Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More...
 
virtual void SetIsOptional (bool)
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
virtual void SetXMLName (const char *)
 Assigned by the XML parser. More...
 
- Protected Member Functions inherited from vtkSMSessionObject
 vtkSMSessionObject ()
 
 ~vtkSMSessionObject ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Friends

class vtkSMProxyProperty
 
virtual int SetDefaultValues (vtkSMProperty *prop, bool use_unchecked_values)
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
 vtkSMProxyListDomain ()
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
 ~vtkSMProxyListDomain ()
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 

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. Example usage : <ProxyListDomain name="proxy_list"> <Proxy group="implicit_functions" name="Plane"> <Group name="implicit_functions"> </ProxyListDomain>

See also
vtkSMDomain vtkSMProxyProperty

Definition at line 46 of file vtkSMProxyListDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file vtkSMProxyListDomain.h.

Constructor & Destructor Documentation

◆ vtkSMProxyListDomain()

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::~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

◆ New()

static vtkSMProxyListDomain* vtkSMProxyListDomain::New ( )
static

◆ GetClassName()

virtual const char* vtkSMProxyListDomain::GetClassName ( )
virtual

Reimplemented from vtkSMDomain.

◆ IsTypeOf()

static int vtkSMProxyListDomain::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkSMProxyListDomain::IsA ( const char *  type)
virtual

Reimplemented from vtkSMDomain.

◆ SafeDownCast()

static vtkSMProxyListDomain* vtkSMProxyListDomain::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

void vtkSMProxyListDomain::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ GetNumberOfProxyTypes()

unsigned int vtkSMProxyListDomain::GetNumberOfProxyTypes ( )

Returns the number of proxies in the domain.

◆ GetProxyGroup()

const char* vtkSMProxyListDomain::GetProxyGroup ( unsigned int  index)

Returns the xml group name for the proxy at a given index.

◆ GetProxyName() [1/2]

const char* vtkSMProxyListDomain::GetProxyName ( unsigned int  index)

Returns the xml type name for the proxy at a given index.

◆ GetProxyName() [2/2]

const char* vtkSMProxyListDomain::GetProxyName ( vtkSMProxy proxy)

If the proxy is part of the domain, then this returns the name used for the proxy in the domain.

Returns NULL otherwise.

◆ IsInDomain()

virtual int vtkSMProxyListDomain::IsInDomain ( vtkSMProperty property)
virtual

This always returns true.

Implements vtkSMDomain.

◆ AddProxy() [1/2]

void vtkSMProxyListDomain::AddProxy ( vtkSMProxy )

Add a proxy to the domain.

◆ HasProxy()

bool vtkSMProxyListDomain::HasProxy ( vtkSMProxy )

Returns if the proxy is present in the domain.

◆ GetNumberOfProxies()

unsigned int vtkSMProxyListDomain::GetNumberOfProxies ( )

Get number of proxies in the domain.

◆ GetProxy()

vtkSMProxy* vtkSMProxyListDomain::GetProxy ( unsigned int  index)

Get proxy at a given index.

◆ FindProxy()

vtkSMProxy* vtkSMProxyListDomain::FindProxy ( const char *  xmlgroup,
const char *  xmlname 
)

Find a proxy in the domain of the given group and type.

◆ RemoveProxy() [1/2]

int vtkSMProxyListDomain::RemoveProxy ( vtkSMProxy proxy)

Removes the first occurence of the proxy in the domain.

Returns if the proxy was removed.

◆ RemoveProxy() [2/2]

int vtkSMProxyListDomain::RemoveProxy ( unsigned int  index)

Removes the proxy at the given index.

Returns if the proxy was removed.

◆ CreateProxies()

void vtkSMProxyListDomain::CreateProxies ( vtkSMSessionProxyManager pxm)

Creates and populates the domain with the proxy-types.

This will remove any existing proxies in the domain. Note that the newly created proxies won't be registered with the proxy manager.

◆ SetDefaultValues()

virtual int vtkSMProxyListDomain::SetDefaultValues ( vtkSMProperty prop,
bool  use_unchecked_values 
)
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.

◆ ReadXMLAttributes()

int vtkSMProxyListDomain::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement element 
)
protectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMDomain.

◆ AddProxy() [2/2]

void vtkSMProxyListDomain::AddProxy ( const char *  group,
const char *  name 
)
protected

Adds a proxy type, used by ReadXMLAttributes().

◆ ChildSaveState()

virtual void vtkSMProxyListDomain::ChildSaveState ( vtkPVXMLElement propertyElement)
protectedvirtual

Save state for this domain.

Reimplemented from vtkSMDomain.

◆ LoadState()

virtual int vtkSMProxyListDomain::LoadState ( vtkPVXMLElement domainElement,
vtkSMProxyLocator loader 
)
protectedvirtual

◆ SetProxies()

void vtkSMProxyListDomain::SetProxies ( vtkSMProxy **  proxies,
unsigned int  count 
)
protected

Friends And Related Function Documentation

◆ vtkSMProxyProperty

friend class vtkSMProxyProperty
friend

Definition at line 159 of file vtkSMProxyListDomain.h.


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