a domain that uses vtkDataAssembly More...

#include <vtkSMDataAssemblyDomain.h>

Inheritance diagram for vtkSMDataAssemblyDomain:

Collaboration diagram for vtkSMDataAssemblyDomain:

[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

const char *	GetDataAssemblyName () const
	Returns the name for the chosen assembly, if any. More...

vtkDataAssembly *	GetDataAssembly () const
	Provides access to the data assembly. More...

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

int	SetDefaultValues (vtkSMProperty *prop, bool use_unchecked_values) override

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

vtkSMProperty *	GetRequiredProperty (const char *function)
	Returns a given required property of 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...

virtual vtkPVDataInformation *	GetInputDataInformation (const char *function, unsigned int index=0)
	Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...

virtual vtkPVDataInformation *	GetInputSubsetDataInformation (unsigned int compositeIndex, const char *function, unsigned int index=0)
	Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. 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 vtkSMDataAssemblyDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMDataAssemblyDomain *	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 std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...

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

	~vtkSMDataAssemblyDomain () override

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

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 &)

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

a domain that uses vtkDataAssembly

vtkSMDataAssemblyDomain is intended for vtkSMStringVectorProperty that uses vtkDataAssembly to qualify values. For example, the "Paths" property on vtkExtractBlockUsingDataAssembly filter that lets the user select paths to extract uses this domain.

Example usage in a ServerManager XML is as follows:

<SourceProxy ...>
...
  <StringVectorProperty clean_command="ClearNodePaths"
                     command="AddNodePath"
                     name="Paths"
                     number_of_elements_per_command="1"
                     panel_visibility="default"
                     repeat_command="1"
                     animateable="0">
    <DataAssemblyDomain name="data_assembly" (optional)entity_type=3>
      <RequiredProperties>
        <Property function="Input" name="Input" />
      </RequiredProperties>
    </DataAssemblyDomain>
    <Documentation>
      This property lists the paths for blocks to extract.
    </Documentation>
  </StringVectorProperty>
</SourceProxy>

vtkSMDataAssemblyDomain can also be used on readers. In that case, it uses vtkPVDataAssemblyInformation to obtain the data assembly from the reader. The following snippet shows how this domain can be used on a reader. Note, the 'Tag' required property is essential to use this domain on a reader. It is used to determine when to fetch the vtkDataAssembly from the reader.

<SourceProxy ...>
...
  <IntVectorProperty name="AssemblyTag"
    command="GetAssemblyTag"
    information_only="1">
    <Documentation>
      This is simply an int that changes whenever a new assembly is built
      by the reader. This can be used to determine if the assembly should be fetched from
      the reader whenever the reader is updated.
    </Documentation>
  </IntVectorProperty>
  <StringVectorProperty name="AssemmblySelectors"
    command="AddSelector"
    clean_command="ClearSelectors"
    repeat_command="1"
    number_of_elements_per_command="1"
    panel_widget="data_assembly_editor" >
    <DataAssemblyDomain name="data_assembly">
      <RequiredProperties>
        <Property function="Tag" name="AssemblyTag" />
      </RequiredProperties>
    </DataAssemblyDomain>
    <Documentation>
      Specify the selectors for the data assembly chosen using **Assembly**
      to choose the blocks to extract from the input dataset.
    </Documentation>
    <Hints>
      <!-- AssemblyTag == 0 implies there's no assembly in the file,
      in which case, we want to hide this widget entirely -->
      <PropertyWidgetDecorator type="GenericDecorator"
        mode="visibility"
        property="AssemblyTag"
        value="0"
        inverse="1" />
    </Hints>
  </StringVectorProperty>
</SourceProxy>

Definition at line 96 of file vtkSMDataAssemblyDomain.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMDomain vtkSMDataAssemblyDomain::Superclass

Definition at line 100 of file vtkSMDataAssemblyDomain.h.

Constructor & Destructor Documentation

◆ vtkSMDataAssemblyDomain()

vtkSMDataAssemblyDomain::vtkSMDataAssemblyDomain ( )

protected

◆ ~vtkSMDataAssemblyDomain()

vtkSMDataAssemblyDomain::~vtkSMDataAssemblyDomain ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMDataAssemblyDomain* vtkSMDataAssemblyDomain::New ( )

static

◆ GetClassName()

virtual const char* vtkSMDataAssemblyDomain::GetClassName ( )

virtual

Reimplemented from vtkSMDomain.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMDomain.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ GetDataAssemblyName()

const char* vtkSMDataAssemblyDomain::GetDataAssemblyName ( ) const

inline

Returns the name for the chosen assembly, if any.

Definition at line 106 of file vtkSMDataAssemblyDomain.h.

◆ GetDataAssembly()

vtkDataAssembly* vtkSMDataAssemblyDomain::GetDataAssembly ( ) const

Provides access to the data assembly.

◆ Update()

void vtkSMDataAssemblyDomain::Update ( vtkSMProperty * requestingProperty )

overridevirtual

Update self based on the "unchecked" values of all required properties.

Subclasses must override this method to update the domain based on the requestingProperty (and/or other required properties).

Reimplemented from vtkSMDomain.

◆ SetDefaultValues()

int vtkSMDataAssemblyDomain::SetDefaultValues	(	vtkSMProperty *	prop,
		bool	use_unchecked_values
	)

override

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMDataAssemblyDomain()

◆ ~vtkSMDataAssemblyDomain()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetDataAssemblyName()

◆ GetDataAssembly()

◆ Update()

◆ SetDefaultValues()