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

#include <vtkSMSILDomain.h>

Inheritance diagram for vtkSMSILDomain:

Collaboration diagram for vtkSMSILDomain:

[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
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

vtkGraph *	GetSIL ()
	Get the SIL. More...

int	SetDefaultValues (vtkSMProperty *, bool) override
	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
int	SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
	Since this domain relies on an information only property to get the default status, we override this method to copy the values the info property as the default array selection. More...

Public Member Functions inherited from vtkSMStringListDomain
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 (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...

void	Update (vtkSMProperty *) override
	Update self checking the "unchecked" values of all required properties. More...

void	SetAnimationValue (vtkSMProperty *, int, double) override
	Set the value of an element of a property from the animation editor. More...

virtual char *	GetNoneString ()
	Return the string that is used as "none_string" in XML configuration. More...

virtual void	SetNoneString (const char *)
	Return the string that is used as "none_string" in XML configuration. More...

int	SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
	A vtkSMProperty is often defined with a default value in the XML itself. 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...

vtkSMProperty *	GetProperty ()
	Provides access to the vtkSMProperty on which this domain is hooked up. More...

virtual vtkPVDataInformation *	GetInputDataInformation (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
virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual void	SetSession (vtkSMSession *)
	Get/Set the session on wihch this object exists. More...

virtual vtkSMSession *	GetSession ()
	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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkSMSILDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMSILDomain *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMArraySelectionDomain
static vtkSMArraySelectionDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMArraySelectionDomain *	SafeDownCast (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 vtkSMStringListDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMStringListDomain *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMDomain
static vtkSMDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMDomain *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
int	ReadXMLAttributes (vtkSMProperty prop, vtkPVXMLElement elem) override
	Set the appropriate ivars from the xml element. More...

virtual void	SetSubTree (const char *)

	vtkSMSILDomain ()

	~vtkSMSILDomain () override

Protected Member Functions inherited from vtkSMArraySelectionDomain
	vtkSMArraySelectionDomain ()

	~vtkSMArraySelectionDomain () override

Protected Member Functions inherited from vtkSMStringListDomain
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...

virtual void	SetStrings (const std::vector< std::string > &strings)
	Call to set the strings. More...

const std::vector< std::string > &	GetStrings ()
	Call to set the strings. More...

	vtkSMStringListDomain ()
	A vtkSMProperty is often defined with a default value in the XML itself. More...

	~vtkSMStringListDomain () override
	A vtkSMProperty is often defined with a default value in the XML itself. 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...

vtkSMProperty *	GetRequiredProperty (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 &)

Protected Attributes
char *	SubTree

vtkPVSILInformation *	SIL

vtkIdType	SILTimeStamp

Protected Attributes inherited from vtkSMStringListDomain
char *	NoneString
	Default string always present in this string list. More...

Protected Attributes inherited from vtkSMDomain
char *	XMLName

bool	IsOptional

vtkSMDomainInternals *	Internals

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session
	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

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().

Legacy Warning

While not deprecated, this class exists to support readers that use legacy representation for SIL which used a vtkGraph to represent the SIL. It is recommended that newer code uses vtkSubsetInclusionLattice (or subclass) to represent the SIL. In that case, you should use vtkSMSubsetInclusionLatticeDomain instead.

Definition at line 48 of file vtkSMSILDomain.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMArraySelectionDomain vtkSMSILDomain::Superclass

Definition at line 52 of file vtkSMSILDomain.h.

Constructor & Destructor Documentation

◆ vtkSMSILDomain()

vtkSMSILDomain::vtkSMSILDomain ( )

protected

◆ ~vtkSMSILDomain()

vtkSMSILDomain::~vtkSMSILDomain ( )

overrideprotected

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
	)

overridevirtual

Reimplemented from vtkSMArraySelectionDomain.

◆ 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()

int vtkSMSILDomain::SetDefaultValues	(	vtkSMProperty *	,
		bool
	)

inlineoverride

Overridden to leave defaults unchanged.

Definition at line 74 of file vtkSMSILDomain.h.

◆ ReadXMLAttributes()

int vtkSMSILDomain::ReadXMLAttributes	(	vtkSMProperty *	prop,
		vtkPVXMLElement *	elem
	)

overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMDomain.

◆ SetSubTree()

virtual void vtkSMSILDomain::SetSubTree ( const char * )

protectedvirtual

Member Data Documentation

◆ SubTree

char* vtkSMSILDomain::SubTree

protected

Definition at line 89 of file vtkSMSILDomain.h.

◆ SIL

vtkPVSILInformation* vtkSMSILDomain::SIL

protected

Definition at line 90 of file vtkSMSILDomain.h.

◆ SILTimeStamp

vtkIdType vtkSMSILDomain::SILTimeStamp

protected

Definition at line 91 of file vtkSMSILDomain.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMSILDomain.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Legacy Warning

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMSILDomain()

◆ ~vtkSMSILDomain()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetSIL()

◆ GetSubTree()

◆ SetDefaultValues()

◆ ReadXMLAttributes()

◆ SetSubTree()

Member Data Documentation

◆ SubTree

◆ SIL

◆ SILTimeStamp