FreeMat: vtkShortArray

FreeMat

- Main Page
- Related Pages

vtkShortArray

Section: Visualization Toolkit Common Classes

# Usage

vtkShortArray is an array of values of type short. It provides methods for insertion and retrieval of values and will automatically resize itself to hold new data.

To create an instance of class vtkShortArray, simply invoke its constructor as follows

      obj = vtkShortArray

# Methods

The class vtkShortArray has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, `obj` is an instance of the vtkShortArray class.

- `string = obj.GetClassName ()`
- `int = obj.IsA (string name)`
- `vtkShortArray = obj.NewInstance ()`
- `vtkShortArray = obj.SafeDownCast (vtkObject o)`
- `int = obj.GetDataType ()` - Copy the tuple value into a user-provided array.
- `obj.GetTupleValue (vtkIdType i, short tuple)` - Set the tuple value at the ith location in the array.
- `obj.SetTupleValue (vtkIdType i, short tuple)` - Insert (memory allocation performed) the tuple into the ith location in the array.
- `obj.InsertTupleValue (vtkIdType i, short tuple)` - Insert (memory allocation performed) the tuple onto the end of the array.
- `vtkIdType = obj.InsertNextTupleValue (short tuple)` - Get the data at a particular index.
- `short = obj.GetValue (vtkIdType id)` - Set the data at a particular index. Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.
- `obj.SetValue (vtkIdType id, short value)` - Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for fast insertion.
- `obj.SetNumberOfValues (vtkIdType number)` - Insert data at a specified position in the array.
- `obj.InsertValue (vtkIdType id, short f)` - Insert data at the end of the array. Return its location in the array.
- `vtkIdType = obj.InsertNextValue (short f)` - Get the address of a particular data index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.
- `obj.SetArray (short array, vtkIdType size, int save)` - This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array.
- `obj.SetArray (short array, vtkIdType size, int save, int deleteMethod)`