property representing a vector of strings More...

#include <vtkSMStringVectorProperty.h>

Inheritance diagram for vtkSMStringVectorProperty:

Collaboration diagram for vtkSMStringVectorProperty:

[legend]

Public Types
enum	ElementTypes { INT, DOUBLE, STRING }

typedef vtkSMVectorProperty	Superclass

Public Types inherited from vtkSMVectorProperty
typedef vtkSMProperty	Superclass

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

unsigned int	GetNumberOfElements () override
	Returns the size of the vector. More...

void	SetNumberOfElements (unsigned int num) override
	Sets the size of the vector. More...

int	SetElement (unsigned int idx, const char *value)
	Set the value of 1 element. More...

int	SetElements (const char *values[], unsigned int count)
	Sets multiple elements. More...

int	AppendElements (const std::vector< std::string > &newvalue)
	Append the values. More...

int	AppendUncheckedElements (const std::vector< std::string > &newvalue)
	Append the values to the unchecked elements. More...

void	GetElements (vtkStringList *list)
	Fills up the vtkStringList instance with the current value. More...

const char *	GetElement (unsigned int idx)
	Returns the value of 1 element. More...

unsigned int	GetElementIndex (const char *value, int &exists)
	Returns the index of an element with a particular value. More...

const char *	GetUncheckedElement (unsigned int idx)
	Returns the value of 1 unchecked element. More...

void	SetUncheckedElement (unsigned int idx, const char *value)
	Set the value of 1 unchecked element. More...

unsigned int	GetNumberOfUncheckedElements () override
	Returns the size of unchecked elements. More...

void	Copy (vtkSMProperty *src) override
	Copy all property values. More...

const char *	GetDefaultValue (int idx)
	Returns the default value, if any, specified in the XML. More...

void	ClearUncheckedElements () override
	API for setting unchecked element values. More...

bool	IsValueDefault () override
	Returns true if the property's value is different from the default value. More...

void	ResetToXMLDefaults () override
	For properties that support specifying defaults in XML configuration, this method will reset the property value to the default values specified in the XML. More...


int	SetElements (vtkStringList *newvalue)
	Sets multiple elements. More...

int	SetElements (const std::vector< std::string > &newvalue)
	Sets multiple elements. More...


int	SetUncheckedElements (const char *values[], unsigned int count)
	Sets the values of all the unchecked elements. More...

int	SetUncheckedElements (const std::vector< std::string > &newvalue)
	Sets the values of all the unchecked elements. More...


const std::vector< std::string > &	GetElements () const
	Another API to access all elements. More...

const std::vector< std::string > &	GetUncheckedElements () const
	Another API to access all elements. More...


void	SetElementType (unsigned int idx, int type)
	Set the cast type used when passing a value to the stream. More...

int	GetElementType (unsigned int idx)
	Set the cast type used when passing a value to the stream. More...


void	GetUncheckedElements (vtkStringList *list)
	Get/Set unchecked elements. More...

int	SetUncheckedElements (vtkStringList *list)
	Get/Set unchecked elements. More...

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

void	Copy (vtkSMProperty *src) override
	Copy all property values. More...

virtual void	SetInitialString (const char *)

virtual char *	GetInitialString ()

bool	ResetToDomainDefaults (bool use_unchecked_values=false) override
	Overridden to add support to load defaults from this->GetInformationProperty(), if one exists. More...

virtual int	GetRepeatCommand ()
	If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...

virtual void	SetRepeatCommand (int)
	If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...

virtual void	RepeatCommandOn ()
	If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...

virtual void	RepeatCommandOff ()
	If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...

virtual int	GetNumberOfElementsPerCommand ()
	If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...

virtual void	SetNumberOfElementsPerCommand (int)
	If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...

virtual int	GetUseIndex ()
	If UseIndex and RepeatCommand are true, the property will add an index integer before each command. More...

virtual void	SetUseIndex (int)
	If UseIndex and RepeatCommand are true, the property will add an index integer before each command. More...

virtual void	UseIndexOn ()
	If UseIndex and RepeatCommand are true, the property will add an index integer before each command. More...

virtual void	UseIndexOff ()
	If UseIndex and RepeatCommand are true, the property will add an index integer before each command. More...

