union of proxy groups More...

#include <vtkSMProxyGroupDomain.h>

Inheritance diagram for vtkSMProxyGroupDomain:

Collaboration diagram for vtkSMProxyGroupDomain:

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)

void	AddGroup (const char *group)
	Add a group to the domain. More...

virtual int	IsInDomain (vtkSMProperty *property)
	Returns true if the value of the propery is in the domain. More...

int	IsInDomain (vtkSMProxy *proxy)
	Returns true if the proxy is in the domain. More...

unsigned int	GetNumberOfGroups ()
	Returns the number of groups. More...

const char *	GetGroup (unsigned int idx)
	Returns group with give id. More...

unsigned int	GetNumberOfProxies ()
	Returns the total number of proxies in the domain. More...

vtkSMProxy *	GetProxy (const char *name)
	Given a name, returns a proxy. More...

const char *	GetProxyName (unsigned int idx)
	Returns the name (in the group) of a proxy. More...

const char *	GetProxyName (vtkSMProxy *proxy)
	Returns the name (in the group) of a proxy. 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...

vtkSMProperty *	GetProperty ()
	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 vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual void	SetSession (vtkSMSession *)
	Get/Set the session on wihch this object exists. More...

virtual vtkSMSession *	GetSession ()
	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 vtkSMProxyGroupDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMProxyGroupDomain *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMDomain
static int	IsTypeOf (const char *type)

static vtkSMDomain *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkSMProxyGroupDomain ()

	~vtkSMProxyGroupDomain ()

virtual int	ReadXMLAttributes (vtkSMProperty prop, vtkPVXMLElement element)
	Set the appropriate ivars from the xml element. More...

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

vtkSMProperty *	GetRequiredProperty (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 vtkPVDataInformation *	GetInputDataInformation (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	ChildSaveState (vtkPVXMLElement *domainElement)
	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 ()

Protected Attributes
vtkSMProxyGroupDomainInternals *	PGInternals

Protected Attributes inherited from vtkSMDomain
char *	XMLName

bool	IsOptional

vtkSMDomainInternals *	Internals

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session

Detailed Description

union of proxy groups

The proxy group domain consists of all proxies in a list of groups. This domain is commonly used together with vtkSMProxyPropery Valid XML elements are:

* * <Group name=""> where name is the groupname used by the proxy
* manager to refer to a group of proxies.
*

// .SECTION See Also vtkSMDomain vtkSMProxyPropery

Definition at line 40 of file vtkSMProxyGroupDomain.h.

Member Typedef Documentation

§ Superclass

typedef vtkSMDomain vtkSMProxyGroupDomain::Superclass

Definition at line 44 of file vtkSMProxyGroupDomain.h.

Constructor & Destructor Documentation

§ vtkSMProxyGroupDomain()

vtkSMProxyGroupDomain::vtkSMProxyGroupDomain ( )

protected

§ ~vtkSMProxyGroupDomain()

vtkSMProxyGroupDomain::~vtkSMProxyGroupDomain ( )

protected

Member Function Documentation

§ New()

static vtkSMProxyGroupDomain* vtkSMProxyGroupDomain::New ( )

static

§ GetClassName()

virtual const char* vtkSMProxyGroupDomain::GetClassName ( )

virtual

Reimplemented from vtkSMDomain.

§ IsTypeOf()

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

static

§ IsA()

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

virtual

Reimplemented from vtkSMDomain.

§ SafeDownCast()

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

static

§ PrintSelf()

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

§ AddGroup()

void vtkSMProxyGroupDomain::AddGroup ( const char * group )

Add a group to the domain.

The domain is the union of all groups.

§ IsInDomain() [1/2]

virtual int vtkSMProxyGroupDomain::IsInDomain ( vtkSMProperty * property )

virtual

Returns true if the value of the propery is in the domain.

The propery has to be a vtkSMProxyPropery or a sub-class. All proxies pointed by the property have to be in the domain.

Implements vtkSMDomain.

§ IsInDomain() [2/2]

int vtkSMProxyGroupDomain::IsInDomain ( vtkSMProxy * proxy )

Returns true if the proxy is in the domain.

§ GetNumberOfGroups()

unsigned int vtkSMProxyGroupDomain::GetNumberOfGroups ( )

Returns the number of groups.

§ GetGroup()

const char* vtkSMProxyGroupDomain::GetGroup ( unsigned int idx )

Returns group with give id.

Does not perform bounds check.

§ GetNumberOfProxies()

unsigned int vtkSMProxyGroupDomain::GetNumberOfProxies ( )

Returns the total number of proxies in the domain.

§ GetProxy()

vtkSMProxy* vtkSMProxyGroupDomain::GetProxy ( const char * name )

Given a name, returns a proxy.

§ GetProxyName() [1/2]

const char* vtkSMProxyGroupDomain::GetProxyName ( unsigned int idx )

Returns the name (in the group) of a proxy.

§ GetProxyName() [2/2]

const char* vtkSMProxyGroupDomain::GetProxyName ( vtkSMProxy * proxy )

Returns the name (in the group) of a proxy.

§ ReadXMLAttributes()

virtual int vtkSMProxyGroupDomain::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.

Member Data Documentation

§ PGInternals

vtkSMProxyGroupDomainInternals* vtkSMProxyGroupDomain::PGInternals

protected

Definition at line 105 of file vtkSMProxyGroupDomain.h.

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

/builddir/build/BUILD/ParaView-v5.2.0/ParaViewCore/ServerManager/Core/vtkSMProxyGroupDomain.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

§ Superclass

Constructor & Destructor Documentation

§ vtkSMProxyGroupDomain()

§ ~vtkSMProxyGroupDomain()

Member Function Documentation

§ New()

§ GetClassName()

§ IsTypeOf()

§ IsA()

§ SafeDownCast()

§ PrintSelf()

§ AddGroup()

§ IsInDomain() [1/2]

§ IsInDomain() [2/2]

§ GetNumberOfGroups()

§ GetGroup()

§ GetNumberOfProxies()

§ GetProxy()

§ GetProxyName() [1/2]

§ GetProxyName() [2/2]

§ ReadXMLAttributes()

Member Data Documentation

§ PGInternals