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

list of integers with associated strings More...

#include <vtkSMEnumerationDomain.h>

Inheritance diagram for vtkSMEnumerationDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMEnumerationDomain:
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 propery is in the domain. More...
 
int IsInDomain (int val, unsigned int &idx)
 Returns true if the int is in the domain. More...
 
unsigned int GetNumberOfEntries ()
 Returns the number of entries in the enumeration. More...
 
int GetEntryValue (unsigned int idx)
 Returns the integer value of an enumeration entry. More...
 
const char * GetEntryText (unsigned int idx)
 Returns the descriptive string of an enumeration entry. More...
 
const char * GetEntryTextForValue (int value)
 Returns the text for an enumeration value. More...
 
int HasEntryText (const char *text)
 Return 1 is the text is present in the enumeration, otherwise 0. More...
 
int GetEntryValueForText (const char *text)
 Get the value for an enumeration text. More...
 
int GetEntryValue (const char *text, int &valid)
 Given an entry text, return the integer value. More...
 
void AddEntry (const char *text, int value)
 Add a new enumeration entry. More...
 
void RemoveAllEntries ()
 Clear all entries. More...
 
virtual void Update (vtkSMProperty *property)
 Update self based on the "unchecked" values of all required properties. 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 vtkSMEnumerationDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMEnumerationDomainSafeDownCast (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...
 
- 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 ()
 

Protected Attributes

vtkSMEnumerationDomainInternals * EInternals
 
- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 
virtual int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values)
 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. More...
 
 vtkSMEnumerationDomain ()
 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. More...
 
 ~vtkSMEnumerationDomain ()
 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. More...
 

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.
* 

Definition at line 36 of file vtkSMEnumerationDomain.h.

Member Typedef Documentation

§ Superclass

Definition at line 40 of file vtkSMEnumerationDomain.h.

Constructor & Destructor Documentation

§ vtkSMEnumerationDomain()

vtkSMEnumerationDomain::vtkSMEnumerationDomain ( )
protected

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.

§ ~vtkSMEnumerationDomain()

vtkSMEnumerationDomain::~vtkSMEnumerationDomain ( )
protected

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.

Member Function Documentation

§ New()

static vtkSMEnumerationDomain* vtkSMEnumerationDomain::New ( )
static

§ GetClassName()

virtual const char* vtkSMEnumerationDomain::GetClassName ( )
virtual

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMFieldDataDomain, and vtkSMNumberOfComponentsDomain.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMFieldDataDomain, and vtkSMNumberOfComponentsDomain.

§ SafeDownCast()

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

§ PrintSelf()

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

§ IsInDomain() [1/2]

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.

§ IsInDomain() [2/2]

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.

§ GetNumberOfEntries()

unsigned int vtkSMEnumerationDomain::GetNumberOfEntries ( )

Returns the number of entries in the enumeration.

§ GetEntryValue() [1/2]

int vtkSMEnumerationDomain::GetEntryValue ( unsigned int  idx)

Returns the integer value of an enumeration entry.

§ GetEntryText()

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

Returns the descriptive string of an enumeration entry.

§ GetEntryTextForValue()

const char* vtkSMEnumerationDomain::GetEntryTextForValue ( int  value)

Returns the text for an enumeration value.

§ HasEntryText()

int vtkSMEnumerationDomain::HasEntryText ( const char *  text)

Return 1 is the text is present in the enumeration, otherwise 0.

§ GetEntryValueForText()

int vtkSMEnumerationDomain::GetEntryValueForText ( const char *  text)

Get the value for an enumeration text.

The return value is valid only is HasEntryText() returns 1.

§ GetEntryValue() [2/2]

int vtkSMEnumerationDomain::GetEntryValue ( const char *  text,
int &  valid 
)

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.

§ AddEntry()

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

Add a new enumeration entry.

text cannot be null.

§ RemoveAllEntries()

void vtkSMEnumerationDomain::RemoveAllEntries ( )

Clear all entries.

§ Update()

virtual void vtkSMEnumerationDomain::Update ( vtkSMProperty property)
virtual

Update self based on the "unchecked" values of all required properties.

Overwritten by sub-classes.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMFieldDataDomain, and vtkSMNumberOfComponentsDomain.

§ SetDefaultValues()

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

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.

Reimplemented in vtkSMFieldDataDomain.

§ ReadXMLAttributes()

virtual int vtkSMEnumerationDomain::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 vtkSMFieldDataDomain.

§ ChildSaveState()

virtual void vtkSMEnumerationDomain::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.

Member Data Documentation

§ EInternals

vtkSMEnumerationDomainInternals* vtkSMEnumerationDomain::EInternals
protected

Definition at line 131 of file vtkSMEnumerationDomain.h.


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