domain for string lists that also have ranges More...

#include <vtkSMStringListRangeDomain.h>

Inheritance diagram for vtkSMStringListRangeDomain:

Collaboration diagram for vtkSMStringListRangeDomain:

Public Types
enum	Modes { RANGE, BOOLEAN }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsInDomain (vtkSMProperty *property)
unsigned int	GetNumberOfStrings ()
const char *	GetString (unsigned int idx)
unsigned int	AddString (const char *string)
void	RemoveString (const char *string)
void	RemoveAllStrings ()
int	GetMinimum (unsigned int idx, int &exists)
int	GetMaximum (unsigned int idx, int &exists)
void	AddMinimum (unsigned int idx, int value)
void	RemoveMinimum (unsigned int idx)
void	RemoveAllMinima ()
void	AddMaximum (unsigned int idx, int value)
void	RemoveMaximum (unsigned int idx)
void	RemoveAllMaxima ()

virtual void	SetIntDomainMode (int)
virtual int	GetIntDomainMode ()

virtual void	SetAnimationValue (vtkSMProperty *property, int idx, double value)
Static Public Member Functions
static vtkSMStringListRangeDomain *	New ()
static int	IsTypeOf (const char *type)
static vtkSMStringListRangeDomain *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMStringListRangeDomain ()
	~vtkSMStringListRangeDomain ()
virtual int	ReadXMLAttributes (vtkSMProperty prop, vtkPVXMLElement element)
virtual void	ChildSaveState (vtkPVXMLElement *domainElement)
Protected Attributes
vtkSMIntRangeDomain *	IRDomain
vtkSMBooleanDomain *	BDomain
vtkSMStringListDomain *	SLDomain
int	IntDomainMode

Detailed Description

domain for string lists that also have ranges

vtkSMStringListRangeDomain restricts the values of string vectors (works only with vtkSMStringVectorProperty) to a list of strings and either a range or a boolean. This is used with string properties that have tuples of string and int type components. A good example is array selection, where the first entry is the name of the array (string) and the second one is whether it is selected or not (int, bool). Another example is xdmf parameters, where the first entry is the name of the property and the second one it's value (restricted to an int range)

See also:: vtkSMIntRangeDomain vtkSMBooleanDomain vtkSMStringListDomain

Definition at line 40 of file vtkSMStringListRangeDomain.h.

Member Enumeration Documentation

enum vtkSMStringListRangeDomain::Modes

Enumerator:

RANGE
BOOLEAN

Definition at line 52 of file vtkSMStringListRangeDomain.h.

Constructor & Destructor Documentation

vtkSMStringListRangeDomain::vtkSMStringListRangeDomain ( ) [protected]

vtkSMStringListRangeDomain::~vtkSMStringListRangeDomain ( ) [protected]

Member Function Documentation

static vtkSMStringListRangeDomain* vtkSMStringListRangeDomain::New ( ) [static]

Reimplemented from vtkSMSessionObject.

Reimplemented in vtkSMSILDomain, and vtkSMArraySelectionDomain.

virtual const char* vtkSMStringListRangeDomain::GetClassName ( ) [virtual]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMSILDomain, and vtkSMArraySelectionDomain.

static int vtkSMStringListRangeDomain::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMSILDomain, and vtkSMArraySelectionDomain.

virtual int vtkSMStringListRangeDomain::IsA ( const char * type ) [virtual]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMSILDomain, and vtkSMArraySelectionDomain.

static vtkSMStringListRangeDomain* vtkSMStringListRangeDomain::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMSILDomain, and vtkSMArraySelectionDomain.

void vtkSMStringListRangeDomain::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMSILDomain, and vtkSMArraySelectionDomain.

virtual int vtkSMStringListRangeDomain::IsInDomain ( vtkSMProperty * property ) [virtual]

True if every even element is in the list of strings and every add element is in the range (or boolean), false otherwise.

Implements vtkSMDomain.

virtual void vtkSMStringListRangeDomain::SetIntDomainMode ( int ) [virtual]

Set the domain for the integer value. Can be either RANGE or BOOLEAN

virtual int vtkSMStringListRangeDomain::GetIntDomainMode ( ) [virtual]

Set the domain for the integer value. Can be either RANGE or BOOLEAN

unsigned int vtkSMStringListRangeDomain::GetNumberOfStrings ( )

Returns the number of strings in the domain.

const char* vtkSMStringListRangeDomain::GetString ( unsigned int idx )

Returns a string in the domain. The pointer may become invalid once the domain has been modified.

unsigned int vtkSMStringListRangeDomain::AddString ( const char * string )

Adds a new string to the domain.

void vtkSMStringListRangeDomain::RemoveString ( const char * string )

Removes a string from the domain.

void vtkSMStringListRangeDomain::RemoveAllStrings ( )

Removes all strings from the domain.

int vtkSMStringListRangeDomain::GetMinimum	(	unsigned int	idx,
		int &	exists
	)

Return a min. value if it exists. If the min. exists exists is set to 1. Otherwise, it is set to 0. An unspecified min. is equivalent to -inf

int vtkSMStringListRangeDomain::GetMaximum	(	unsigned int	idx,
		int &	exists
	)

Return a max. value if it exists. If the min. exists exists is set to 1. Otherwise, it is set to 0. An unspecified max. is equivalent to inf

void vtkSMStringListRangeDomain::AddMinimum	(	unsigned int	idx,
		int	value
	)

Set a min. of a given index.

void vtkSMStringListRangeDomain::RemoveMinimum ( unsigned int idx )

Remove a min. of a given index. An unspecified min. is equivalent to -inf

void vtkSMStringListRangeDomain::RemoveAllMinima ( )

Clear all minimum values.

void vtkSMStringListRangeDomain::AddMaximum	(	unsigned int	idx,
		int	value
	)

Set a max. of a given index.

void vtkSMStringListRangeDomain::RemoveMaximum ( unsigned int idx )

Remove a max. of a given index. An unspecified min. is equivalent to inf

void vtkSMStringListRangeDomain::RemoveAllMaxima ( )

Clear all maximum values.

virtual void vtkSMStringListRangeDomain::SetAnimationValue	(	vtkSMProperty *	property,
		int	idx,
		double	value
	)		`[virtual]`

Set the value of an element of a property from the animation editor.

Reimplemented from vtkSMDomain.

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

Reimplemented in vtkSMSILDomain.

virtual void vtkSMStringListRangeDomain::ChildSaveState ( vtkPVXMLElement * domainElement ) [protected, virtual]

Reimplemented from vtkSMDomain.

Member Data Documentation

vtkSMIntRangeDomain* vtkSMStringListRangeDomain::IRDomain [protected]

Definition at line 127 of file vtkSMStringListRangeDomain.h.

vtkSMBooleanDomain* vtkSMStringListRangeDomain::BDomain [protected]

Definition at line 128 of file vtkSMStringListRangeDomain.h.

vtkSMStringListDomain* vtkSMStringListRangeDomain::SLDomain [protected]

Definition at line 129 of file vtkSMStringListRangeDomain.h.

int vtkSMStringListRangeDomain::IntDomainMode [protected]

Definition at line 131 of file vtkSMStringListRangeDomain.h.

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

dox/ParaViewCore/ServerManager/vtkSMStringListRangeDomain.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation