Basic ServerImplementation property used to call a method with no argument on a VTK object. More...

#include <vtkSIProperty.h>

Inheritance diagram for vtkSIProperty:

[legend]

Collaboration diagram for vtkSIProperty:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

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

	~vtkSIProperty () override

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

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

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

virtual bool	ReadXMLAttributes (vtkSIProxy proxyhelper, vtkPVXMLElement element)
	Parse the xml for the property. 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
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

Friends
class	vtkSIProxy

Detailed Description

Basic ServerImplementation property used to call a method with no argument on a VTK object.

If overridden, we naturally allow to call a method either to set or get a set of values.

Definition at line 36 of file vtkSIProperty.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkSIProperty::Superclass

Definition at line 40 of file vtkSIProperty.h.

Constructor & Destructor Documentation

◆ vtkSIProperty()

vtkSIProperty::vtkSIProperty ( )

protected

◆ ~vtkSIProperty()

vtkSIProperty::~vtkSIProperty ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSIProperty* vtkSIProperty::New ( )

static

◆ GetClassName()

virtual const char* vtkSIProperty::GetClassName ( )

virtual

Reimplemented in vtkSIDataArraySelectionProperty, vtkSIDoubleVectorProperty, vtkSIIdTypeVectorProperty, vtkSIIntVectorProperty, vtkSIIndexSelectionProperty, vtkSIProxyProperty, vtkSIXMLAnimationWriterRepresentationProperty, vtkSIArraySelectionProperty, vtkSIInputProperty, vtkSISILProperty, vtkSIDataArrayProperty, vtkSIDoubleMapProperty, vtkSIStringVectorProperty, vtkSITimeLabelProperty, vtkSITimeRangeProperty, vtkSITimeStepsProperty, and vtkSIVectorProperty.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkSIDataArraySelectionProperty, vtkSIDoubleVectorProperty, vtkSIIdTypeVectorProperty, vtkSIIntVectorProperty, vtkSIIndexSelectionProperty, vtkSIProxyProperty, vtkSIXMLAnimationWriterRepresentationProperty, vtkSIArraySelectionProperty, vtkSIInputProperty, vtkSISILProperty, vtkSIDataArrayProperty, vtkSIDoubleMapProperty, vtkSIStringVectorProperty, vtkSITimeLabelProperty, vtkSITimeRangeProperty, vtkSITimeStepsProperty, and vtkSIVectorProperty.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkSIProxyProperty, vtkSISILProperty, vtkSIStringVectorProperty, vtkSITimeLabelProperty, vtkSITimeRangeProperty, vtkSITimeStepsProperty, vtkSIVectorProperty, and vtkSIVectorPropertyTemplate< T, force_idtype >.

◆ GetXMLName()

virtual char* vtkSIProperty::GetXMLName ( )

virtual

The name assigned by the xml parser.

Used to get the property from a proxy.

◆ GetCommand()

virtual char* vtkSIProperty::GetCommand ( )

virtual

The command name used to set the value on the server object.

For example: SetThetaResolution

◆ GetInformationOnly()

virtual bool vtkSIProperty::GetInformationOnly ( )

virtual

Is InformationOnly is set to true, this property is used to get information from server instead of setting values.

◆ GetRepeatable()

virtual bool vtkSIProperty::GetRepeatable ( )

virtual

If repeatable, a property can have 1 or more values of the same kind.

This ivar is configured when the xml file is read and is mainly useful for information (for example from python).

◆ SetIsInternal()

virtual void vtkSIProperty::SetIsInternal ( bool )

virtual

This ivar is configured when the xml file is read and is mainly useful to trigger a method call.

Internal properties are not saved in state

◆ GetIsInternal()

virtual bool vtkSIProperty::GetIsInternal ( )

virtual

This ivar is configured when the xml file is read and is mainly useful to trigger a method call.

Internal properties are not saved in state

◆ GetSIObject()

vtkSIObject* vtkSIProperty::GetSIObject ( vtkTypeUInt32 globalid )

protected

Convenience method to obtain a vtkSIObject subclass given its global id.

◆ Push()

