supports API using vtkDataArraySelection. More...

#include <vtkSIDataArraySelectionProperty.h>

Inheritance diagram for vtkSIDataArraySelectionProperty:

Collaboration diagram for vtkSIDataArraySelectionProperty:

[legend]

Public Types
typedef vtkSIProperty	Superclass

Public Types inherited from vtkSIProperty
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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

virtual char *	GetXMLName ()
	The name assigned by the xml parser. More...

virtual char *	GetCommand ()
	The command name used to set the value on the server object. More...

virtual bool	GetInformationOnly ()
	Is InformationOnly is set to true, this property is used to get information from server instead of setting values. More...

virtual bool	GetRepeatable ()
	If repeatable, a property can have 1 or more values of the same kind. More...

virtual void	SetIsInternal (bool)
	This ivar is configured when the xml file is read and is mainly useful to trigger a method call. More...

virtual bool	GetIsInternal ()
	This ivar is configured when the xml file is read and is mainly useful to trigger a method call. 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 vtkSIDataArraySelectionProperty *	New ()

static int	IsTypeOf (const char *type)

static vtkSIDataArraySelectionProperty *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

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

	~vtkSIDataArraySelectionProperty () override

bool	ReadXMLAttributes (vtkSIProxy proxyhelper, vtkPVXMLElement element) override
	Parse the xml for the property. More...

bool	Push (vtkSMMessage *, int) override
	Push a new state to the underneath implementation. More...

bool	Pull (vtkSMMessage *) override
	Pull the current state of the underneath implementation. More...

vtkDataArraySelection *	GetSelection ()

Protected Member Functions inherited from vtkSIProperty
	vtkSIProperty ()

	~vtkSIProperty () override

vtkSIObject *	GetSIObject (vtkTypeUInt32 globalid)
	Convenience method to obtain a vtkSIObject subclass given its global id. More...

virtual void	SetCommand (const char *)

virtual void	SetXMLName (const char *)

void	SaveValueToCache (vtkSMMessage *proxyStateUpdate, int offset)

bool	ProcessMessage (vtkClientServerStream &stream)
	Interprets the message. More...

const vtkClientServerStream &	GetLastResult ()
	Interprets the message. More...

vtkObjectBase *	GetVTKObject ()
	Interprets the message. More...

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 vtkSIProperty
char *	XMLName

char *	Command

bool	InformationOnly

bool	Repeatable

bool	IsInternal

vtkWeakPointer< vtkSIProxy >	SIProxyObject

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

supports API using vtkDataArraySelection.

vtkSIDataArraySelectionProperty can be used to get/set array selection status parameters on a VTK object using vtkDataArraySelection. Readers typically offer API to get information about data array available as well as enable/disable arrays to read using a vtkDataArraySelection instance e.g. vtkXMLReader::GetPointDataArraySelection. This si-property can be used on vtkSMStringVectorProperty instances that use such an API on the reader to both get array selection status as well as set them.

This offers a convenient replacement for vtkSIArraySelectionProperty which requires a quirky API on the VTK class to get/set similar information and is recommended over vtkSIArraySelectionProperty in new code.

To use vtkSIDataArraySelectionProperty, simply add this as the si_class on the properties for getting and setting array selection with command set to the method name that returns a mutable vtkDataArraySelection instance.

e.g.

 <SourceProxy name="AMReXParticlesReader" class="vtkAMReXParticlesReader">
   ...
   <!-- this is the property to get the status -->
   <StringVectorProperty name="PointArrayInfo"
     command="GetPointDataArraySelection"
     number_of_elements_per_command="2"
     information_only="1"
     si_class="vtkSIDataArraySelectionProperty" />
   <!-- this is the property to set he status -->
   <StringVectorProperty name="PointArrayStatus"
     command="GetPointDataArraySelection"
     information_property="PointArrayInfo"
     number_of_elements_per_command="2"
     element_types="2 0"
     repeat_command="1"
     si_class="vtkSIDataArraySelectionProperty">
     <ArraySelectionDomain name="array_list">
       <RequiredProperties>
         <Property function="ArrayList" name="PointArrayInfo" />
       </RequiredProperties>
     </ArraySelectionDomain>
     <Documentation>Select the point arrays to read load.</Documentation>
   </StringVectorProperty>
   ...
</SourceProxy>

vtkSIDataArraySelectionProperty can also be used for filters that use vtkDataArraySelection.

<SourceProxy class="vtkPassSelectedArrays" name="PassArrays">
   ...
   <InputProperty name="Input" >
     <InputArrayDomain name="point_arrays" attribute_type="point" optional="1" />
   </InputProperty>
   <StringVectorProperty
       name="PointDataArraySelection"
       command="GetPointDataArraySelection"
       number_of_elements_per_command="1"
       repeat_command="1"
       si_class="vtkSIDataArraySelectionProperty">
       <ArrayListDomain name="array_list" input_domain_name="point_arrays">
         <RequiredProperties>
           <Property name="Input" function="Input" />
         </RequiredProperties>
       </ArrayListDomain>
   </StringVectorProperty>
   ...
</SourceProxy>

Definition at line 86 of file vtkSIDataArraySelectionProperty.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSIProperty vtkSIDataArraySelectionProperty::Superclass

Definition at line 90 of file vtkSIDataArraySelectionProperty.h.

Constructor & Destructor Documentation

◆ vtkSIDataArraySelectionProperty()

vtkSIDataArraySelectionProperty::vtkSIDataArraySelectionProperty ( )

protected

◆ ~vtkSIDataArraySelectionProperty()

vtkSIDataArraySelectionProperty::~vtkSIDataArraySelectionProperty ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSIDataArraySelectionProperty* vtkSIDataArraySelectionProperty::New ( )

static

◆ GetClassName()

virtual const char* vtkSIDataArraySelectionProperty::GetClassName ( )

virtual

Reimplemented from vtkSIProperty.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSIProperty.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ ReadXMLAttributes()

bool vtkSIDataArraySelectionProperty::ReadXMLAttributes	(	vtkSIProxy *	proxyhelper,
		vtkPVXMLElement *	element
	)

overrideprotectedvirtual

Parse the xml for the property.

Reimplemented from vtkSIProperty.

◆ Push()

bool vtkSIDataArraySelectionProperty::Push	(	vtkSMMessage *	,
		int
	)

overrideprotectedvirtual

Push a new state to the underneath implementation.

Reimplemented from vtkSIProperty.

◆ Pull()

bool vtkSIDataArraySelectionProperty::Pull ( vtkSMMessage * )

overrideprotectedvirtual

Pull the current state of the underneath implementation.

Reimplemented from vtkSIProperty.

◆ GetSelection()

vtkDataArraySelection* vtkSIDataArraySelectionProperty::GetSelection ( )

protected

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSIDataArraySelectionProperty.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

◆ vtkSIDataArraySelectionProperty()

◆ ~vtkSIDataArraySelectionProperty()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ ReadXMLAttributes()

◆ Push()

◆ Pull()

◆ GetSelection()