Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | List of all members
vtkSIStringVectorProperty Class Reference

ServerImplementation Property to deal with String array as method arguments. More...

#include <vtkSIStringVectorProperty.h>

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

Public Types

typedef vtkSIVectorProperty Superclass
 
- Public Types inherited from vtkSIVectorProperty
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
 
- Public Member Functions inherited from vtkSIVectorProperty
void PrintSelf (ostream &os, vtkIndent indent) override
 
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
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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkSIStringVectorPropertyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSIStringVectorPropertySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSIVectorProperty
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)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Types

enum  ElementTypes { INT, DOUBLE, STRING }
 

Protected Member Functions

 vtkSIStringVectorProperty ()
 
 ~vtkSIStringVectorProperty () override
 
bool Push (vtkSMMessage *, int) override
 Push a new state to the underneath implementation. More...
 
bool Pull (vtkSMMessage *) override
 Pull the current state of the underneath implementation. More...
 
bool ReadXMLAttributes (vtkSIProxy *proxyhelper, vtkPVXMLElement *element) override
 Parse the xml for the property. More...
 
- Protected Member Functions inherited from vtkSIVectorProperty
 vtkSIVectorProperty ()
 
 ~vtkSIVectorProperty () override
 
virtual void SetCleanCommand (const char *)
 
virtual void SetSetNumberCommand (const char *)
 
virtual void SetInitialString (const char *)
 
bool ReadXMLAttributes (vtkSIProxy *proxyhelper, vtkPVXMLElement *element) override
 Set the appropriate ivars from the xml element. More...
 
- Protected Member Functions inherited from vtkSIProperty
 vtkSIProperty ()
 
 ~vtkSIProperty () override
 
vtkSIObjectGetSIObject (vtkTypeUInt32 globalid)
 Convenience method to obtain a vtkSIObject subclass given its global id. 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...
 
vtkObjectBaseGetVTKObject ()
 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkSIVectorProperty
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
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

ServerImplementation Property to deal with String array as method arguments.

It also takes care of string encoding on server side.

Definition at line 16 of file vtkSIStringVectorProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 20 of file vtkSIStringVectorProperty.h.

Member Enumeration Documentation

◆ ElementTypes

Enumerator
INT 
DOUBLE 
STRING 

Definition at line 27 of file vtkSIStringVectorProperty.h.

Constructor & Destructor Documentation

◆ vtkSIStringVectorProperty()

vtkSIStringVectorProperty::vtkSIStringVectorProperty ( )
protected

◆ ~vtkSIStringVectorProperty()

vtkSIStringVectorProperty::~vtkSIStringVectorProperty ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSIStringVectorProperty* vtkSIStringVectorProperty::New ( )
static

◆ GetClassName()

virtual const char* vtkSIStringVectorProperty::GetClassName ( )
virtual

Reimplemented from vtkSIVectorProperty.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSIVectorProperty.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSIStringVectorProperty::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkSIProperty.

◆ Push()

bool vtkSIStringVectorProperty::Push ( vtkSMMessage ,
int   
)
overrideprotectedvirtual

Push a new state to the underneath implementation.

Reimplemented from vtkSIProperty.

◆ Pull()

bool vtkSIStringVectorProperty::Pull ( vtkSMMessage )
overrideprotectedvirtual

Pull the current state of the underneath implementation.

Reimplemented from vtkSIProperty.

◆ ReadXMLAttributes()

bool vtkSIStringVectorProperty::ReadXMLAttributes ( vtkSIProxy proxyhelper,
vtkPVXMLElement element 
)
overrideprotectedvirtual

Parse the xml for the property.

Reimplemented from vtkSIProperty.


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