vtkSMStringVectorProperty Class Reference

property representing a vector of strings More...

#include <vtkSMStringVectorProperty.h>

Inheritance diagram for vtkSMStringVectorProperty:

Collaboration diagram for vtkSMStringVectorProperty:

List of all members.

Public Types
enum	ElementTypes { INT, DOUBLE, STRING }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual unsigned int	GetNumberOfElements ()
virtual void	SetNumberOfElements (unsigned int num)
int	SetElement (unsigned int idx, const char *value)
int	SetElements (const char *values[], unsigned int count)
int	SetElements (vtkStringList *newvalue)
int	SetUncheckedElements (const char *values[], unsigned int count)
void	GetElements (vtkStringList *list)
const char *	GetElement (unsigned int idx)
unsigned int	GetElementIndex (const char *value, int &exists)
const char *	GetUncheckedElement (unsigned int idx)
void	SetUncheckedElement (unsigned int idx, const char *value)
virtual unsigned int	GetNumberOfUncheckedElements ()
virtual void	Copy (vtkSMProperty *src)
const char *	GetDefaultValue (int idx)
virtual void	ClearUncheckedElements ()
void	SetElementType (unsigned int idx, int type)
int	GetElementType (unsigned int idx)
void	GetUncheckedElements (vtkStringList *list)
int	SetUncheckedElements (vtkStringList *list)
Static Public Member Functions
static vtkSMStringVectorProperty *	New ()
static int	IsTypeOf (const char *type)
static vtkSMStringVectorProperty *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMStringVectorProperty ()
	~vtkSMStringVectorProperty ()
virtual void	SetNumberOfUncheckedElements (unsigned int num)
virtual int	ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element)
virtual void	WriteTo (vtkSMMessage *)
virtual void	ReadFrom (const vtkSMMessage *, int msg_offset, vtkSMProxyLocator *)
virtual void	SaveStateValues (vtkPVXMLElement *propElement)
virtual int	SetElementAsString (int idx, const char *value)

---

Detailed Description

property representing a vector of strings

vtkSMStringVectorProperty is a concrete sub-class of vtkSMVectorProperty representing a vector of strings. vtkSMStringVectorProperty can also be used to store double and int values as strings. The strings are converted to the appropriate type when they are being passed to the stream. This is generally used for calling methods that have mixed type arguments.

See also:

vtkSMVectorProperty vtkSMDoubleVectorProperty vtkSMIntVectorProperty

Definition at line 36 of file vtkSMStringVectorProperty.h.

---

Member Enumeration Documentation

enum vtkSMStringVectorProperty::ElementTypes

Enumerator:

INT
DOUBLE
STRING

Definition at line 109 of file vtkSMStringVectorProperty.h.

---

Constructor & Destructor Documentation

vtkSMStringVectorProperty::vtkSMStringVectorProperty

(

)

[protected]

vtkSMStringVectorProperty::~vtkSMStringVectorProperty

(

)

[protected]

---

Member Function Documentation

static vtkSMStringVectorProperty* vtkSMStringVectorProperty::New

(

)

[static]

Reimplemented from vtkSMProperty.

virtual const char* vtkSMStringVectorProperty::GetClassName

(

)

[virtual]

Reimplemented from vtkSMVectorProperty.

static int vtkSMStringVectorProperty::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMVectorProperty.

virtual int vtkSMStringVectorProperty::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMVectorProperty.

static vtkSMStringVectorProperty* vtkSMStringVectorProperty::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMVectorProperty.

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

Reimplemented from vtkSMVectorProperty.

virtual unsigned int vtkSMStringVectorProperty::GetNumberOfElements

(

)

[virtual]

Returns the size of the vector.

Implements vtkSMVectorProperty.

virtual void vtkSMStringVectorProperty::SetNumberOfElements

(

unsigned int

num

)

[virtual]

Sets the size of the vector. If num is larger than the current number of elements, this may cause reallocation and copying.

Implements vtkSMVectorProperty.

int vtkSMStringVectorProperty::SetElement	(	unsigned int	idx,
		const char *	value
	)

Set the value of 1 element. The vector is resized as necessary. Returns 0 if Set fails either because the property is read only or the value is not in all domains. Returns 1 otherwise.

int vtkSMStringVectorProperty::SetElements	(	const char *	values[],
		unsigned int	count
	)

Sets multiple elements. The size of the property is changed to match count.

int vtkSMStringVectorProperty::SetElements

