ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkSMIdTypeVectorProperty Class Reference

property representing a vector of integers More...

#include <vtkSMIdTypeVectorProperty.h>

Inheritance diagram for vtkSMIdTypeVectorProperty:
Inheritance graph
[legend]
Collaboration diagram for vtkSMIdTypeVectorProperty:
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 unsigned int GetNumberOfElements ()
virtual void SetNumberOfElements (unsigned int num)
int SetElement (unsigned int idx, vtkIdType value)
int SetElements1 (vtkIdType value0)
int SetElements2 (vtkIdType value0, vtkIdType value1)
int SetElements3 (vtkIdType value0, vtkIdType value1, vtkIdType value2)
vtkIdType GetElement (unsigned int idx)
vtkIdType GetUncheckedElement (unsigned int idx)
void SetUncheckedElement (unsigned int idx, vtkIdType value)
virtual unsigned int GetNumberOfUncheckedElements ()
virtual void Copy (vtkSMProperty *src)
virtual void ClearUncheckedElements ()
int SetElements (const vtkIdType *values)
int SetElements (const vtkIdType *values, unsigned int numValues)
int SetUncheckedElements (const vtkIdType *values)
int SetUncheckedElements (const vtkIdType *values, unsigned int numValues)
virtual int GetArgumentIsArray ()
virtual void SetArgumentIsArray (int)
virtual void ArgumentIsArrayOn ()
virtual void ArgumentIsArrayOff ()

Static Public Member Functions

static vtkSMIdTypeVectorPropertyNew ()
static int IsTypeOf (const char *type)
static vtkSMIdTypeVectorPropertySafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSMIdTypeVectorProperty ()
 ~vtkSMIdTypeVectorProperty ()
virtual void WriteTo (vtkSMMessage *)
virtual void ReadFrom (const vtkSMMessage *, int msg_offset, vtkSMProxyLocator *)
virtual int ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element)
virtual void SetNumberOfUncheckedElements (unsigned int num)
virtual void ResetToDefaultInternal ()
virtual void SaveStateValues (vtkPVXMLElement *propElement)
virtual int SetElementAsString (int idx, const char *value)

Protected Attributes

int ArgumentIsArray

Detailed Description

property representing a vector of integers

vtkSMIdTypeVectorProperty is a concrete sub-class of vtkSMVectorProperty representing a vector of integers (vtkIdType, possibly 64 bit).

See also:
vtkSMVectorProperty vtkSMDoubleVectorProperty vtkSMStringVectorProperty

Definition at line 31 of file vtkSMIdTypeVectorProperty.h.


Constructor & Destructor Documentation

vtkSMIdTypeVectorProperty::vtkSMIdTypeVectorProperty ( ) [protected]
vtkSMIdTypeVectorProperty::~vtkSMIdTypeVectorProperty ( ) [protected]

Member Function Documentation

static vtkSMIdTypeVectorProperty* vtkSMIdTypeVectorProperty::New ( ) [static]

Reimplemented from vtkSMProperty.

virtual const char* vtkSMIdTypeVectorProperty::GetClassName ( ) [virtual]

Reimplemented from vtkSMVectorProperty.

static int vtkSMIdTypeVectorProperty::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkSMVectorProperty.

virtual int vtkSMIdTypeVectorProperty::IsA ( const char *  type) [virtual]

Reimplemented from vtkSMVectorProperty.

static vtkSMIdTypeVectorProperty* vtkSMIdTypeVectorProperty::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkSMVectorProperty.

void vtkSMIdTypeVectorProperty::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkSMVectorProperty.

virtual unsigned int vtkSMIdTypeVectorProperty::GetNumberOfElements ( ) [virtual]

Returns the size of the vector.

Implements vtkSMVectorProperty.

virtual void vtkSMIdTypeVectorProperty::SetNumberOfElements ( unsigned int  num) [virtual]

Sets the size of the vector. If num is larger than the current number of elements, this may cause reallocation and copying.

Implements vtkSMVectorProperty.

int vtkSMIdTypeVectorProperty::SetElement ( unsigned int  idx,
vtkIdType  value 
)

Set the value of 1 element. The vector is resized as necessary. Returns 0 if Set fails either because the property is read only or the value is not in all domains. Returns 1 otherwise.

int vtkSMIdTypeVectorProperty::SetElements ( const vtkIdType values)

Set the values of all elements. The size of the values array has to be equal or larger to the size of the vector. Returns 0 if Set fails either because the property is read only or one or more of the values is not in all domains. Returns 1 otherwise.

int vtkSMIdTypeVectorProperty::SetElements ( const vtkIdType values,
unsigned int  numValues 
)

Set the values of all elements. The size of the values array has to be equal or larger to the size of the vector. Returns 0 if Set fails either because the property is read only or one or more of the values is not in all domains. Returns 1 otherwise.

int vtkSMIdTypeVectorProperty::SetUncheckedElements ( const vtkIdType values)

Sets the values of all the unchecked elements.

