1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*=========================================================================
Program: ParaView
Module: vtkSMEnumerationDomain.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkSMEnumerationDomain - list of integers with associated strings
// .SECTION Description
// vtkSMEnumerationDomain represents an enumeration of integer values
// with associated descriptive strings.
// Valid XML elements are:
// @verbatim
// * <Entry text="" value=""/> where text is the descriptive
// string and value is the integer value.
// @endverbatim
#ifndef vtkSMEnumerationDomain_h
#define vtkSMEnumerationDomain_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMDomain.h"
struct vtkSMEnumerationDomainInternals;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMEnumerationDomain : public vtkSMDomain
{
public:
static vtkSMEnumerationDomain* New();
vtkTypeMacro(vtkSMEnumerationDomain, vtkSMDomain);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Returns true if the value of the propery is in the domain.
// The propery has to be a vtkSMIntVectorProperty. If all
// vector values are in the domain, it returns 1. It returns
// 0 otherwise.
virtual int IsInDomain(vtkSMProperty* property);
// Description:
// Returns true if the int is in the domain. If value is
// in domain, it's index is return in idx.
int IsInDomain(int val, unsigned int& idx);
// Description:
// Returns the number of entries in the enumeration.
unsigned int GetNumberOfEntries();
// Description:
// Returns the integer value of an enumeration entry.
int GetEntryValue(unsigned int idx);
// Description:
// Returns the descriptive string of an enumeration entry.
const char* GetEntryText(unsigned int idx);
// Description:
// Returns the text for an enumeration value.
const char* GetEntryTextForValue(int value);
// Description:
// Return 1 is the text is present in the enumeration, otherwise 0.
int HasEntryText(const char* text);
// Description:
// Get the value for an enumeration text. The return value is valid only is
// HasEntryText() returns 1.
int GetEntryValueForText(const char* text);
// Description:
// Given an entry text, return the integer value.
// Valid is set to 1 if text is defined, otherwise 0.
// If valid=0, return value is undefined.
int GetEntryValue(const char* text, int& valid);
// Description:
// Add a new enumeration entry. text cannot be null.
void AddEntry(const char* text, int value);
// Description:
// Clear all entries.
void RemoveAllEntries();
// Description:
// Update self based on the "unchecked" values of all required
// properties. Overwritten by sub-classes.
virtual void Update(vtkSMProperty* property);
// Description:
// Overridden to ensure that the property's default value is valid for the
// enumeration, if not it will be set to the first enumeration value.
virtual int SetDefaultValues(vtkSMProperty*, bool use_unchecked_values);
protected:
vtkSMEnumerationDomain();
~vtkSMEnumerationDomain();
// Description:
// Set the appropriate ivars from the xml element. Should
// be overwritten by subclass if adding ivars.
virtual int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* element);
virtual void ChildSaveState(vtkPVXMLElement* domainElement);
vtkSMEnumerationDomainInternals* EInternals;
private:
vtkSMEnumerationDomain(const vtkSMEnumerationDomain&); // Not implemented
void operator=(const vtkSMEnumerationDomain&); // Not implemented
};
#endif
|