virtual bool vtkSIProperty::Push	(	vtkSMMessage *	,
		int
	)

protectedvirtual

Push a new state to the underneath implementation.

Reimplemented in vtkSIDataArraySelectionProperty, vtkSIProxyProperty, vtkSIVectorPropertyTemplate< T, force_idtype >, vtkSIInputProperty, vtkSIStringVectorProperty, vtkSIXMLAnimationWriterRepresentationProperty, and vtkSIDoubleMapProperty.

◆ Pull()

virtual bool vtkSIProperty::Pull ( vtkSMMessage * )

protectedvirtual

Pull the current state of the underneath implementation.

Reimplemented in vtkSIDataArraySelectionProperty, vtkSIVectorPropertyTemplate< T, force_idtype >, vtkSIStringVectorProperty, vtkSISILProperty, vtkSIIndexSelectionProperty, vtkSIArraySelectionProperty, vtkSIDataArrayProperty, vtkSITimeLabelProperty, vtkSITimeRangeProperty, and vtkSITimeStepsProperty.

◆ ReadXMLAttributes()

virtual bool vtkSIProperty::ReadXMLAttributes	(	vtkSIProxy *	proxyhelper,
		vtkPVXMLElement *	element
	)

protectedvirtual

Parse the xml for the property.

Reimplemented in vtkSIDataArraySelectionProperty, vtkSIVectorProperty, vtkSIProxyProperty, vtkSIVectorPropertyTemplate< T, force_idtype >, vtkSIStringVectorProperty, vtkSIInputProperty, vtkSISILProperty, and vtkSIDoubleMapProperty.

◆ ProcessMessage()

bool vtkSIProperty::ProcessMessage ( vtkClientServerStream & stream )

protected

Interprets the message.

◆ GetLastResult()

const vtkClientServerStream& vtkSIProperty::GetLastResult ( )

protected

Interprets the message.

◆ GetVTKObject()

vtkObjectBase* vtkSIProperty::GetVTKObject ( )

protected

Interprets the message.

◆ SetCommand()

virtual void vtkSIProperty::SetCommand ( const char * )

protectedvirtual

◆ SetXMLName()

virtual void vtkSIProperty::SetXMLName ( const char * )

protectedvirtual

◆ SaveValueToCache()

void vtkSIProperty::SaveValueToCache	(	vtkSMMessage *	proxyStateUpdate,
		int	offset
	)

protected

Friends And Related Function Documentation

◆ vtkSIProxy

friend class vtkSIProxy

friend

Definition at line 90 of file vtkSIProperty.h.

Member Data Documentation

◆ XMLName

char* vtkSIProperty::XMLName

protected

Definition at line 122 of file vtkSIProperty.h.

◆ Command

char* vtkSIProperty::Command

protected

Definition at line 125 of file vtkSIProperty.h.

◆ InformationOnly

bool vtkSIProperty::InformationOnly

protected

Definition at line 126 of file vtkSIProperty.h.

◆ Repeatable

bool vtkSIProperty::Repeatable

protected

Definition at line 127 of file vtkSIProperty.h.

◆ IsInternal

bool vtkSIProperty::IsInternal

protected

Definition at line 128 of file vtkSIProperty.h.

◆ SIProxyObject

vtkWeakPointer<vtkSIProxy> vtkSIProperty::SIProxyObject

protected

Definition at line 130 of file vtkSIProperty.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSIProperty()

◆ ~vtkSIProperty()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetXMLName()

◆ GetCommand()

◆ GetInformationOnly()

◆ GetRepeatable()

◆ SetIsInternal()

◆ GetIsInternal()

◆ GetSIObject()

◆ Push()

◆ Pull()

◆ ReadXMLAttributes()

◆ ProcessMessage()

◆ GetLastResult()

◆ GetVTKObject()

◆ SetCommand()

◆ SetXMLName()

◆ SaveValueToCache()

Friends And Related Function Documentation

◆ vtkSIProxy

Member Data Documentation

◆ XMLName

◆ Command

◆ InformationOnly

◆ Repeatable

◆ IsInternal

◆ SIProxyObject