virtual void	SetCleanCommand (const char *)
	Command that can be used to remove all values. More...

virtual char *	GetCleanCommand ()
	Command that can be used to remove all values. More...

virtual void	SetSetNumberCommand (const char *)
	If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter. More...

virtual char *	GetSetNumberCommand ()
	If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter. More...

Public Member Functions inherited from vtkSMProperty
int	IsInDomains ()
	Returns true if all values are in all domains, false otherwise. More...

int	IsInDomains (vtkSMDomain **domain)
	Overload of IsInDomains() that provides a mechanism to return the first domain that fails the check. More...

void	UnRegister (vtkObjectBase *obj) override
	Overloaded to break the reference loop caused by the internal domain iterator. More...

vtkSMDomainIterator *	NewDomainIterator ()
	Creates, initializes and returns a new domain iterator. More...

vtkSMDomain *	GetDomain (const char *name)
	Returns a domain give a name. More...

vtkSMDomain *	FindDomain (const char *classname)
	Returns the first domain which is of the specified type. More...

template<class DomainType >
DomainType *	FindDomain ()
	Same as FindDomain(classname), except the classname is deduced from the type. More...

unsigned int	GetNumberOfDomains ()
	Returns the number of domains this property has. More...

void	AddDomain (const char name, vtkSMDomain dom)
	Properties can have one or more domains. More...

virtual void	AddLinkedProperty (vtkSMProperty *targetProperty)
	Add a link to a property whose value should be synchronized with this property value. More...

virtual void	RemoveLinkedProperty (vtkSMProperty *targetProperty)
	Remove a link to a property added with AddLinkedProperty() More...

virtual void	RemoveFromSourceLink ()
	Remove a link from the source property. More...

void	ResetToDefault ()
	Simply calls this->ResetToDomainDefaults() and if that returns false, calls this->ResetToXMLDefaults(). More...

vtkSMProxy *	GetParent ()
	Get the proxy to which this property belongs. More...

virtual bool	IsStateIgnored ()

bool	HasDomainsWithRequiredProperties ()
	Returns true if the property has a domain with required properties. More...

virtual void	SetCommand (const char *)
	The command name used to set the value on the server object. More...

virtual char *	GetCommand ()
	The command name used to set the value on the server object. More...

virtual void	SetImmediateUpdate (int)
	If ImmediateUpdate is true, the value of the property will be pushed to the server as soon as it is modified. More...

virtual int	GetImmediateUpdate ()
	If ImmediateUpdate is true, the value of the property will be pushed to the server as soon as it is modified. More...

virtual int	GetInformationOnly ()
	Is InformationOnly is set to true, this property is used to get information from server instead of setting values. More...

virtual int	GetIgnoreSynchronization ()
	If IgnoreSynchronization is set to true, this property is used to prevent that property from being updated when changed remotely by another collaborative client. More...

virtual vtkSMProperty *	GetInformationProperty ()
	Get the associated information property. More...

virtual void	SetAnimateable (int)
	Get/Set if the property is animateable. More...

virtual int	GetAnimateable ()
	Get/Set if the property is animateable. More...

virtual void	SetIsInternal (int)
	Get/Set if the property is internal to server manager. More...

virtual int	GetIsInternal ()
	Get/Set if the property is internal to server manager. More...

virtual void	SetNoCustomDefault (int)
	Set/Get whether the property should ignore custom default settings. More...

virtual int	GetNoCustomDefault ()
	Set/Get whether the property should ignore custom default settings. More...

virtual void	SetPanelVisibility (const char *)
	Set/Get the panel visibility for the property. More...

virtual char *	GetPanelVisibility ()
	Set/Get the panel visibility for the property. More...

virtual void	SetPanelVisibilityDefaultForRepresentation (const char *)
	Set/Get the panel visibility to default if the current representation type matches `representation`. More...

virtual char *	GetPanelVisibilityDefaultForRepresentation ()
	Set/Get the panel visibility to default if the current representation type matches `representation`. More...

virtual void	SetPanelWidget (const char *)
	Set/Get the name of the custom panel widget to use for the property. More...

virtual char *	GetPanelWidget ()
	Set/Get the name of the custom panel widget to use for the property. More...

