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

type specific extension to vtkSMRangeDomainTemplate for ints. More...

#include <vtkSMIntRangeDomain.h>

Inheritance diagram for vtkSMIntRangeDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMIntRangeDomain:
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)
 
int GetMinimum (unsigned int idx, int &exists)
 Return a min. More...
 
int GetMaximum (unsigned int idx, int &exists)
 Return a max. More...
 
int GetMinimumExists (unsigned int idx)
 Returns if minimum/maximum bound is set for the domain. More...
 
int GetMaximumExists (unsigned int idx)
 
int GetMinimum (unsigned int idx)
 Returns the minimum/maximum value, is exists, otherwise 0 is returned. More...
 
int GetMaximum (unsigned int idx)
 
- Public Member Functions inherited from vtkSMDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsInDomain (vtkSMProperty *property)=0
 Is the (unchecked) value of the property in the domain? Overwritten by sub-classes. More...
 
virtual void Update (vtkSMProperty *requestingProperty)
 Update self based on the "unchecked" values of all required properties. 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 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 vtkSMIntRangeDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMIntRangeDomainSafeDownCast (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

 vtkSMIntRangeDomain ()
 
 ~vtkSMIntRangeDomain ()
 
- 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...
 
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *elem)
 Set the appropriate ivars from the xml element. 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 ChildSaveState (vtkPVXMLElement *domainElement)
 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 ()
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 

Detailed Description

type specific extension to vtkSMRangeDomainTemplate for ints.

vtkSMIntRangeDomain is a type specific extension to vtkSMRangeDomainTemplate for ints.

Definition at line 39 of file vtkSMIntRangeDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkSMIntRangeDomain.h.

Constructor & Destructor Documentation

◆ vtkSMIntRangeDomain()

vtkSMIntRangeDomain::vtkSMIntRangeDomain ( )
protected

◆ ~vtkSMIntRangeDomain()

vtkSMIntRangeDomain::~vtkSMIntRangeDomain ( )
protected

Member Function Documentation

◆ New()

static vtkSMIntRangeDomain* vtkSMIntRangeDomain::New ( )
static

◆ GetClassName()

virtual const char* vtkSMIntRangeDomain::GetClassName ( )
virtual

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMDimensionsDomain, vtkSMExtentDomain, and vtkSMTimeStepIndexDomain.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMDimensionsDomain, vtkSMExtentDomain, and vtkSMTimeStepIndexDomain.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ GetMinimum() [1/2]

int vtkSMIntRangeDomain::GetMinimum ( unsigned int  idx,
int &  exists 
)
inline

Return a min.

value if it exists. If the min. exists exists is set to 1. Otherwise, it is set to 0. An unspecified min. is equivalent to -inf

Definition at line 54 of file vtkSMIntRangeDomain.h.

◆ GetMaximum() [1/2]

int vtkSMIntRangeDomain::GetMaximum ( unsigned int  idx,
int &  exists 
)
inline

Return a max.

value if it exists. If the max. exists exists is set to 1. Otherwise, it is set to 0. An unspecified max. is equivalent to +inf

Definition at line 64 of file vtkSMIntRangeDomain.h.

◆ GetMinimumExists()

int vtkSMIntRangeDomain::GetMinimumExists ( unsigned int  idx)
inline

Returns if minimum/maximum bound is set for the domain.

Definition at line 72 of file vtkSMIntRangeDomain.h.

◆ GetMaximumExists()

int vtkSMIntRangeDomain::GetMaximumExists ( unsigned int  idx)
inline

Definition at line 76 of file vtkSMIntRangeDomain.h.

◆ GetMinimum() [2/2]

int vtkSMIntRangeDomain::GetMinimum ( unsigned int  idx)
inline

Returns the minimum/maximum value, is exists, otherwise 0 is returned.

Use GetMaximumExists() GetMaximumExists() to make sure that the bound is set.

Definition at line 86 of file vtkSMIntRangeDomain.h.

◆ GetMaximum() [2/2]

int vtkSMIntRangeDomain::GetMaximum ( unsigned int  idx)
inline

Definition at line 87 of file vtkSMIntRangeDomain.h.


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