ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkSMPropertyAdaptor Class Reference

provides string based interface for properties and domains More...

#include <vtkSMPropertyAdaptor.h>

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

List of all members.

Public Types

enum  PropertyTypes {
  UNKNOWN = 0, ENUMERATION, SELECTION, RANGE,
  FILE_LIST, NUM_PROPERTY_TYPES
}
enum  ElementType {
  INT = NUM_PROPERTY_TYPES+1, DOUBLE, STRING, BOOLEAN,
  PROXY
}

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
unsigned int GetNumberOfRangeElements ()
const char * GetRangeValue (unsigned int idx)
int SetRangeValue (unsigned int idx, const char *value)
unsigned int GetNumberOfEnumerationElements ()
const char * GetEnumerationName (unsigned int idx)
const char * GetEnumerationValue ()
int SetEnumerationValue (const char *idx)
unsigned int GetNumberOfSelectionElements ()
const char * GetSelectionName (unsigned int idx)
const char * GetSelectionValue (unsigned int idx)
int SetSelectionValue (unsigned int idx, const char *value)
void InitializePropertyFromInformation ()
int GetPropertyType ()
int GetElementType ()
int SetGenericValue (unsigned int idx, const char *value)
void SetProperty (vtkSMProperty *prop)
virtual vtkSMProperty * GetProperty ()
const char * GetRangeMinimum (unsigned int idx)
const char * GetRangeMaximum (unsigned int idx)
const char * GetSelectionMinimum (unsigned int idx)
const char * GetSelectionMaximum (unsigned int idx)

Static Public Member Functions

static vtkSMPropertyAdaptor * New ()
static int IsTypeOf (const char *type)
static vtkSMPropertyAdaptor * SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSMPropertyAdaptor ()
 ~vtkSMPropertyAdaptor ()
void InitializeDomains ()
void InitializeProperties ()
void SetDomain (vtkSMDomain *domain)

Protected Attributes

vtkSMBooleanDomain * BooleanDomain
vtkSMDoubleRangeDomain * DoubleRangeDomain
vtkSMEnumerationDomain * EnumerationDomain
vtkSMFileListDomain * FileListDomain
vtkSMIntRangeDomain * IntRangeDomain
vtkSMProxyGroupDomain * ProxyGroupDomain
vtkSMStringListDomain * StringListDomain
vtkSMStringListRangeDomain * StringListRangeDomain
vtkSMProxyProperty * ProxyProperty
vtkSMDoubleVectorProperty * DoubleVectorProperty
vtkSMIdTypeVectorProperty * IdTypeVectorProperty
vtkSMIntVectorProperty * IntVectorProperty
vtkSMStringVectorProperty * StringVectorProperty
vtkSMProperty * Property
char Minimum [128]
char Maximum [128]
char EnumValue [128]
char ElemValue [128]

Detailed Description

provides string based interface for properties and domains

vtkSMPropertyAdaptor provides a general purpose string based interface for properties and domain. This is a helper class that can be used to simplify the management of properties and domains although it somehow restricts the capabilities of the server manager. It supports three types of properties: 

 1. Vector properties with range (RANGE)
 2. Enumaration properties (ENUMERATION or FILE_LIST)
 3. Selection properties (SELECTION)