int vtkSMIdTypeVectorProperty::SetUncheckedElements ( const vtkIdType values,
unsigned int  numValues 
)

Sets the values of all the unchecked elements.

int vtkSMIdTypeVectorProperty::SetElements1 ( vtkIdType  value0)

Set the value of 1st element. The vector is resized as necessary. Returns 0 if Set fails either because the property is read only or one or more of the values is not in all domains. Returns 1 otherwise.

int vtkSMIdTypeVectorProperty::SetElements2 ( vtkIdType  value0,
vtkIdType  value1 
)

Set the values of the first 2 elements. The vector is resized as necessary. Returns 0 if Set fails either because the property is read only or one or more of the values is not in all domains. Returns 1 otherwise.

int vtkSMIdTypeVectorProperty::SetElements3 ( vtkIdType  value0,
vtkIdType  value1,
vtkIdType  value2 
)

Set the values of the first 3 elements. The vector is resized as necessary. Returns 0 if Set fails either because the property is read only or one or more of the values is not in all domains. Returns 1 otherwise.

vtkIdType vtkSMIdTypeVectorProperty::GetElement ( unsigned int  idx)

Returns the value of 1 element.

vtkIdType vtkSMIdTypeVectorProperty::GetUncheckedElement ( unsigned int  idx)

Returns the value of 1 unchecked element. These are used by domains. SetElement() first sets the value of 1 unchecked element and then calls IsInDomain and updates the value of the corresponding element only if IsInDomain passes.

void vtkSMIdTypeVectorProperty::SetUncheckedElement ( unsigned int  idx,
vtkIdType  value 
)

Set the value of 1 unchecked element. This can be used to check if a value is in all domains of the property. Call this and call IsInDomains().

virtual unsigned int vtkSMIdTypeVectorProperty::GetNumberOfUncheckedElements ( ) [virtual]

Returns the size of unchecked elements. Usually this is the same as the number of elements but can be different before a domain check is performed.

Reimplemented from vtkSMVectorProperty.

virtual int vtkSMIdTypeVectorProperty::GetArgumentIsArray ( ) [virtual]

If ArgumentIsArray is true, multiple elements are passed in as array arguments. For example, 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 array(1, 2) * Invoke obj SetFoo array(3, 4) * Invoke obj
      SetFoo array(5, 6) 
virtual void vtkSMIdTypeVectorProperty::SetArgumentIsArray ( int  ) [virtual]

If ArgumentIsArray is true, multiple elements are passed in as array arguments. For example, 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 array(1, 2) * Invoke obj SetFoo array(3, 4) * Invoke obj
      SetFoo array(5, 6) 
virtual void vtkSMIdTypeVectorProperty::ArgumentIsArrayOn ( ) [virtual]

If ArgumentIsArray is true, multiple elements are passed in as array arguments. For example, 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 array(1, 2) * Invoke obj SetFoo array(3, 4) * Invoke obj
      SetFoo array(5, 6) 
virtual void vtkSMIdTypeVectorProperty::ArgumentIsArrayOff ( ) [virtual]

If ArgumentIsArray is true, multiple elements are passed in as array arguments. For example, 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 array(1, 2) * Invoke obj SetFoo array(3, 4) * Invoke obj
      SetFoo array(5, 6) 
virtual void vtkSMIdTypeVectorProperty::Copy ( vtkSMProperty src) [virtual]

Copy all property values.

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMIdTypeVectorProperty::ClearUncheckedElements ( ) [virtual]

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMIdTypeVectorProperty::WriteTo ( vtkSMMessage ) [protected, virtual]

Let the property write its content into the stream

Reimplemented from vtkSMProperty.

virtual void vtkSMIdTypeVectorProperty::ReadFrom ( const vtkSMMessage ,
int  msg_offset,
vtkSMProxyLocator  
) [protected, virtual]

Let the property read and set its content from the stream

virtual int vtkSMIdTypeVectorProperty::ReadXMLAttributes ( vtkSMProxy parent,
vtkPVXMLElement element 
) [protected, virtual]

Set the appropriate ivars from the xml element.

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMIdTypeVectorProperty::SetNumberOfUncheckedElements ( unsigned int  num) [protected, virtual]

Sets the size of unchecked elements. Usually this is the same as the number of elements but can be different before a domain check is performed.

Reimplemented from vtkSMVectorProperty.

virtual void vtkSMIdTypeVectorProperty::ResetToDefaultInternal ( ) [protected, virtual]

Reimplemented from vtkSMProperty.

virtual void vtkSMIdTypeVectorProperty::SaveStateValues ( vtkPVXMLElement propertyElement) [protected, virtual]

This method must be overiden by concrete class in order to save the real property data

Reimplemented from vtkSMProperty.

virtual int vtkSMIdTypeVectorProperty::SetElementAsString ( int  idx,
const char *  value 
) [protected, virtual]

Generic implementation that use SetElementAsString to push the value the property

Implements vtkSMVectorProperty.


Member Data Documentation

Definition at line 130 of file vtkSMIdTypeVectorProperty.h.


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