ServerSide Property use to set Object array as method argument. More...

#include <vtkSIProxyProperty.h>

Inheritance diagram for vtkSIProxyProperty:

[legend]

Collaboration diagram for vtkSIProxyProperty:

[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

virtual bool	GetNullOnEmpty ()


virtual char *	GetCleanCommand ()
	Command that can be used to remove inputs. More...


virtual char *	GetRemoveCommand ()
	Remove command is the command called to remove the VTK object on the server-side. More...

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

static int	IsTypeOf (const char *type)

static vtkSIProxyProperty *	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 Types
enum	TypeArg { VTK, SMProxy, SIProxy }

Protected Member Functions
	vtkSIProxyProperty ()

	~vtkSIProxyProperty () override

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

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

virtual void	SetNullOnEmpty (bool)

vtkObjectBase *	GetObjectBase (vtkTypeUInt32 globalId)

bool	IsValidNull (vtkTypeUInt32 globalId)

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 bool	Pull (vtkSMMessage *)
	Pull the current state of the underneath implementation. 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 &)

Protected Attributes
bool	NullOnEmpty

TypeArg	ArgumentType

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

char *	CleanCommand
	Command that can be used to remove inputs. More...

virtual void	SetCleanCommand (const char *)
	Command that can be used to remove inputs. More...

char *	RemoveCommand
	Remove command is the command called to remove the VTK object on the server-side. More...

virtual void	SetRemoveCommand (const char *)
	Remove command is the command called to remove the VTK object on the server-side. More...

Detailed Description

ServerSide Property use to set Object array as method argument.

Those object could be either SMProxy instance or their SIProxy instance or the VTK object managed by the SIProxy instance. The type of object is specified inside the XML definition of the property with the attribute argument_type=[VTK, SMProxy, SIProxy].

Definition at line 19 of file vtkSIProxyProperty.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSIProperty vtkSIProxyProperty::Superclass

Definition at line 23 of file vtkSIProxyProperty.h.

Member Enumeration Documentation

◆ TypeArg

enum vtkSIProxyProperty::TypeArg

protected

Enumerator
VTK
SMProxy
SIProxy

Definition at line 91 of file vtkSIProxyProperty.h.

Constructor & Destructor Documentation

◆ vtkSIProxyProperty()

vtkSIProxyProperty::vtkSIProxyProperty ( )

protected

◆ ~vtkSIProxyProperty()

vtkSIProxyProperty::~vtkSIProxyProperty ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSIProxyProperty* vtkSIProxyProperty::New ( )

static

◆ GetClassName()

virtual const char* vtkSIProxyProperty::GetClassName ( )

virtual

Reimplemented from vtkSIProperty.

Reimplemented in vtkSIXMLAnimationWriterRepresentationProperty, and vtkSIInputProperty.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSIProperty.

Reimplemented in vtkSIXMLAnimationWriterRepresentationProperty, and vtkSIInputProperty.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSIProperty.

◆ GetCleanCommand()

virtual char* vtkSIProxyProperty::GetCleanCommand ( )

virtual

Command that can be used to remove inputs.

If set, this command is called before the main Command is called with all the arguments.

◆ GetRemoveCommand()

virtual char* vtkSIProxyProperty::GetRemoveCommand ( )

virtual

Remove command is the command called to remove the VTK object on the server-side.

If set, CleanCommand is ignored. Instead for every proxy that was absent from the proxies previously pushed, the RemoveCommand is invoked.

◆ GetNullOnEmpty()

virtual bool vtkSIProxyProperty::GetNullOnEmpty ( )

virtual

◆ Push()

bool vtkSIProxyProperty::Push	(	vtkSMMessage *	,
		int
	)

overrideprotectedvirtual

Push a new state to the underneath implementation.

Reimplemented from vtkSIProperty.

◆ ReadXMLAttributes()

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

overrideprotectedvirtual

Parse the xml for the property.

Reimplemented from vtkSIProperty.

◆ SetCleanCommand()

virtual void vtkSIProxyProperty::SetCleanCommand ( const char * )

protectedvirtual

Command that can be used to remove inputs.

If set, this command is called before the main Command is called with all the arguments.

◆ SetRemoveCommand()

virtual void vtkSIProxyProperty::SetRemoveCommand ( const char * )

protectedvirtual

Remove command is the command called to remove the VTK object on the server-side.

If set, CleanCommand is ignored. Instead for every proxy that was absent from the proxies previously pushed, the RemoveCommand is invoked.

◆ SetNullOnEmpty()

virtual void vtkSIProxyProperty::SetNullOnEmpty ( bool )

protectedvirtual

◆ GetObjectBase()

vtkObjectBase* vtkSIProxyProperty::GetObjectBase ( vtkTypeUInt32 globalId )

protected

◆ IsValidNull()

bool vtkSIProxyProperty::IsValidNull ( vtkTypeUInt32 globalId )

protected

Member Data Documentation

◆ CleanCommand

char* vtkSIProxyProperty::CleanCommand

protected

Command that can be used to remove inputs.

If set, this command is called before the main Command is called with all the arguments.

Definition at line 70 of file vtkSIProxyProperty.h.

◆ RemoveCommand

char* vtkSIProxyProperty::RemoveCommand

protected

Remove command is the command called to remove the VTK object on the server-side.

If set, CleanCommand is ignored. Instead for every proxy that was absent from the proxies previously pushed, the RemoveCommand is invoked.

Definition at line 81 of file vtkSIProxyProperty.h.

◆ NullOnEmpty

bool vtkSIProxyProperty::NullOnEmpty

protected

Definition at line 88 of file vtkSIProxyProperty.h.

◆ ArgumentType

TypeArg vtkSIProxyProperty::ArgumentType

protected

Definition at line 102 of file vtkSIProxyProperty.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ TypeArg

Constructor & Destructor Documentation

◆ vtkSIProxyProperty()

◆ ~vtkSIProxyProperty()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetCleanCommand()

◆ GetRemoveCommand()

◆ GetNullOnEmpty()

◆ Push()

◆ ReadXMLAttributes()

◆ SetCleanCommand()

◆ SetRemoveCommand()

◆ SetNullOnEmpty()

◆ GetObjectBase()

◆ IsValidNull()

Member Data Documentation

◆ CleanCommand

◆ RemoveCommand

◆ NullOnEmpty

◆ ArgumentType