virtual void	SetDisableSubTrace (const char *)
	Set/Get the tracing of sub property of this property. More...

virtual char *	GetDisableSubTrace ()
	Set/Get the tracing of sub property of this property. More...

virtual vtkSMDocumentation *	GetDocumentation ()
	Returns the documentation for this proxy. More...

virtual char *	GetXMLLabel ()
	The label assigned by the xml parser. More...

virtual char *	GetXMLName ()
	The name assigned by the xml parser. More...

virtual int	GetRepeatable ()
	If repeatable, a property can have 1 or more values of the same kind. More...

virtual vtkPVXMLElement *	GetHints ()
	The server manager configuration XML may define `<Hints/>` element for a property. More...

void	SetHints (vtkPVXMLElement *hints)
	The server manager configuration XML may define `<Hints/>` element for a property. More...

void	Modified () override
	Overridden to support blocking of modified events. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkSMStringVectorProperty *	New ()

static int	IsTypeOf (const char *type)

static vtkSMStringVectorProperty *	SafeDownCast (vtkObject *o)

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

static vtkSMVectorProperty *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMProperty *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...

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

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMStringVectorProperty ()

	~vtkSMStringVectorProperty () override

void	SetNumberOfUncheckedElements (unsigned int num) override
	Sets the size of unchecked elements. More...

int	ReadXMLAttributes (vtkSMProxy parent, vtkPVXMLElement element) override
	Manage additional attribute from the XML -default_values_delimiter: char used to split the "default_values" into a vector. More...

void	WriteTo (vtkSMMessage *) override
	Let the property write its content into the stream. More...

void	ReadFrom (const vtkSMMessage , int msg_offset, vtkSMProxyLocator ) override
	Let the property read and set its content from the stream. More...

int	LoadState (vtkPVXMLElement element, vtkSMProxyLocator loader) override
	Load the XML state. More...

void	SaveStateValues (vtkPVXMLElement *propElement) override
	This method must be overridden by concrete class in order to save the real property data. More...

Protected Member Functions inherited from vtkSMVectorProperty
	vtkSMVectorProperty ()

	~vtkSMVectorProperty () override

int	ReadXMLAttributes (vtkSMProxy parent, vtkPVXMLElement element) override
	Set the appropriate ivars from the xml element. More...

Protected Member Functions inherited from vtkSMProperty
	vtkSMProperty ()

	~vtkSMProperty () override

virtual void	ReadFrom (const vtkSMMessage , int vtkNotUsed(message_offset), vtkSMProxyLocator )
	Let the property read and set its content from the stream. More...

virtual void	UpdateAllInputs ()
	Update all proxies referred by this property (if any). More...

vtkSMProperty *	NewProperty (const char *name)
	Internal. More...

void	AddDependent (vtkSMDomain *dom)
	Internal. More...

void	RemoveAllDependents ()
	Removes all dependents. More...

void	UpdateDomains ()
	Calls Update() on all domains contained by the property as well as all dependent domains. More...

virtual void	SaveState (vtkPVXMLElement parent, const char property_name, const char *uid, int saveDomains=1)
	Save the property state in XML. More...

virtual void	SaveDomainState (vtkPVXMLElement propertyElement, const char uid)
	Save property domain. More...

virtual void	SetXMLLabel (const char *)

virtual void	SetInformationOnly (int)

virtual void	SetIgnoreSynchronization (int)

void	SetInformationProperty (vtkSMProperty *ip)

void	SetDocumentation (vtkSMDocumentation *)

void	SetParent (vtkSMProxy *proxy)

virtual void	SetStateIgnored (bool)

virtual void	StateIgnoredOn ()

virtual void	StateIgnoredOff ()

virtual void	SetXMLName (const char *)
	The name assigned by the xml parser. More...

bool	SetBlockModifiedEvents (bool block)
	Block/unblock modified events, returns the current state of the block flag. More...

virtual bool	GetPendingModifiedEvents ()
	Returns if any modified evetns are pending. More...

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkSMVectorProperty
int	RepeatCommand

int	NumberOfElementsPerCommand

int	UseIndex

char *	CleanCommand

char *	SetNumberCommand

char *	InitialString

Protected Attributes inherited from vtkSMProperty
vtkPVXMLElement *	Hints

