ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
vtkSIProperty Class Reference

#include <vtkSIProperty.h>

Inheritance diagram for vtkSIProperty:
Inheritance graph
[legend]
Collaboration diagram for vtkSIProperty:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual char * GetXMLName ()
virtual char * GetCommand ()
virtual bool GetInformationOnly ()
virtual bool GetRepeatable ()
virtual void SetIsInternal (bool)
virtual bool GetIsInternal ()

Static Public Member Functions

static vtkSIPropertyNew ()
static int IsTypeOf (const char *type)
static vtkSIPropertySafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSIProperty ()
 ~vtkSIProperty ()
vtkSIObjectGetSIObject (vtkTypeUInt32 globalid)
virtual bool Push (vtkSMMessage *, int)
virtual bool Pull (vtkSMMessage *)
virtual bool ReadXMLAttributes (vtkSIProxy *proxyhelper, vtkPVXMLElement *element)
virtual void SetCommand (const char *)
virtual void SetXMLName (const char *)
void SaveValueToCache (vtkSMMessage *proxyStateUpdate, int offset)
bool ProcessMessage (vtkClientServerStream &stream)
const vtkClientServerStream & GetLastResult ()
vtkObjectBaseGetVTKObject ()

Protected Attributes

char * XMLName
char * Command
bool InformationOnly
bool Repeatable
bool IsInternal
vtkWeakPointer< vtkSIProxySIProxyObject

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 34 of file vtkSIProperty.h.


Constructor & Destructor Documentation

vtkSIProperty::vtkSIProperty ( ) [protected]
vtkSIProperty::~vtkSIProperty ( ) [protected]

Member Function Documentation

static vtkSIProperty* vtkSIProperty::New ( ) [static]
virtual const char* vtkSIProperty::GetClassName ( ) [virtual]
static int vtkSIProperty::IsTypeOf ( const char *  type) [static]
virtual int vtkSIProperty::IsA ( const char *  type) [virtual]
static vtkSIProperty* vtkSIProperty::SafeDownCast ( vtkObject o) [static]
void vtkSIProperty::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]
virtual char* vtkSIProperty::GetXMLName ( ) [virtual]

The name assigned by the xml parser. Used to get the property from a proxy.

virtual char* vtkSIProperty::GetCommand ( ) [virtual]

The command name used to set the value on the server object. For example: SetThetaResolution

virtual bool vtkSIProperty::GetInformationOnly ( ) [virtual]

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

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

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

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

vtkSIObject* vtkSIProperty::GetSIObject ( vtkTypeUInt32  globalid) [protected]

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

virtual bool vtkSIProperty::Push ( vtkSMMessage ,
int   
) [protected, virtual]
virtual bool vtkSIProperty::Pull ( vtkSMMessage ) [protected, virtual]
virtual bool vtkSIProperty::ReadXMLAttributes ( vtkSIProxy proxyhelper,
vtkPVXMLElement element 
) [protected, virtual]
bool vtkSIProperty::ProcessMessage ( vtkClientServerStream &  stream) [protected]

Interprets the message.

const vtkClientServerStream& vtkSIProperty::GetLastResult ( ) [protected]

Interprets the message.

vtkObjectBase* vtkSIProperty::GetVTKObject ( ) [protected]

Interprets the message.

virtual void vtkSIProperty::SetCommand ( const char *  ) [protected, virtual]
virtual void vtkSIProperty::SetXMLName ( const char *  ) [protected, virtual]
void vtkSIProperty::SaveValueToCache ( vtkSMMessage proxyStateUpdate,
int  offset 
) [protected]

Friends And Related Function Documentation

friend class vtkSIProxy [friend]

Member Data Documentation

char* vtkSIProperty::XMLName [protected]

Definition at line 102 of file vtkSIProperty.h.

char* vtkSIProperty::Command [protected]

Definition at line 105 of file vtkSIProperty.h.

Definition at line 106 of file vtkSIProperty.h.

bool vtkSIProperty::Repeatable [protected]

Definition at line 107 of file vtkSIProperty.h.

bool vtkSIProperty::IsInternal [protected]

Definition at line 108 of file vtkSIProperty.h.

Definition at line 110 of file vtkSIProperty.h.


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