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

ServerSide Property use to set vtkOutputPort as method parameter. More...

#include <vtkSIInputProperty.h>

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

Public Types

typedef vtkSIProxyProperty Superclass
 
- Public Types inherited from vtkSIProxyProperty
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 int GetPortIndex ()
 Controls which input port this property uses when making connections. More...
 
- Public Member Functions inherited from vtkSIProxyProperty
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual bool GetNullOnEmpty ()
 
virtual char * GetCleanCommand ()
 Command that can be used to remove inputs. More...
 
virtual char * GetRemoveCommand ()
 Remove command is the command called to remove the VTK object on the server-side. 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 vtkSIInputPropertyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSIInputPropertySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSIProxyProperty
static vtkSIProxyPropertyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSIProxyPropertySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSIProperty
static vtkSIPropertyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSIPropertySafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSIInputProperty ()
 
 ~vtkSIInputProperty ()
 
virtual bool Push (vtkSMMessage *, int)
 Push a new state to the underneath implementation. More...
 
virtual bool ReadXMLAttributes (vtkSIProxy *proxyhelper, vtkPVXMLElement *element)
 Parse the xml for the property. More...
 
virtual void SetPortIndex (int)
 
- Protected Member Functions inherited from vtkSIProxyProperty
 vtkSIProxyProperty ()
 
 ~vtkSIProxyProperty ()
 
virtual void SetNullOnEmpty (bool)
 
vtkObjectBase * GetObjectBase (vtkTypeUInt32 globalId)
 
bool IsValidNull (vtkTypeUInt32 globalId)
 
virtual void SetCleanCommand (const char *)
 Command that can be used to remove inputs. More...
 
virtual void SetRemoveCommand (const char *)
 Remove command is the command called to remove the VTK object on the server-side. 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 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

int PortIndex
 
- Protected Attributes inherited from vtkSIProxyProperty
bool NullOnEmpty
 
TypeArg ArgumentType
 
char * CleanCommand
 Command that can be used to remove inputs. More...
 
char * RemoveCommand
 Remove command is the command called to remove the VTK object on the server-side. More...
 
- Protected Attributes inherited from vtkSIProperty
char * XMLName
 
char * Command
 
bool InformationOnly
 
bool Repeatable
 
bool IsInternal
 
vtkWeakPointer< vtkSIProxySIProxyObject
 

Additional Inherited Members

- Protected Types inherited from vtkSIProxyProperty
enum  TypeArg { VTK, SMProxy, SIProxy }
 

Detailed Description

ServerSide Property use to set vtkOutputPort as method parameter.

For that we need the object on which we should get the Port and its port number.

Definition at line 29 of file vtkSIInputProperty.h.

Member Typedef Documentation

§ Superclass

Definition at line 33 of file vtkSIInputProperty.h.

Constructor & Destructor Documentation

§ vtkSIInputProperty()

vtkSIInputProperty::vtkSIInputProperty ( )
protected

§ ~vtkSIInputProperty()

vtkSIInputProperty::~vtkSIInputProperty ( )
protected

Member Function Documentation

§ New()

static vtkSIInputProperty* vtkSIInputProperty::New ( )
static

§ GetClassName()

virtual const char* vtkSIInputProperty::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ GetPortIndex()

virtual int vtkSIInputProperty::GetPortIndex ( )
virtual

Controls which input port this property uses when making connections.

By default, this is 0.

§ Push()

virtual bool vtkSIInputProperty::Push ( vtkSMMessage ,
int   
)
protectedvirtual

Push a new state to the underneath implementation.

Reimplemented from vtkSIProxyProperty.

Reimplemented in vtkSIXMLAnimationWriterRepresentationProperty.

§ ReadXMLAttributes()

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

Parse the xml for the property.

Reimplemented from vtkSIProxyProperty.

§ SetPortIndex()

virtual void vtkSIInputProperty::SetPortIndex ( int  )
protectedvirtual

Member Data Documentation

§ PortIndex

int vtkSIInputProperty::PortIndex
protected

Definition at line 58 of file vtkSIInputProperty.h.


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