domain for block selection properties using a vtkSubsetInclusionLattice. More...

#include <vtkSMSubsetInclusionLatticeDomain.h>

Inheritance diagram for vtkSMSubsetInclusionLatticeDomain:

Collaboration diagram for vtkSMSubsetInclusionLatticeDomain:

Public Types
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

int	IsInDomain (vtkSMProperty *) override
	Returns 1 always. More...

void	Update (vtkSMProperty *requestingProperty) override
	The SIL may have changed. More...

vtkSubsetInclusionLattice *	GetSIL ()
	Returns the vtkSubsetInclusionLattice. More...

int	SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
	Overridden to set default from SIL. More...

Public Member Functions inherited from vtkSMStringListDomain
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	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 vtkSMSubsetInclusionLatticeDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMSubsetInclusionLatticeDomain *	SafeDownCast (vtkObject *o)

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

	~vtkSMSubsetInclusionLatticeDomain ()

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

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

Additional Inherited Members
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

Detailed Description

domain for block selection properties using a vtkSubsetInclusionLattice.

vtkSMSubsetInclusionLatticeDomain is the domain to use for a vtkSMStringVectorProperty permitting uses to select blocks with structure described using vtkSubsetInclusionLattice or subclass.

vtkSMSubsetInclusionLatticeDomain replaces vtkSMSILDomain. vtkSMSILDomain is available for old-style readers that have not been updated to produce vtkSubsetInclusionLattice and instead simply generate a vtkGraph for representing the SIL.

Example Server-Manager configuration XML

 <StringVectorProperty ...>
   <SubsetInclusionLatticeDomain name="sil" class="vtkCGNSSubsetInclusionLattice"
default_path="//Grid">
     <RequiredProperties>
         <Property name="SILUpdateStamp" function="TimeStamp" />
     </RequiredProperties>
   </SubsetInclusionLatticeDomain>
 </StringVectorProperty>

Supported Attributes

vtkSMSubsetInclusionLatticeDomain supports that following attributes that can be specified in the XML configuration for the domain.

class attribute

vtkSubsetInclusionLattice is the default, if not specified. However readers often create subclasses for vtkSubsetInclusionLattice that make it easier to identify nodes in the SIL using native terminology for the file format e.g. vtkCGNSSubsetInclusionLattice. To indicate to the domain to create a specific subclass, one can use the class attribute.

default_path attribute

default_path attribute can be set to a string that defines a path to use to select nodes by default. If not empty, same as calling vtkSubsetInclusionLattice::SelectAll during initialization to pick default block selection state.

Supported required properties.

vtkSubsetInclusionLattice depends on a required property with function TimeStamp which is an information_only property of type vtkSMIdTypeVectorProperty. This property indicates a time-stamp for when the SIL was rebuilt by the reader. This is used to limit fetching of SIL from the server only when it has changed.

See also: vtkSMSILDomain

Definition at line 82 of file vtkSMSubsetInclusionLatticeDomain.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMStringListDomain vtkSMSubsetInclusionLatticeDomain::Superclass

Definition at line 87 of file vtkSMSubsetInclusionLatticeDomain.h.

Constructor & Destructor Documentation

◆ vtkSMSubsetInclusionLatticeDomain()

vtkSMSubsetInclusionLatticeDomain::vtkSMSubsetInclusionLatticeDomain ( )

protected

◆ ~vtkSMSubsetInclusionLatticeDomain()

vtkSMSubsetInclusionLatticeDomain::~vtkSMSubsetInclusionLatticeDomain ( )

protected

Member Function Documentation

◆ New()

static vtkSMSubsetInclusionLatticeDomain* vtkSMSubsetInclusionLatticeDomain::New ( )

static

◆ GetClassName()

virtual const char* vtkSMSubsetInclusionLatticeDomain::GetClassName ( )

virtual

Reimplemented from vtkSMStringListDomain.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMStringListDomain.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMStringListDomain.

◆ IsInDomain()

int vtkSMSubsetInclusionLatticeDomain::IsInDomain ( vtkSMProperty * )

inlineoverride

Returns 1 always.

vtkSMSubsetInclusionLatticeDomain doesn't validate values currently.

Definition at line 94 of file vtkSMSubsetInclusionLatticeDomain.h.

◆ Update()

void vtkSMSubsetInclusionLatticeDomain::Update ( vtkSMProperty * requestingProperty )

overridevirtual

The SIL may have changed.

Update it.

Reimplemented from vtkSMStringListDomain.

◆ GetSIL()

vtkSubsetInclusionLattice* vtkSMSubsetInclusionLatticeDomain::GetSIL ( )

Returns the vtkSubsetInclusionLattice.

May return an empty SIL, but never a nullptr.

◆ SetDefaultValues()

int vtkSMSubsetInclusionLatticeDomain::SetDefaultValues	(	vtkSMProperty *	,
		bool	use_unchecked_values
	)

override

Overridden to set default from SIL.

◆ ReadXMLAttributes()

int vtkSMSubsetInclusionLatticeDomain::ReadXMLAttributes	(	vtkSMProperty *	prop,
		vtkPVXMLElement *	element
	)

overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMStringListDomain.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Example Server-Manager configuration XML

Supported Attributes

class attribute

default_path attribute

Supported required properties.

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMSubsetInclusionLatticeDomain()

◆ ~vtkSMSubsetInclusionLatticeDomain()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ IsInDomain()

◆ Update()

◆ GetSIL()

◆ SetDefaultValues()

◆ ReadXMLAttributes()