Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | 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
enum  IsInDomainReturnCodes { NOT_APPLICABLE = -1, NOT_IN_DOMAIN = 0, IN_DOMAIN = 1 }
 Return values for IsInDomain calls. More...
 
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) override
 
int IsInDomain (vtkSMProperty *property) override
 Returns true if the value of the property 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...
 
const char * GetInfoText (unsigned int idx)
 Returns the info text for an enumeration entry. More...
 
void AddEntry (const char *text, int value, const char *info=nullptr)
 Add a new enumeration entry. More...
 
void RemoveAllEntries ()
 Clear all entries. More...
 
void Update (vtkSMProperty *property) override
 Update self based on the "unchecked" values of all required properties. More...
 
- Public Member Functions inherited from vtkSMDomain
virtual int IsInDomain (vtkSMProperty *vtkNotUsed(property))
 Is the (unchecked) value of the property in the domain? Overwritten by sub-classes. More...
 
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 vtkPVDataInformationGetInputDataInformation (const char *function, unsigned int index=0)
 Helper method to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...
 
virtual unsigned int GetNumberOfInputConnections (const char *function)
 Helper method to get the number of input connections hence the number of available vtkPVDataInformation from input proxy connected to the required property with the given function. 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) override
 
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 vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSMEnumerationDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMEnumerationDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDomain
static vtkSMDomainNew ()
 
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)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) override
 Set the appropriate ivars from the xml element. More...
 
void ChildSaveState (vtkPVXMLElement *domainElement) override
 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 () override
 
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...
 
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 () override
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 
int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
 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 () override
 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...
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

list of integers with associated strings

vtkSMEnumerationDomain represents an enumeration of integer values with associated descriptive strings.

A typical enumeration domain is described as follows in the servermanager configuration xmls.

<IntVectorProperty ...>
<EnumerationDomain name="enum">
<Entry text="PNG" value="0"/>
<Entry text="JPEG" value="1"/>
...
</EnumerationDomain>
</IntVectorProperty>

Where, value is the integral value to use to set the element on the property and text is the descriptive text used in UI and Python script.

Starting with ParaView 5.5, the info attribute is supported on an Entry The value is an additional qualifier for the entry that used in UI to explain the item e.g.

<IntVectorProperty name="Quality">
<EnumerationDomain name="enum">
<Entry text="one" value="0" info="no compression" />
...
<Entry text="ten" value="10" info="max compression" />
...
</EnumerationDomain>
</IntVectorProperty>*

If info is specified and non-empty, then the UI will show that text in the combo-box rendered in addition to the text. info has no effect on the Python API i.e.

# either of the following is acceptable, note how `info` has no effect.
writer.Quality = "ten"
# or
writer.Quality = 10

Definition at line 79 of file vtkSMEnumerationDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 83 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 ( )
overrideprotected

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 
)
overridevirtual

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMFieldDataDomain, and vtkSMNumberOfComponentsDomain.

◆ IsInDomain() [1/2]

int vtkSMEnumerationDomain::IsInDomain ( vtkSMProperty property)
override

Returns true if the value of the property is in the domain.

The property has to be a vtkSMIntVectorProperty. If all vector values are in the domain, it returns 1. It returns 0 otherwise.

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

◆ GetInfoText()

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

Returns the info text for an enumeration entry.

Parameters
[in]idx- index for the entry (not to confused with value).
Returns
info-text, if non-empty else nullptr.

◆ AddEntry()

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

Add a new enumeration entry.

text cannot be null.

◆ RemoveAllEntries()

void vtkSMEnumerationDomain::RemoveAllEntries ( )

Clear all entries.

◆ Update()

void vtkSMEnumerationDomain::Update ( vtkSMProperty property)
overridevirtual

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

Overwritten by sub-classes.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMFieldDataDomain, and vtkSMNumberOfComponentsDomain.

◆ SetDefaultValues()

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

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.

◆ ReadXMLAttributes()

int vtkSMEnumerationDomain::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement element 
)
overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMFieldDataDomain, and vtkSMNumberOfComponentsDomain.

◆ ChildSaveState()

void vtkSMEnumerationDomain::ChildSaveState ( vtkPVXMLElement domainElement)
overrideprotectedvirtual

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.


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