ParaView
Public Member Functions | List of all members
vtkSMUncheckedPropertyHelper Class Reference

#include <vtkSMUncheckedPropertyHelper.h>

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

Public Member Functions

 vtkSMUncheckedPropertyHelper (vtkSMProxy *proxy, const char *name, bool quiet=false)
 
 vtkSMUncheckedPropertyHelper (vtkSMProperty *property, bool quiet=false)
 
- Public Member Functions inherited from vtkSMPropertyHelper
void UpdateValueFromServer ()
 Updates the property value by fetching the value from the server. More...
 
void SetNumberOfElements (unsigned int elems)
 Set the number of elements in the property. More...
 
unsigned int GetNumberOfElements () const
 Get the number of elements in the property. More...
 
void RemoveAllValues ()
 Equivalent to SetNumberOfElements(0). More...
 
vtkVariant GetAsVariant (unsigned int index)
 Get value as a variant. More...
 
template<class T >
std::vector< T > GetArray ()
 Templated method to call GetIntArray(), GetDoubleArray(), GetIdTypeArray(). More...
 
template<class T >
GetAs (unsigned int index=0)
 Templated method to call GetAsInt(), GetAsDouble(), GetAsIdType() Note, we only provide implementations for T==double, int, vtkIdType. More...
 
vtkIdType GetAsIdType (unsigned int index=0)
 
std::vector< vtkIdType > GetIdTypeArray ()
 
void SetUseUnchecked (bool val)
 Get/Set whether to use unchecked properties. More...
 
bool GetUseUnchecked ()
 
bool Copy (vtkSMPropertyHelper &source)
 Copy property values from another vtkSMPropertyHelper. More...
 
template<>
std::vector< int > GetArray ()
 
template<>
std::vector< double > GetArray ()
 
template<>
int GetAs (unsigned int index)
 
template<>
double GetAs (unsigned int index)
 
 vtkSMPropertyHelper (vtkSMProxy *proxy, const char *name, bool quiet=false)
 If quiet is true, then no errors or warning are raised if the property is missing or of incorrect type. More...
 
 vtkSMPropertyHelper (vtkSMProperty *property, bool quiet=false)
 If quiet is true, then no errors or warning are raised if the property is missing or of incorrect type. More...
 
 ~vtkSMPropertyHelper ()
 If quiet is true, then no errors or warning are raised if the property is missing or of incorrect type. More...
 
void Set (int value)
 Set/Get methods with int API. More...
 
void Set (unsigned int index, int value)
 Set/Get methods with int API. More...
 
void Set (const int *values, unsigned int count)
 Set/Get methods with int API. More...
 
int GetAsInt (unsigned int index=0)
 Set/Get methods with int API. More...
 
unsigned int Get (int *values, unsigned int count=1)
 Set/Get methods with int API. More...
 
std::vector< int > GetIntArray ()
 Set/Get methods with int API. More...
 
void Set (double value)
 Set/Get methods with double API. More...
 
void Set (unsigned int index, double value)
 Set/Get methods with double API. More...
 
void Set (const double *values, unsigned int count)
 Set/Get methods with double API. More...
 
double GetAsDouble (unsigned int index=0)
 Set/Get methods with double API. More...
 
unsigned int Get (double *values, unsigned int count=1)
 Set/Get methods with double API. More...
 
std::vector< double > GetDoubleArray ()
 Set/Get methods with double API. More...
 
void Set (const char *value)
 Set/Get methods for vtkSMStringVectorProperty. More...
 
void Set (unsigned int index, const char *value)
 Set/Get methods for vtkSMStringVectorProperty. More...
 
const char * GetAsString (unsigned int index=0)
 Set/Get methods for vtkSMStringVectorProperty. More...
 
void Set (vtkSMProxy *value, unsigned int outputport=0)
 Set/Get methods for vtkSMProxyProperty or vtkSMInputProperty. More...
 
void Set (unsigned int index, vtkSMProxy *value, unsigned int outputport=0)
 Set/Get methods for vtkSMProxyProperty or vtkSMInputProperty. More...
 
void Set (vtkSMProxy **value, unsigned int count, unsigned int *outputports=NULL)
 Set/Get methods for vtkSMProxyProperty or vtkSMInputProperty. More...
 
void Add (vtkSMProxy *value, unsigned int outputport=0)
 Set/Get methods for vtkSMProxyProperty or vtkSMInputProperty. More...
 
void Remove (vtkSMProxy *value)
 Set/Get methods for vtkSMProxyProperty or vtkSMInputProperty. More...
 
vtkSMProxyGetAsProxy (unsigned int index=0)
 Set/Get methods for vtkSMProxyProperty or vtkSMInputProperty. More...
 
unsigned int GetOutputPort (unsigned int index=0)
 Set/Get methods for vtkSMProxyProperty or vtkSMInputProperty. More...
 
void SetStatus (const char *key, int value)
 This API is useful for setting values on vtkSMStringVectorProperty that is used for status where the first value is the name of the array (for example) and the second value is it's status. More...
 
int GetStatus (const char *key, int default_value=0)
 This API is useful for setting values on vtkSMStringVectorProperty that is used for status where the first value is the name of the array (for example) and the second value is it's status. More...
 
void SetStatus (const char *key, double *values, int num_values)
 This API is useful for setting values on vtkSMStringVectorProperty that is used for status where the first value is the name of the array (for example) and the second value is it's status. More...
 
bool GetStatus (const char *key, double *values, int num_values)
 This API is useful for setting values on vtkSMStringVectorProperty that is used for status where the first value is the name of the array (for example) and the second value is it's status. More...
 
void SetStatus (const char *key, const char *value)
 This API is useful for setting values on vtkSMStringVectorProperty that is used for status where the first value is the name of the array (for example) and the second value is it's status (as a string) More...
 
const char * GetStatus (const char *key, const char *default_value)
 This API is useful for setting values on vtkSMStringVectorProperty that is used for status where the first value is the name of the array (for example) and the second value is it's status (as a string) More...
 
void SetInputArrayToProcess (int fieldAssociation, const char *arrayName)
 For vtkSMStringVectorProperty that is used to setting input array to process on algorithms, this provides a convenient API to get/set the values. More...
 
int GetInputArrayAssociation ()
 For vtkSMStringVectorProperty that is used to setting input array to process on algorithms, this provides a convenient API to get/set the values. More...
 
const char * GetInputArrayNameToProcess ()
 For vtkSMStringVectorProperty that is used to setting input array to process on algorithms, this provides a convenient API to get/set the values. More...
 

Additional Inherited Members

- Protected Member Functions inherited from vtkSMPropertyHelper
void setUseUnchecked (bool useUnchecked)
 

Detailed Description

Definition at line 22 of file vtkSMUncheckedPropertyHelper.h.

Constructor & Destructor Documentation

◆ vtkSMUncheckedPropertyHelper() [1/2]

vtkSMUncheckedPropertyHelper::vtkSMUncheckedPropertyHelper ( vtkSMProxy proxy,
const char *  name,
bool  quiet = false 
)

◆ vtkSMUncheckedPropertyHelper() [2/2]

vtkSMUncheckedPropertyHelper::vtkSMUncheckedPropertyHelper ( vtkSMProperty property,
bool  quiet = false 
)

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