(

vtkStringList *

newvalue

)

Sets multiple elements. The size of the property is changed to match count.

int vtkSMStringVectorProperty::SetUncheckedElements	(	const char *	values[],
		unsigned int	count
	)

Sets the values of all the unchecked elements.

void vtkSMStringVectorProperty::GetElements

(

vtkStringList *

list

)

Fills up the vtkStringList instance with the current value.

const char* vtkSMStringVectorProperty::GetElement

(

unsigned int

idx

)

Returns the value of 1 element.

unsigned int vtkSMStringVectorProperty::GetElementIndex	(	const char *	value,
		int &	exists
	)

Returns the index of an element with a particular value. exists is set to false if element does not exist.

void vtkSMStringVectorProperty::SetElementType	(	unsigned int	idx,
		int	type
	)

Set the cast type used when passing a value to the stream. For example, if the type is INT, the string is converted to an int (with atoi()) before being passed to stream. Note that representing scalar values as strings can result in loss of accuracy. Possible values are: INT, DOUBLE, STRING.

int vtkSMStringVectorProperty::GetElementType

(

unsigned int

idx

)

Set the cast type used when passing a value to the stream. For example, if the type is INT, the string is converted to an int (with atoi()) before being passed to stream. Note that representing scalar values as strings can result in loss of accuracy. Possible values are: INT, DOUBLE, STRING.

const char* vtkSMStringVectorProperty::GetUncheckedElement

(

unsigned int

idx

)

Returns the value of 1 unchecked element. These are used by domains. SetElement() first sets the value of 1 unchecked element and then calls IsInDomain and updates the value of the corresponding element only if IsInDomain passes.

void vtkSMStringVectorProperty::SetUncheckedElement	(	unsigned int	idx,
		const char *	value
	)

Set the value of 1 unchecked element. This can be used to check if a value is in all domains of the property. Call this and call IsInDomains().

void vtkSMStringVectorProperty::GetUncheckedElements

(

vtkStringList *

list

)

Get/Set unchecked elements.

int vtkSMStringVectorProperty::SetUncheckedElements

(

vtkStringList *

list

)

Get/Set unchecked elements.

virtual unsigned int vtkSMStringVectorProperty::GetNumberOfUncheckedElements

(

)

[virtual]

Returns the size of unchecked elements. Usually this is the same as the number of elements but can be different before a domain check is performed.

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMStringVectorProperty::Copy

(

vtkSMProperty *

src

)

[virtual]

Copy all property values.

Reimplemented from vtkSMVectorProperty.

const char* vtkSMStringVectorProperty::GetDefaultValue

(

int

idx

)

Returns the default value, if any, specified in the XML.

virtual void vtkSMStringVectorProperty::ClearUncheckedElements

(

)

[virtual]

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMStringVectorProperty::SetNumberOfUncheckedElements

(

unsigned int

num

)

[protected, virtual]

Sets the size of unchecked elements. Usually this is the same as the number of elements but can be different before a domain check is performed.

Reimplemented from vtkSMVectorProperty.

virtual int vtkSMStringVectorProperty::ReadXMLAttributes	(	vtkSMProxy *	parent,
		vtkPVXMLElement *	element
	)		[protected, virtual]

Manage additional attribute from the XML -default_values_delimiter: char used to split the "default_values" into a vector. -element_types: StringVectorProperty may be used to store non homogeneous vector, therefore we store for each element its type. [INT, DOUBLE, STRING]

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMStringVectorProperty::WriteTo

(

vtkSMMessage *

)

[protected, virtual]

Let the property write its content into the stream

Reimplemented from vtkSMProperty.

virtual void vtkSMStringVectorProperty::ReadFrom	(	const vtkSMMessage *	,
		int	msg_offset,
		vtkSMProxyLocator *
	)		[protected, virtual]

Let the property read and set its content from the stream

virtual void vtkSMStringVectorProperty::SaveStateValues

(

vtkPVXMLElement *

propertyElement

)

[protected, virtual]

This method must be overiden by concrete class in order to save the real property data

Reimplemented from vtkSMProperty.

virtual int vtkSMStringVectorProperty::SetElementAsString	(	int	idx,
		const char *	value
	)		[protected, virtual]

Generic implementation that use SetElementAsString to push the value the property

Implements vtkSMVectorProperty.

---

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

• dox/ParaViewCore/ServerManager/vtkSMStringVectorProperty.h