char *	Command

vtkSMPropertyInternals *	PInternals

int	ImmediateUpdate

int	Animateable

int	IsInternal

int	NoCustomDefault

char *	XMLName

char *	XMLLabel

char *	PanelVisibility

char *	PanelVisibilityDefaultForRepresentation

char *	PanelWidget

char *	DisableSubTrace

vtkSMDomainIterator *	DomainIterator

int	InformationOnly

int	IgnoreSynchronization

vtkSMInformationHelper *	InformationHelper

vtkSMProperty *	InformationProperty

vtkSMDocumentation *	Documentation

int	Repeatable

vtkWeakPointer< vtkSMProxy >	Proxy

bool	StateIgnored

vtkSMPropertyLink *	Links

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Member Typedef Documentation

◆ Superclass

typedef vtkSMVectorProperty vtkSMStringVectorProperty::Superclass

Definition at line 33 of file vtkSMStringVectorProperty.h.

Member Enumeration Documentation

◆ ElementTypes

enum vtkSMStringVectorProperty::ElementTypes

Enumerator
INT
DOUBLE
STRING

Definition at line 152 of file vtkSMStringVectorProperty.h.

Constructor & Destructor Documentation

◆ vtkSMStringVectorProperty()

vtkSMStringVectorProperty::vtkSMStringVectorProperty ( )

protected

◆ ~vtkSMStringVectorProperty()

vtkSMStringVectorProperty::~vtkSMStringVectorProperty ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMStringVectorProperty* vtkSMStringVectorProperty::New ( )

static

◆ GetClassName()

virtual const char* vtkSMStringVectorProperty::GetClassName ( )

virtual

Reimplemented from vtkSMVectorProperty.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMVectorProperty.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMProperty.

◆ GetNumberOfElements()

unsigned int vtkSMStringVectorProperty::GetNumberOfElements ( )

overridevirtual

Returns the size of the vector.

Implements vtkSMVectorProperty.

◆ SetNumberOfElements()

void vtkSMStringVectorProperty::SetNumberOfElements ( unsigned int num )

overridevirtual

Sets the size of the vector.

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

Implements vtkSMVectorProperty.

◆ SetElement()

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.

◆ SetElements() [1/3]

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

Sets multiple elements.

The size of the property is changed to match count.

◆ SetElements() [2/3]

int vtkSMStringVectorProperty::SetElements ( vtkStringList * newvalue )

Sets multiple elements.

The size of the property is changed to match count.

◆ SetElements() [3/3]

int vtkSMStringVectorProperty::SetElements ( const std::vector< std::string > & newvalue )

Sets multiple elements.

The size of the property is changed to match count.

◆ SetUncheckedElements() [1/3]

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

Sets the values of all the unchecked elements.

◆ SetUncheckedElements() [2/3]

int vtkSMStringVectorProperty::SetUncheckedElements ( const std::vector< std::string > & newvalue )

Sets the values of all the unchecked elements.

◆ AppendElements()

int vtkSMStringVectorProperty::AppendElements ( const std::vector< std::string > & newvalue )

Append the values.

The vector is resized as necessary.

◆ AppendUncheckedElements()

int vtkSMStringVectorProperty::AppendUncheckedElements ( const std::vector< std::string > & newvalue )

Append the values to the unchecked elements.

The vector is resized as necessary.

◆ GetElements() [1/2]

void vtkSMStringVectorProperty::GetElements ( vtkStringList * list )

Fills up the vtkStringList instance with the current value.

◆ GetElements() [2/2]

const std::vector<std::string>& vtkSMStringVectorProperty::GetElements ( ) const

Another API to access all elements.

◆ GetUncheckedElements() [1/2]

const std::vector<std::string>& vtkSMStringVectorProperty::GetUncheckedElements ( ) const

Another API to access all elements.

◆ GetElement()

const char* vtkSMStringVectorProperty::GetElement ( unsigned int idx )

Returns the value of 1 element.

◆ GetElementIndex()

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.

◆ SetElementType()

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.

◆ GetElementType()

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.

◆ GetUncheckedElement()

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.

◆ SetUncheckedElement()

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

◆ GetUncheckedElements() [2/2]

