vtkSMStringVectorProperty Class Reference

property representing a vector of strings More...

#include <vtkSMStringVectorProperty.h>

Inheritance diagram for vtkSMStringVectorProperty:

[legend]Collaboration diagram for vtkSMStringVectorProperty:

[legend]List of all members.

Public Types
enum	ElementTypes { INT, DOUBLE, STRING }
Public Member Functions
	vtkTypeRevisionMacro (vtkSMStringVectorProperty, vtkSMVectorProperty)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual unsigned int	GetNumberOfElements ()
virtual void	SetNumberOfElements (unsigned int num)
int	SetElement (unsigned int idx, const char *value)
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)
void	SetElementType (unsigned int idx, int type)
int	GetElementType (unsigned int idx)
Static Public Member Functions
vtkSMStringVectorProperty *	New ()
Protected Member Functions
	vtkSMStringVectorProperty ()
	~vtkSMStringVectorProperty ()
virtual void	SetNumberOfUncheckedElements (unsigned int num)
virtual int	ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element)
virtual void	SaveState (const char *name, ostream *file, vtkIndent indent)
virtual void	AppendCommandToStream (vtkSMProxy *, vtkClientServerStream *stream, vtkClientServerID objectId)
Protected Attributes
vtkSMStringVectorPropertyInternals *	Internals

---

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 37 of file vtkSMStringVectorProperty.h.

---

Member Enumeration Documentation

enum vtkSMStringVectorProperty::ElementTypes

Enumeration values: INT  DOUBLE  STRING  Definition at line 90 of file vtkSMStringVectorProperty.h.

---

Constructor & Destructor Documentation

vtkSMStringVectorProperty::vtkSMStringVectorProperty (   )  [protected]

vtkSMStringVectorProperty::~vtkSMStringVectorProperty (   )  [protected]

---

Member Function Documentation

vtkSMStringVectorProperty* vtkSMStringVectorProperty::New (   )  [static]

Reimplemented from vtkSMProperty.

vtkSMStringVectorProperty::vtkTypeRevisionMacro (  vtkSMStringVectorProperty  , vtkSMVectorProperty  )

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

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.

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

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.

virtual void vtkSMStringVectorProperty::Copy (  vtkSMProperty *  src  )  [virtual]

Copy all property values. 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.

virtual void vtkSMStringVectorProperty::AppendCommandToStream (  vtkSMProxy *  , vtkClientServerStream *  stream, vtkClientServerID  objectId )  [protected, virtual]

Update the vtk object (with the given id and on the given nodes) with the property values(s). Reimplemented from vtkSMProperty.

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

Set the appropriate ivars from the xml element. Reimplemented from vtkSMVectorProperty.

virtual void vtkSMStringVectorProperty::SaveState (  const char *  name, ostream *  file, vtkIndent  indent )  [protected, virtual]

Save the state in XML. Reimplemented from vtkSMProperty.

---

Member Data Documentation

vtkSMStringVectorPropertyInternals* vtkSMStringVectorProperty::Internals [protected]

Definition at line 100 of file vtkSMStringVectorProperty.h.

---

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

• Servers/ServerManager/vtkSMStringVectorProperty.h

---