restricts the input proxies to one or more data types More...

#include <vtkSMDataTypeDomain.h>

Inheritance diagram for vtkSMDataTypeDomain:

Collaboration diagram for vtkSMDataTypeDomain:

[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 (vtkSMSourceProxy *proxy, int outputport=0)
	Returns true if all parts of the source proxy are in the domain. More...

unsigned int	GetNumberOfDataTypes ()
	Returns the number of acceptable data types. More...

const char *	GetDataTypeName (unsigned int idx)
	Returns a data type. More...

bool	DataTypeHasChildren (unsigned int idx)
	Returns if the data type is composite. More...

const char *	GetDataTypeChildMatchTypeAsString (unsigned int idx)
	Returns if the child match type of a composite data type. More...

const std::vector< std::string > &	GetDataTypeChildren (unsigned int idx)
	Returns the allowed child types of a composite data type. More...

Public Member Functions inherited from vtkSMDomain
void	PrintSelf (ostream &os, vtkIndent indent) override

virtual int	IsInDomain (vtkSMProperty *vtkNotUsed(property))
	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...

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
void	PrintSelf (ostream &os, vtkIndent indent) override

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

static int	IsTypeOf (const char *type)

static vtkSMDataTypeDomain *	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
	vtkSMDataTypeDomain ()

	~vtkSMDataTypeDomain () override

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

virtual void	SetCompositeDataSupported (int)

virtual int	GetCompositeDataSupported ()

virtual void	SetCompositeDataRequired (int)

virtual int	GetCompositeDataRequired ()

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	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 () 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
vtkSMDataTypeDomainInternals *	DTInternals

int	CompositeDataSupported

int	CompositeDataRequired

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

restricts the input proxies to one or more data types

vtkSMDataTypeDomain restricts the input proxies to one or more data types. These data types are specified in the XML with the <DataType> element. VTK class names are used. It is possible to specify a superclass (i.e. vtkDataSet) for a more general domain. Works with vtkSMSourceProxy only. Valid XML elements are:

* * <DataType value=""> where value is the classname for the data type
* for example: vtkDataSet, vtkImageData,...
*

Optional XML attributes for composite datasets only:

child_match : Value can be "any" or "all". This is used if specific types of child datasets are required. "any" indicates that composite datasets with any child matching the nested data types are in the domain. "all" indicates that all the child datasets must match the nested data types(can be mix-match). Example:
<DataType value="vtkCompositeDataSet" child_match="any">
<DataType value="vtkImageData" />
</DataType>
<DataType value="vtkMultiBlockDataSet" child_match="all">
<DataType value="vtkImageData" />
<DataType value="vtkUnstructuredGrid" />
</DataType>
The first element accepts vtkCompositeDataSet with at least one child dataset of vtkImageData. The second element accepts vtkMultiBlockDataSet with all the child datasets being either vtkImageData or vtkUnstructuredGrid.

See also: vtkSMDomain vtkSMSourceProxy

Definition at line 64 of file vtkSMDataTypeDomain.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMDomain vtkSMDataTypeDomain::Superclass

Definition at line 68 of file vtkSMDataTypeDomain.h.

Constructor & Destructor Documentation

◆ vtkSMDataTypeDomain()

vtkSMDataTypeDomain::vtkSMDataTypeDomain ( )

protected

◆ ~vtkSMDataTypeDomain()

vtkSMDataTypeDomain::~vtkSMDataTypeDomain ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMDataTypeDomain* vtkSMDataTypeDomain::New ( )

static

◆ GetClassName()

virtual const char* vtkSMDataTypeDomain::GetClassName ( )

virtual

Reimplemented from vtkSMDomain.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMDomain.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ IsInDomain() [1/2]

int vtkSMDataTypeDomain::IsInDomain ( vtkSMProperty * property )

override

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

The property has to be a vtkSMProxyProperty which points to a vtkSMSourceProxy. If all data types of the input's parts are in the domain, it returns. It returns 0 otherwise.

◆ IsInDomain() [2/2]

int vtkSMDataTypeDomain::IsInDomain	(	vtkSMSourceProxy *	proxy,
		int	outputport = `0`
	)

Returns true if all parts of the source proxy are in the domain.

◆ GetNumberOfDataTypes()

unsigned int vtkSMDataTypeDomain::GetNumberOfDataTypes ( )

Returns the number of acceptable data types.

◆ GetDataTypeName()

const char* vtkSMDataTypeDomain::GetDataTypeName ( unsigned int idx )

Returns a data type.

◆ DataTypeHasChildren()

bool vtkSMDataTypeDomain::DataTypeHasChildren ( unsigned int idx )

Returns if the data type is composite.

◆ GetDataTypeChildMatchTypeAsString()

const char* vtkSMDataTypeDomain::GetDataTypeChildMatchTypeAsString ( unsigned int idx )

Returns if the child match type of a composite data type.

◆ GetDataTypeChildren()

const std::vector<std::string>& vtkSMDataTypeDomain::GetDataTypeChildren ( unsigned int idx )

Returns the allowed child types of a composite data type.

◆ ReadXMLAttributes()

int vtkSMDataTypeDomain::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.

◆ SetCompositeDataSupported()

virtual void vtkSMDataTypeDomain::SetCompositeDataSupported ( int )

protectedvirtual

◆ GetCompositeDataSupported()

virtual int vtkSMDataTypeDomain::GetCompositeDataSupported ( )

protectedvirtual

◆ SetCompositeDataRequired()

virtual void vtkSMDataTypeDomain::SetCompositeDataRequired ( int )

protectedvirtual

◆ GetCompositeDataRequired()

virtual int vtkSMDataTypeDomain::GetCompositeDataRequired ( )

protectedvirtual

Member Data Documentation

◆ DTInternals

vtkSMDataTypeDomainInternals* vtkSMDataTypeDomain::DTInternals

protected

Definition at line 119 of file vtkSMDataTypeDomain.h.

◆ CompositeDataSupported

int vtkSMDataTypeDomain::CompositeDataSupported

protected

Definition at line 121 of file vtkSMDataTypeDomain.h.

◆ CompositeDataRequired

int vtkSMDataTypeDomain::CompositeDataRequired

protected

Definition at line 123 of file vtkSMDataTypeDomain.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMDataTypeDomain()

◆ ~vtkSMDataTypeDomain()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ IsInDomain() [1/2]

◆ IsInDomain() [2/2]

◆ GetNumberOfDataTypes()

◆ GetDataTypeName()

◆ DataTypeHasChildren()

◆ GetDataTypeChildMatchTypeAsString()

◆ GetDataTypeChildren()

◆ ReadXMLAttributes()

◆ SetCompositeDataSupported()

◆ GetCompositeDataSupported()

◆ SetCompositeDataRequired()

◆ GetCompositeDataRequired()

Member Data Documentation

◆ DTInternals

◆ CompositeDataSupported

◆ CompositeDataRequired