void vtkSMStringVectorProperty::GetUncheckedElements ( vtkStringList * list )

Get/Set unchecked elements.

◆ SetUncheckedElements() [3/3]

int vtkSMStringVectorProperty::SetUncheckedElements ( vtkStringList * list )

Get/Set unchecked elements.

◆ GetNumberOfUncheckedElements()

unsigned int vtkSMStringVectorProperty::GetNumberOfUncheckedElements ( )

overridevirtual

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.

Implements vtkSMVectorProperty.

◆ Copy()

void vtkSMStringVectorProperty::Copy ( vtkSMProperty * src )

overridevirtual

Copy all property values.

Reimplemented from vtkSMProperty.

◆ GetDefaultValue()

const char* vtkSMStringVectorProperty::GetDefaultValue ( int idx )

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

◆ ClearUncheckedElements()

void vtkSMStringVectorProperty::ClearUncheckedElements ( )

overridevirtual

API for setting unchecked element values.

Implements vtkSMVectorProperty.

◆ IsValueDefault()

bool vtkSMStringVectorProperty::IsValueDefault ( )

overridevirtual

Returns true if the property's value is different from the default value.

This is used as a hint by the state saving code to determine if the value should be written to the file or if the defaults are sufficient.

Reimplemented from vtkSMProperty.

◆ ResetToXMLDefaults()

void vtkSMStringVectorProperty::ResetToXMLDefaults ( )

overridevirtual

For properties that support specifying defaults in XML configuration, this method will reset the property value to the default values specified in the XML.

Reimplemented from vtkSMProperty.

◆ SetNumberOfUncheckedElements()

void vtkSMStringVectorProperty::SetNumberOfUncheckedElements ( unsigned int num )

overrideprotectedvirtual

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.

Implements vtkSMVectorProperty.

◆ ReadXMLAttributes()

int vtkSMStringVectorProperty::ReadXMLAttributes	(	vtkSMProxy *	parent,
		vtkPVXMLElement *	element
	)

overrideprotectedvirtual

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

◆ WriteTo()

void vtkSMStringVectorProperty::WriteTo ( vtkSMMessage * )

overrideprotectedvirtual

Let the property write its content into the stream.

Reimplemented from vtkSMProperty.

◆ ReadFrom()

void vtkSMStringVectorProperty::ReadFrom	(	const vtkSMMessage *	,
		int	msg_offset,
		vtkSMProxyLocator *
	)

overrideprotected

Let the property read and set its content from the stream.

◆ LoadState()

int vtkSMStringVectorProperty::LoadState	(	vtkPVXMLElement *	element,
		vtkSMProxyLocator *	loader
	)

overrideprotectedvirtual

Load the XML state.

Reimplemented from vtkSMProperty.

◆ SaveStateValues()

void vtkSMStringVectorProperty::SaveStateValues ( vtkPVXMLElement * propertyElement )

overrideprotectedvirtual

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

Reimplemented from vtkSMProperty.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMStringVectorProperty.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ElementTypes

Constructor & Destructor Documentation

◆ vtkSMStringVectorProperty()

◆ ~vtkSMStringVectorProperty()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetNumberOfElements()

◆ SetNumberOfElements()

◆ SetElement()

◆ SetElements() [1/3]

◆ SetElements() [2/3]

◆ SetElements() [3/3]

◆ SetUncheckedElements() [1/3]

◆ SetUncheckedElements() [2/3]

◆ AppendElements()

◆ AppendUncheckedElements()

◆ GetElements() [1/2]

◆ GetElements() [2/2]

◆ GetUncheckedElements() [1/2]

◆ GetElement()

◆ GetElementIndex()

◆ SetElementType()

◆ GetElementType()

◆ GetUncheckedElement()

◆ SetUncheckedElement()

◆ GetUncheckedElements() [2/2]

◆ SetUncheckedElements() [3/3]

◆ GetNumberOfUncheckedElements()

◆ Copy()

◆ GetDefaultValue()

◆ ClearUncheckedElements()

◆ IsValueDefault()

◆ ResetToXMLDefaults()

◆ SetNumberOfUncheckedElements()

◆ ReadXMLAttributes()

◆ WriteTo()

◆ ReadFrom()

◆ LoadState()

◆ SaveStateValues()