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

is a specialization for vtkSMArraySelectionDomain with access to the SIL. More...

#include <vtkSMSILDomain.h>

Inheritance diagram for vtkSMSILDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMSILDomain:
Collaboration graph
[legend]

Public Types

typedef vtkSMArraySelectionDomain Superclass
 
- Public Types inherited from vtkSMArraySelectionDomain
typedef vtkSMStringListDomain Superclass
 
- Public Types inherited from vtkSMStringListDomain
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)
 
vtkGraph * GetSIL ()
 Get the SIL. More...
 
virtual int SetDefaultValues (vtkSMProperty *, bool)
 Overridden to leave defaults unchanged. More...
 
virtual char * GetSubTree ()
 Provide an access to the subtree attribute from the XML definition of the sub-domaine. More...
 
- Public Member Functions inherited from vtkSMArraySelectionDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkSMStringListDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsInDomain (vtkSMProperty *property)
 Returns true if the value of the property is in the domain. More...
 
int IsInDomain (const char *string, unsigned int &idx)
 Returns true if the string is in the domain. More...
 
const char * GetString (unsigned int idx)
 Returns a string in the domain. More...
 
unsigned int GetNumberOfStrings ()
 Returns the number of strings in the domain. More...
 
virtual void Update (vtkSMProperty *)
 Update self checking the "unchecked" values of all required properties. More...
 
virtual void SetAnimationValue (vtkSMProperty *, int, double)
 Set the value of an element of a property from the animation editor. 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 vtkSMSILDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSILDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMArraySelectionDomain
static vtkSMArraySelectionDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMArraySelectionDomainSafeDownCast (vtkObject *o)
 
static void SetLoadAllVariables (bool choice)
 Global flag to toggle between (a) the default behavior of setting default values according to infoProperty and (b) setting all default values to on. More...
 
static bool GetLoadAllVariables ()
 
- Static Public Member Functions inherited from vtkSMStringListDomain
static vtkSMStringListDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMStringListDomainSafeDownCast (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 *elem)
 Set the appropriate ivars from the xml element. More...
 
virtual void SetSubTree (const char *)
 
 vtkSMSILDomain ()
 
 ~vtkSMSILDomain ()
 
- Protected Member Functions inherited from vtkSMArraySelectionDomain
 vtkSMArraySelectionDomain ()
 
 ~vtkSMArraySelectionDomain ()
 
- Protected Member Functions inherited from vtkSMStringListDomain
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 SetStrings (const std::vector< vtkStdString > &strings)
 Call to set the strings. More...
 
const std::vector< vtkStdString > & GetStrings ()
 Call to set the strings. More...
 
 vtkSMStringListDomain ()
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
 ~vtkSMStringListDomain ()
 A vtkSMProperty is often defined with a default value in the XML itself. 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

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

Additional Inherited Members

- Static Protected Attributes inherited from vtkSMArraySelectionDomain
static bool LoadAllVariables
 

Detailed Description

is a specialization for vtkSMArraySelectionDomain with access to the SIL.

vtkSMSILDomain is basically a vtkSMArraySelectionDomain with a method to access the SIL. Having a separate domain also makes it possible to automatically create SIL widgets in the GUI.

vtkSMSILDomain needs a required property with function="ArrayList" which is typically an information property with the array selection statuses (exactly similar to vtkSMArraySelectionDomain) with one notable exception. This information property typically uses the vtkSMSILInformationHelper which is used to access the SIL if requested by using GetSIL().

Definition at line 40 of file vtkSMSILDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkSMSILDomain.h.

Constructor & Destructor Documentation

◆ vtkSMSILDomain()

vtkSMSILDomain::vtkSMSILDomain ( )
protected

◆ ~vtkSMSILDomain()

vtkSMSILDomain::~vtkSMSILDomain ( )
protected

Member Function Documentation

◆ New()

static vtkSMSILDomain* vtkSMSILDomain::New ( )
static

◆ GetClassName()

virtual const char* vtkSMSILDomain::GetClassName ( )
virtual

Reimplemented from vtkSMArraySelectionDomain.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMArraySelectionDomain.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ GetSIL()

vtkGraph* vtkSMSILDomain::GetSIL ( )

Get the SIL.

This does not result in the re-fetching of the SIL, it simply returns the most recently fetched SIL. To re-fetch the SIL, try calling UpdatePropertyInformation() on the reader proxy. That will result in requesting the vtkSMSILInformationHelper to fetch the SIL.

◆ GetSubTree()

virtual char* vtkSMSILDomain::GetSubTree ( )
virtual

Provide an access to the subtree attribute from the XML definition of the sub-domaine.

◆ SetDefaultValues()

virtual int vtkSMSILDomain::SetDefaultValues ( vtkSMProperty ,
bool    
)
inlinevirtual

Overridden to leave defaults unchanged.

Reimplemented from vtkSMArraySelectionDomain.

Definition at line 66 of file vtkSMSILDomain.h.

◆ ReadXMLAttributes()

virtual int vtkSMSILDomain::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement elem 
)
protectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMStringListDomain.

◆ SetSubTree()

virtual void vtkSMSILDomain::SetSubTree ( const char *  )
protectedvirtual

Member Data Documentation

◆ SubTree

char* vtkSMSILDomain::SubTree
protected

Definition at line 81 of file vtkSMSILDomain.h.

◆ SIL

vtkPVSILInformation* vtkSMSILDomain::SIL
protected

Definition at line 82 of file vtkSMSILDomain.h.

◆ SILTimeStamp

vtkIdType vtkSMSILDomain::SILTimeStamp
protected

Definition at line 83 of file vtkSMSILDomain.h.


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