vtkSIProperty Class Reference

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

#include <vtkSIProperty.h>

Inheritance diagram for vtkSIProperty:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
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...

Static Public Member Functions
static vtkSIProperty *	New ()
static int	IsTypeOf (const char *type)
static vtkSIProperty *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkSIProperty ()
	~vtkSIProperty ()
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 Attributes
char *	XMLName
char *	Command
bool	InformationOnly
bool	Repeatable
bool	IsInternal
vtkWeakPointer< vtkSIProxy >	SIProxyObject

Friends
class	vtkSIProxy

Detailed Description

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

If overriden, 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 ( )

protected

Member Function Documentation

New()

static vtkSIProperty* vtkSIProperty::New ( )

static

GetClassName()

virtual const char* vtkSIProperty::GetClassName ( )

virtual

Reimplemented in vtkSIDoubleVectorProperty, vtkSIIdTypeVectorProperty, vtkSIIntVectorProperty, vtkSIIndexSelectionProperty, vtkSIProxyProperty, vtkSIXMLAnimationWriterRepresentationProperty, vtkSIInputProperty, vtkSISILProperty, vtkSIArraySelectionProperty, 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 in vtkSIDoubleVectorProperty, vtkSIIdTypeVectorProperty, vtkSIIntVectorProperty, vtkSIIndexSelectionProperty, vtkSIProxyProperty, vtkSIXMLAnimationWriterRepresentationProperty, vtkSIInputProperty, vtkSISILProperty, vtkSIArraySelectionProperty, vtkSIDataArrayProperty, vtkSIDoubleMapProperty, vtkSIStringVectorProperty, vtkSITimeLabelProperty, vtkSITimeRangeProperty, vtkSITimeStepsProperty, and vtkSIVectorProperty.

SafeDownCast()

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

static

PrintSelf()

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

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

• /builddir/build/BUILD/ParaView-v5.2.0/ParaViewCore/ServerImplementation/Core/vtkSIProperty.h