#include <vtkCharArray.h>
vtkCharArray is an array of values of type char. It provides methods for insertion and retrieval of values and will automatically resize itself to hold new data.
Definition at line 39 of file vtkCharArray.h.
Public Types | |
typedef vtkDataArray | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
int | GetDataType () |
void | GetTupleValue (vtkIdType i, char *tuple) |
void | SetTupleValue (vtkIdType i, const char *tuple) |
void | InsertTupleValue (vtkIdType i, const char *tuple) |
vtkIdType | InsertNextTupleValue (const char *tuple) |
char | GetValue (vtkIdType id) |
void | SetValue (vtkIdType id, char value) |
void | SetNumberOfValues (vtkIdType number) |
void | InsertValue (vtkIdType id, char f) |
vtkIdType | InsertNextValue (char f) |
char * | GetValueRange (int comp) |
void | GetValueRange (char range[2], int comp) |
char * | GetValueRange () |
void | GetValueRange (char range[2]) |
char * | WritePointer (vtkIdType id, vtkIdType number) |
char * | GetPointer (vtkIdType id) |
void | SetArray (char *array, vtkIdType size, int save) |
void | SetArray (char *array, vtkIdType size, int save, int deleteMethod) |
Static Public Member Functions | |
static vtkCharArray * | New () |
static int | IsTypeOf (const char *type) |
static vtkCharArray * | SafeDownCast (vtkObject *o) |
static char | GetDataTypeValueMin () |
static char | GetDataTypeValueMax () |
Protected Member Functions | |
vtkCharArray (vtkIdType numComp=1) | |
~vtkCharArray () |
typedef vtkDataArray vtkCharArray::Superclass |
vtkCharArray::vtkCharArray | ( | vtkIdType | numComp = 1 |
) | [protected] |
vtkCharArray::~vtkCharArray | ( | ) | [protected] |
static vtkCharArray* vtkCharArray::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
virtual const char* vtkCharArray::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkDataArray.
static int vtkCharArray::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataArray.
virtual int vtkCharArray::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataArray.
static vtkCharArray* vtkCharArray::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkDataArray.
void vtkCharArray::PrintSelf | ( | ostream & | os, | |
vtkIndent | indent | |||
) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkDataArray.
int vtkCharArray::GetDataType | ( | ) | [inline, virtual] |
void vtkCharArray::GetTupleValue | ( | vtkIdType | i, | |
char * | tuple | |||
) | [inline] |
Copy the tuple value into a user-provided array.
Definition at line 55 of file vtkCharArray.h.
void vtkCharArray::SetTupleValue | ( | vtkIdType | i, | |
const char * | tuple | |||
) | [inline] |
Set the tuple value at the ith location in the array.
Definition at line 61 of file vtkCharArray.h.
void vtkCharArray::InsertTupleValue | ( | vtkIdType | i, | |
const char * | tuple | |||
) | [inline] |
Insert (memory allocation performed) the tuple into the ith location in the array.
Definition at line 68 of file vtkCharArray.h.
vtkIdType vtkCharArray::InsertNextTupleValue | ( | const char * | tuple | ) | [inline] |
Insert (memory allocation performed) the tuple onto the end of the array.
Definition at line 75 of file vtkCharArray.h.
char vtkCharArray::GetValue | ( | vtkIdType | id | ) | [inline] |
Get the data at a particular index.
Definition at line 81 of file vtkCharArray.h.
void vtkCharArray::SetValue | ( | vtkIdType | id, | |
char | value | |||
) | [inline] |
Set the data at a particular index. Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.
Definition at line 88 of file vtkCharArray.h.
void vtkCharArray::SetNumberOfValues | ( | vtkIdType | number | ) | [inline] |
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.
Definition at line 96 of file vtkCharArray.h.
void vtkCharArray::InsertValue | ( | vtkIdType | id, | |
char | f | |||
) | [inline] |
Insert data at a specified position in the array.
Definition at line 102 of file vtkCharArray.h.
vtkIdType vtkCharArray::InsertNextValue | ( | char | f | ) | [inline] |
Insert data at the end of the array. Return its location in the array.
Definition at line 109 of file vtkCharArray.h.
char* vtkCharArray::GetValueRange | ( | int | comp | ) | [inline] |
Get the range of array values for the given component in the native data type.
Definition at line 117 of file vtkCharArray.h.
void vtkCharArray::GetValueRange | ( | char | range[2], | |
int | comp | |||
) | [inline] |
Get the range of array values for the given component in the native data type.
Definition at line 119 of file vtkCharArray.h.
char* vtkCharArray::GetValueRange | ( | ) | [inline] |
Get the range of array values for the 0th component in the native data type.
Definition at line 126 of file vtkCharArray.h.
void vtkCharArray::GetValueRange | ( | char | range[2] | ) | [inline] |
Get the range of array values for the 0th component in the native data type.
Definition at line 128 of file vtkCharArray.h.
static char vtkCharArray::GetDataTypeValueMin | ( | ) | [inline, static] |
Get the minimum data value in its native type.
Definition at line 133 of file vtkCharArray.h.
static char vtkCharArray::GetDataTypeValueMax | ( | ) | [inline, static] |
Get the maximum data value in its native type.
Definition at line 137 of file vtkCharArray.h.
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.
Definition at line 145 of file vtkCharArray.h.
char* vtkCharArray::GetPointer | ( | vtkIdType | id | ) | [inline] |
Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.
Definition at line 152 of file vtkCharArray.h.
void vtkCharArray::SetArray | ( | char * | array, | |
vtkIdType | size, | |||
int | save | |||
) | [inline] |
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.
Definition at line 163 of file vtkCharArray.h.
void vtkCharArray::SetArray | ( | char * | array, | |
vtkIdType | size, | |||
int | save, | |||
int | deleteMethod | |||
) | [inline] |
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.
Definition at line 165 of file vtkCharArray.h.