vtkSMEnumerationDomain Class Reference

list of integers with associated strings More...

#include <vtkSMEnumerationDomain.h>

Inheritance diagram for vtkSMEnumerationDomain:

[legend]Collaboration diagram for vtkSMEnumerationDomain:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkSMEnumerationDomain, vtkSMDomain)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsInDomain (vtkSMProperty *property)
int	IsInDomain (int val, unsigned int &idx)
unsigned int	GetNumberOfEntries ()
int	GetEntryValue (unsigned int idx)
const char *	GetEntryText (unsigned int idx)
void	AddEntry (const char *text, int value)
void	RemoveAllEntries ()
Static Public Member Functions
vtkSMEnumerationDomain *	New ()
Protected Member Functions
	vtkSMEnumerationDomain ()
	~vtkSMEnumerationDomain ()
virtual int	ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
virtual void	SaveState (const char *name, ostream *file, vtkIndent indent)
Protected Attributes
vtkSMEnumerationDomainInternals *	EInternals

---

Detailed Description

list of integers with associated strings

vtkSMEnumerationDomain represents an enumeration of integer values with associated descriptive strings. Valid XML elements are:

 * <Entry text="" value=""/> where text is the descriptive
 string and value is the integer value.
 

See also:

vtkSMDomain

Definition at line 38 of file vtkSMEnumerationDomain.h.

---

Constructor & Destructor Documentation

vtkSMEnumerationDomain::vtkSMEnumerationDomain (   )  [protected]

vtkSMEnumerationDomain::~vtkSMEnumerationDomain (   )  [protected]

---

Member Function Documentation

vtkSMEnumerationDomain* vtkSMEnumerationDomain::New (   )  [static]

Reimplemented from vtkSMObject. Reimplemented in vtkSMFieldDataDomain.

vtkSMEnumerationDomain::vtkTypeRevisionMacro (  vtkSMEnumerationDomain  , vtkSMDomain  )

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

Reimplemented from vtkSMDomain. Reimplemented in vtkSMFieldDataDomain.

virtual int vtkSMEnumerationDomain::IsInDomain (  vtkSMProperty *  property  )  [virtual]

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. Implements vtkSMDomain.

int vtkSMEnumerationDomain::IsInDomain (  int  val, unsigned int &  idx )

Returns true if the int is in the domain. If value is in domain, it's index is return in idx.

unsigned int vtkSMEnumerationDomain::GetNumberOfEntries (   )

Returns the number of entries in the enumeration.

int vtkSMEnumerationDomain::GetEntryValue (  unsigned int  idx  )

Returns the integer value of an enumeration entry.

const char* vtkSMEnumerationDomain::GetEntryText (  unsigned int  idx  )

Returns the descriptive string of an enumeration entry.

void vtkSMEnumerationDomain::AddEntry (  const char *  text, int  value )

Add a new enumeration entry. text cannot be null.

void vtkSMEnumerationDomain::RemoveAllEntries (   )

Clear all entries.

virtual int vtkSMEnumerationDomain::ReadXMLAttributes (  vtkSMProperty *  prop, vtkPVXMLElement *  element )  [protected, virtual]

Set the appropriate ivars from the xml element. Should be overwritten by subclass if adding ivars. Reimplemented from vtkSMDomain.

virtual void vtkSMEnumerationDomain::SaveState (  const char *  name, ostream *  file, vtkIndent  indent )  [protected, virtual]

Saves the state of the object in XML format. Should be overwritten by proxies and properties. Reimplemented from vtkSMObject.

---

Member Data Documentation

vtkSMEnumerationDomainInternals* vtkSMEnumerationDomain::EInternals [protected]

Definition at line 79 of file vtkSMEnumerationDomain.h.

---

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

• Servers/ServerManager/vtkSMEnumerationDomain.h

---