ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSMStringListDomain Class Reference

list of strings More...

#include <vtkSMStringListDomain.h>

Inheritance diagram for vtkSMStringListDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMStringListDomain:
Collaboration graph
[legend]

Public Types

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 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...
 
vtkSMPropertyGetProperty ()
 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 vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual void SetSession (vtkSMSession *)
 Get/Set the session on wihch this object exists. More...
 
virtual vtkSMSessionGetSession ()
 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 vtkSMStringListDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMStringListDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDomain
static int IsTypeOf (const char *type)
 
static vtkSMDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

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...
 
- 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...
 
vtkSMPropertyGetRequiredProperty (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 vtkPVDataInformationGetInputDataInformation (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 ()
 
virtual int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values)
 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...
 
 ~vtkSMStringListDomain ()
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 

Detailed Description

list of strings

vtkSMStringListDomain represents a domain consisting of a list of strings. It only works with vtkSMStringVectorProperty. Valid XML elements are:

* * <String value="">
* 
See also
vtkSMDomain vtkSMStringVectorProperty

Definition at line 39 of file vtkSMStringListDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkSMStringListDomain.h.

Constructor & Destructor Documentation

◆ vtkSMStringListDomain()

vtkSMStringListDomain::vtkSMStringListDomain ( )
protected

A vtkSMProperty is often defined with a default value in the XML itself.

However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property. Returns 1 if the domain updated the property.

◆ ~vtkSMStringListDomain()

vtkSMStringListDomain::~vtkSMStringListDomain ( )
protected

A vtkSMProperty is often defined with a default value in the XML itself.

However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property. Returns 1 if the domain updated the property.

Member Function Documentation

◆ New()

static vtkSMStringListDomain* vtkSMStringListDomain::New ( )
static

◆ GetClassName()

virtual const char* vtkSMStringListDomain::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ IsInDomain() [1/2]

virtual int vtkSMStringListDomain::IsInDomain ( vtkSMProperty property)
virtual

Returns true if the value of the property is in the domain.

The propery has to be a vtkSMStringVectorProperty. If all vector values are in the domain, it returns 1. It returns 0 otherwise.

Implements vtkSMDomain.

◆ IsInDomain() [2/2]

int vtkSMStringListDomain::IsInDomain ( const char *  string,
unsigned int &  idx 
)

Returns true if the string is in the domain.

◆ GetString()

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

Returns a string in the domain.

The pointer may become invalid once the domain has been modified.

◆ GetNumberOfStrings()

unsigned int vtkSMStringListDomain::GetNumberOfStrings ( )

Returns the number of strings in the domain.

◆ Update()

virtual void vtkSMStringListDomain::Update ( vtkSMProperty )
virtual

Update self checking the "unchecked" values of all required properties.

Overwritten by sub-classes.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMArrayListDomain, vtkSMChartSeriesSelectionDomain, vtkSMChartSeriesListDomain, vtkSMRepresentedArrayListDomain, and vtkSMInputFileNameDomain.

◆ SetAnimationValue()

virtual void vtkSMStringListDomain::SetAnimationValue ( vtkSMProperty ,
int  ,
double   
)
virtual

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

◆ SetDefaultValues()

virtual int vtkSMStringListDomain::SetDefaultValues ( vtkSMProperty ,
bool  use_unchecked_values 
)
virtual

A vtkSMProperty is often defined with a default value in the XML itself.

However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property. Returns 1 if the domain updated the property.

Reimplemented in vtkSMArrayListDomain, vtkSMChartSeriesSelectionDomain, vtkSMSILDomain, vtkSMChartSeriesListDomain, vtkSMInputFileNameDomain, vtkSMRepresentationTypeDomain, vtkSMArraySelectionDomain, and vtkSMBagChartSeriesListDomain.

◆ ReadXMLAttributes()

virtual int vtkSMStringListDomain::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement element 
)
protectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMArrayListDomain, vtkSMChartSeriesSelectionDomain, vtkSMChartSeriesListDomain, vtkSMSILDomain, vtkSMRepresentedArrayListDomain, and vtkSMBagChartSeriesListDomain.

◆ ChildSaveState()

virtual void vtkSMStringListDomain::ChildSaveState ( vtkPVXMLElement domainElement)
protectedvirtual

Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes.

The newly created element will also be added to the parent element as a child node. Subclasses can override ChildSaveState() method to fill it up with subclass specific values.

Reimplemented from vtkSMDomain.

◆ SetStrings()

virtual void vtkSMStringListDomain::SetStrings ( const std::vector< vtkStdString > &  strings)
protectedvirtual

Call to set the strings.

Will fire DomainModifiedEvent if the domain values have indeed changed.

◆ GetStrings()

const std::vector<vtkStdString>& vtkSMStringListDomain::GetStrings ( )
protected

Call to set the strings.

Will fire DomainModifiedEvent if the domain values have indeed changed.


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