ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSIVectorProperty Class Reference

Abstract class for SIProperty that hold an array of values. More...

#include <vtkSIVectorProperty.h>

Inheritance diagram for vtkSIVectorProperty:
Inheritance graph
[legend]
Collaboration diagram for vtkSIVectorProperty:
Collaboration graph
[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)
 
virtual char * GetInitialString ()
 
virtual int GetNumberOfElementsPerCommand ()
 If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values. More...
 
virtual bool GetUseIndex ()
 If UseIndex and RepeatCommand are true, the property will add an index integer before each command. More...
 
virtual char * GetCleanCommand ()
 Command that can be used to remove all values. More...
 
virtual char * GetSetNumberCommand ()
 If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter. More...
 
- Public Member Functions inherited from vtkSIProperty
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 int IsTypeOf (const char *type)
 
static vtkSIVectorPropertySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSIProperty
static vtkSIPropertyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSIPropertySafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSIVectorProperty ()
 
 ~vtkSIVectorProperty ()
 
virtual void SetCleanCommand (const char *)
 
virtual void SetSetNumberCommand (const char *)
 
virtual void SetInitialString (const char *)
 
virtual bool ReadXMLAttributes (vtkSIProxy *proxyhelper, vtkPVXMLElement *element)
 Set the appropriate ivars from the xml element. More...
 
- Protected Member Functions inherited from vtkSIProperty
 vtkSIProperty ()
 
 ~vtkSIProperty ()
 
vtkSIObjectGetSIObject (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 void SetCommand (const char *)
 
virtual void SetXMLName (const char *)
 
void SaveValueToCache (vtkSMMessage *proxyStateUpdate, int offset)
 
bool ProcessMessage (vtkClientServerStream &stream)
 Interprets the message. More...
 
const vtkClientServerStreamGetLastResult ()
 Interprets the message. More...
 
vtkObjectBase * GetVTKObject ()
 Interprets the message. More...
 

Protected Attributes

char * SetNumberCommand
 
char * CleanCommand
 
bool UseIndex
 
int NumberOfElementsPerCommand
 
char * InitialString
 
- Protected Attributes inherited from vtkSIProperty
char * XMLName
 
char * Command
 
bool InformationOnly
 
bool Repeatable
 
bool IsInternal
 
vtkWeakPointer< vtkSIProxySIProxyObject
 

Detailed Description

Abstract class for SIProperty that hold an array of values.

Define the array management API

Definition at line 28 of file vtkSIVectorProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 31 of file vtkSIVectorProperty.h.

Constructor & Destructor Documentation

◆ vtkSIVectorProperty()

vtkSIVectorProperty::vtkSIVectorProperty ( )
protected

◆ ~vtkSIVectorProperty()

vtkSIVectorProperty::~vtkSIVectorProperty ( )
protected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkSIVectorProperty::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ GetNumberOfElementsPerCommand()

virtual int vtkSIVectorProperty::GetNumberOfElementsPerCommand ( )
virtual

If RepeatCommand is true, the command is invoked multiple times, each time with NumberOfElementsPerCommand values.

For example, if RepeatCommand is true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 1 2 3 4 5 6, the resulting stream will have:

* * Invoke obj SetFoo 1 2
* * Invoke obj SetFoo 3 4
* * Invoke obj SetFoo 5 6
* 

◆ GetUseIndex()

virtual bool vtkSIVectorProperty::GetUseIndex ( )
virtual

If UseIndex and RepeatCommand are true, the property will add an index integer before each command.

For example, if UseIndex and RepeatCommand are true, NumberOfElementsPerCommand is 2, the command is SetFoo and the values are 5 6 7 8 9 10, the resulting stream will have:

* * Invoke obj SetFoo 0 5 6
* * Invoke obj SetFoo 1 7 8
* * Invoke obj SetFoo 2 9 10
* 

◆ GetCleanCommand()

virtual char* vtkSIVectorProperty::GetCleanCommand ( )
virtual

Command that can be used to remove all values.

Typically used when RepeatCommand = 1. If set, the clean command is called before the main Command.

◆ GetSetNumberCommand()

virtual char* vtkSIVectorProperty::GetSetNumberCommand ( )
virtual

If SetNumberCommand is set, it is called before Command with the number of arguments as the parameter.

◆ GetInitialString()

virtual char* vtkSIVectorProperty::GetInitialString ( )
virtual

◆ SetCleanCommand()

virtual void vtkSIVectorProperty::SetCleanCommand ( const char *  )
protectedvirtual

◆ SetSetNumberCommand()

virtual void vtkSIVectorProperty::SetSetNumberCommand ( const char *  )
protectedvirtual

◆ SetInitialString()

virtual void vtkSIVectorProperty::SetInitialString ( const char *  )
protectedvirtual

◆ ReadXMLAttributes()

virtual bool vtkSIVectorProperty::ReadXMLAttributes ( vtkSIProxy proxyhelper,
vtkPVXMLElement element 
)
protectedvirtual

Set the appropriate ivars from the xml element.

Reimplemented from vtkSIProperty.

Reimplemented in vtkSIVectorPropertyTemplate< T, force_idtype >, and vtkSIStringVectorProperty.

Member Data Documentation

◆ SetNumberCommand

char* vtkSIVectorProperty::SetNumberCommand
protected

Definition at line 90 of file vtkSIVectorProperty.h.

◆ CleanCommand

char* vtkSIVectorProperty::CleanCommand
protected

Definition at line 93 of file vtkSIVectorProperty.h.

◆ UseIndex

bool vtkSIVectorProperty::UseIndex
protected

Definition at line 94 of file vtkSIVectorProperty.h.

◆ NumberOfElementsPerCommand

int vtkSIVectorProperty::NumberOfElementsPerCommand
protected

Definition at line 95 of file vtkSIVectorProperty.h.

◆ InitialString

char* vtkSIVectorProperty::InitialString
protected

Definition at line 96 of file vtkSIVectorProperty.h.


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