(1) represent int or double properties that are restricted between a min and a max. (2) represent properties that can have a value out of a list (for example, the representation of a geometry: solid, wireframe, points etc.. (3) represent properties that associate a value with a key (similar to maps). This might be used to set the active state of arrays for example. Make sure to use the API appropriate for the property type. Using the wrong API will produce incorrect results.

Definition at line 59 of file vtkSMPropertyAdaptor.h.

Member Enumeration Documentation

enum vtkSMPropertyAdaptor::PropertyTypes
Enumerator:
UNKNOWN 
ENUMERATION 
SELECTION 
RANGE 
FILE_LIST 
NUM_PROPERTY_TYPES 

Definition at line 148 of file vtkSMPropertyAdaptor.h.

enum vtkSMPropertyAdaptor::ElementType
Enumerator:
INT 
DOUBLE 
STRING 
BOOLEAN 
PROXY 

Definition at line 158 of file vtkSMPropertyAdaptor.h.

Constructor & Destructor Documentation

vtkSMPropertyAdaptor::vtkSMPropertyAdaptor ( ) [protected]
vtkSMPropertyAdaptor::~vtkSMPropertyAdaptor ( ) [protected]

Member Function Documentation

static vtkSMPropertyAdaptor* vtkSMPropertyAdaptor::New ( ) [static]

Reimplemented from vtkSMObject.

virtual const char* vtkSMPropertyAdaptor::GetClassName ( ) [virtual]

Reimplemented from vtkSMObject.

static int vtkSMPropertyAdaptor::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkSMObject.

virtual int vtkSMPropertyAdaptor::IsA ( const char *  type) [virtual]

Reimplemented from vtkSMObject.

static vtkSMPropertyAdaptor* vtkSMPropertyAdaptor::SafeDownCast ( vtkObject *  o) [static]

Reimplemented from vtkSMObject.

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

Reimplemented from vtkSMObject.

void vtkSMPropertyAdaptor::SetProperty ( vtkSMProperty *  prop)

Set/Get the property to be adapted. The property has to be set before any other method can be called.

virtual vtkSMProperty* vtkSMPropertyAdaptor::GetProperty ( ) [virtual]

Set/Get the property to be adapted. The property has to be set before any other method can be called.

const char* vtkSMPropertyAdaptor::GetRangeMinimum ( unsigned int  idx)

Return min and max as string. Returns NULL if min or max is not set.

const char* vtkSMPropertyAdaptor::GetRangeMaximum ( unsigned int  idx)

Return min and max as string. Returns NULL if min or max is not set.

unsigned int vtkSMPropertyAdaptor::GetNumberOfRangeElements ( )

Returns the number of elements.

const char* vtkSMPropertyAdaptor::GetRangeValue ( unsigned int  idx)

Returns the property value.

int vtkSMPropertyAdaptor::SetRangeValue ( unsigned int  idx,
const char *  value 
)

Sets the property value.

unsigned int vtkSMPropertyAdaptor::GetNumberOfEnumerationElements ( )

Returns the number possible enumeration entries. Note that this is different than the number of elements in the property.

const char* vtkSMPropertyAdaptor::GetEnumerationName ( unsigned int  idx)

Returns the string associated with an enumeration entry.

const char* vtkSMPropertyAdaptor::GetEnumerationValue ( )

Returns the value. Note that this is an int (converted to string) that should be used together with GetEnumerationName.

int vtkSMPropertyAdaptor::SetEnumerationValue ( const char *  idx)

Set the value. Should be an int.

unsigned int vtkSMPropertyAdaptor::GetNumberOfSelectionElements ( )

Returns the number of elements that can be set/get.

const char* vtkSMPropertyAdaptor::GetSelectionName ( unsigned int  idx)

Returns a string representation for the name of a selection element.

const char* vtkSMPropertyAdaptor::GetSelectionValue ( unsigned int  idx)

Returns the value of an element.

int vtkSMPropertyAdaptor::SetSelectionValue ( unsigned int  idx,
const char *  value 
)

Set the value.

const char* vtkSMPropertyAdaptor::GetSelectionMinimum ( unsigned int  idx)

Returns the min and max for a selection element. Returns NULL if min or max are not set.

const char* vtkSMPropertyAdaptor::GetSelectionMaximum ( unsigned int  idx)

Returns the min and max for a selection element. Returns NULL if min or max are not set.

void vtkSMPropertyAdaptor::InitializePropertyFromInformation ( )

Initialize the underlying property from it's information property by copying the values of the information property to the propery.

int vtkSMPropertyAdaptor::GetPropertyType ( )

Returns either ENUMERATION, RANGE, SELECTION, FILE_LIST or UNKNOWN.

int vtkSMPropertyAdaptor::GetElementType ( )

Returns either INT, DOUBLE, STRING, PROXY, BOOLEAN or UNKNOWN

int vtkSMPropertyAdaptor::SetGenericValue ( unsigned int  idx,
const char *  value 
)

Set the value of the property. Use this if none of the three Set methods above are not appropriate.

void vtkSMPropertyAdaptor::InitializeDomains ( ) [protected]
void vtkSMPropertyAdaptor::InitializeProperties ( ) [protected]
void vtkSMPropertyAdaptor::SetDomain ( vtkSMDomain *  domain) [protected]

Member Data Documentation

vtkSMBooleanDomain* vtkSMPropertyAdaptor::BooleanDomain [protected]

Definition at line 177 of file vtkSMPropertyAdaptor.h.

vtkSMDoubleRangeDomain* vtkSMPropertyAdaptor::DoubleRangeDomain [protected]

Definition at line 178 of file vtkSMPropertyAdaptor.h.

vtkSMEnumerationDomain* vtkSMPropertyAdaptor::EnumerationDomain [protected]

Definition at line 179 of file vtkSMPropertyAdaptor.h.

vtkSMFileListDomain* vtkSMPropertyAdaptor::FileListDomain [protected]

Definition at line 180 of file vtkSMPropertyAdaptor.h.

vtkSMIntRangeDomain* vtkSMPropertyAdaptor::IntRangeDomain [protected]

Definition at line 181 of file vtkSMPropertyAdaptor.h.

vtkSMProxyGroupDomain* vtkSMPropertyAdaptor::ProxyGroupDomain [protected]

Definition at line 182 of file vtkSMPropertyAdaptor.h.

vtkSMStringListDomain* vtkSMPropertyAdaptor::StringListDomain [protected]

Definition at line 183 of file vtkSMPropertyAdaptor.h.

vtkSMStringListRangeDomain* vtkSMPropertyAdaptor::StringListRangeDomain [protected]

Definition at line 184 of file vtkSMPropertyAdaptor.h.

vtkSMProxyProperty* vtkSMPropertyAdaptor::ProxyProperty [protected]

Definition at line 186 of file vtkSMPropertyAdaptor.h.

vtkSMDoubleVectorProperty* vtkSMPropertyAdaptor::DoubleVectorProperty [protected]

Definition at line 187 of file vtkSMPropertyAdaptor.h.

vtkSMIdTypeVectorProperty* vtkSMPropertyAdaptor::IdTypeVectorProperty [protected]

Definition at line 188 of file vtkSMPropertyAdaptor.h.

vtkSMIntVectorProperty* vtkSMPropertyAdaptor::IntVectorProperty [protected]

Definition at line 189 of file vtkSMPropertyAdaptor.h.

vtkSMStringVectorProperty* vtkSMPropertyAdaptor::StringVectorProperty [protected]

Definition at line 190 of file vtkSMPropertyAdaptor.h.

vtkSMProperty* vtkSMPropertyAdaptor::Property [protected]

Definition at line 192 of file vtkSMPropertyAdaptor.h.

char vtkSMPropertyAdaptor::Minimum[128] [protected]

Definition at line 194 of file vtkSMPropertyAdaptor.h.

char vtkSMPropertyAdaptor::Maximum[128] [protected]

Definition at line 195 of file vtkSMPropertyAdaptor.h.

char vtkSMPropertyAdaptor::EnumValue[128] [protected]

Definition at line 196 of file vtkSMPropertyAdaptor.h.

char vtkSMPropertyAdaptor::ElemValue[128] [protected]

Definition at line 197 of file vtkSMPropertyAdaptor.h.

The documentation for this class was generated from the following file:
Generated on Wed May 23 2012 00:52:04 for ParaView by   doxygen 1.7.5.1