used on properties that allow users to select arrays. More...

#include <vtkSMArraySelectionDomain.h>

Inheritance diagram for vtkSMArraySelectionDomain:

[legend]

Collaboration diagram for vtkSMArraySelectionDomain:

Public Types
typedef vtkSMStringListDomain	Superclass

Public Types inherited from vtkSMStringListDomain
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)

virtual int	SetDefaultValues (vtkSMProperty *, bool use_unchecked_values)
	Since this domain relies on an information only property to get the default status, we override this method to copy the values the info property as the default array selection. More...

Public Member Functions inherited from vtkSMStringListDomain
void	PrintSelf (ostream &os, vtkIndent indent)

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

int	IsInDomain (const char *string, unsigned int &idx)
	Returns true if the string is in the domain. More...

const char *	GetString (unsigned int idx)
	Returns a string in the domain. More...

unsigned int	GetNumberOfStrings ()
	Returns the number of strings in the domain. More...

virtual void	Update (vtkSMProperty *)
	Update self checking the "unchecked" values of all required properties. More...

virtual void	SetAnimationValue (vtkSMProperty *, int, double)
	Set the value of an element of a property from the animation editor. More...

Public Member Functions inherited from vtkSMDomain
void	PrintSelf (ostream &os, vtkIndent indent)

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 vtkSMArraySelectionDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMArraySelectionDomain *	SafeDownCast (vtkObject *o)

static void	SetLoadAllVariables (bool choice)
	Global flag to toggle between (a) the default behavior of setting default values according to infoProperty and (b) setting all default values to on. More...

static bool	GetLoadAllVariables ()

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

static int	IsTypeOf (const char *type)

static vtkSMStringListDomain *	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
	vtkSMArraySelectionDomain ()

	~vtkSMArraySelectionDomain ()

Protected Member Functions inherited from vtkSMStringListDomain
virtual int	ReadXMLAttributes (vtkSMProperty prop, vtkPVXMLElement element)
	Set the appropriate ivars from the xml element. 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	SetStrings (const std::vector< vtkStdString > &strings)
	Call to set the strings. More...

const std::vector< vtkStdString > &	GetStrings ()
	Call to set the strings. More...

	vtkSMStringListDomain ()
	A vtkSMProperty is often defined with a default value in the XML itself. More...

	~vtkSMStringListDomain ()
	A vtkSMProperty is often defined with a default value in the XML itself. 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	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 ()

Static Protected Attributes
static bool	LoadAllVariables

Additional Inherited Members
Protected Attributes inherited from vtkSMDomain
char *	XMLName

bool	IsOptional

vtkSMDomainInternals *	Internals

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session

Detailed Description

used on properties that allow users to select arrays.

vtkSMArraySelectionDomain is a domain that can be for used for properties that allow users to set selection-statuses for multiple arrays (or similar items). This is similar to vtkSMArrayListDomain, the only different is that vtkSMArrayListDomain is designed to work with data-information obtained from the required Input property, while vtkSMArraySelectionDomain depends on a required information-only property ("ArrayList") that provides the arrays available.

Supported Required-Property functions:

ArrayList : points a string-vector property that produces the (array_name, status) tuples. This is typically an information-only property.

Definition at line 39 of file vtkSMArraySelectionDomain.h.

Member Typedef Documentation

§ Superclass

typedef vtkSMStringListDomain vtkSMArraySelectionDomain::Superclass

Definition at line 43 of file vtkSMArraySelectionDomain.h.

Constructor & Destructor Documentation

§ vtkSMArraySelectionDomain()

vtkSMArraySelectionDomain::vtkSMArraySelectionDomain ( )

protected

§ ~vtkSMArraySelectionDomain()

vtkSMArraySelectionDomain::~vtkSMArraySelectionDomain ( )

protected

Member Function Documentation

§ New()

static vtkSMArraySelectionDomain* vtkSMArraySelectionDomain::New ( )

static

§ GetClassName()

virtual const char* vtkSMArraySelectionDomain::GetClassName ( )

virtual

Reimplemented from vtkSMStringListDomain.

Reimplemented in vtkSMSILDomain.

§ IsTypeOf()

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

static

§ IsA()

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

virtual

Reimplemented from vtkSMStringListDomain.

Reimplemented in vtkSMSILDomain.

§ SafeDownCast()

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

static

§ PrintSelf()

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

§ SetDefaultValues()

virtual int vtkSMArraySelectionDomain::SetDefaultValues	(	vtkSMProperty *	,
		bool	use_unchecked_values
	)

virtual

Since this domain relies on an information only property to get the default status, we override this method to copy the values the info property as the default array selection.

Reimplemented from vtkSMStringListDomain.

Reimplemented in vtkSMSILDomain.

§ SetLoadAllVariables()

static void vtkSMArraySelectionDomain::SetLoadAllVariables ( bool choice )

inlinestatic

Global flag to toggle between (a) the default behavior of setting default values according to infoProperty and (b) setting all default values to on.

Definition at line 57 of file vtkSMArraySelectionDomain.h.

§ GetLoadAllVariables()

static bool vtkSMArraySelectionDomain::GetLoadAllVariables ( )

inlinestatic

Definition at line 61 of file vtkSMArraySelectionDomain.h.

Member Data Documentation

§ LoadAllVariables

bool vtkSMArraySelectionDomain::LoadAllVariables

staticprotected

Definition at line 67 of file vtkSMArraySelectionDomain.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

§ Superclass

Constructor & Destructor Documentation

§ vtkSMArraySelectionDomain()

§ ~vtkSMArraySelectionDomain()

Member Function Documentation

§ New()

§ GetClassName()

§ IsTypeOf()

§ IsA()

§ SafeDownCast()

§ PrintSelf()

§ SetDefaultValues()

§ SetLoadAllVariables()

§ GetLoadAllVariables()

Member Data Documentation

§ LoadAllVariables