vtkTable Class Reference
#include <vtkTable.h>
Detailed Description
A table, which contains similar-typed columns of data.vtkTable is a basic data structure for storing columns of data. Internally, columns are stored in a vtkDataSetAttributes structure called RowData. However, using the vtkTable API additionally ensures that every column has the same number of entries, and provides row access (using vtkVariantArray) and single entry access (using vtkVariant).
The field data inherited from vtkDataObject may be used to store metadata related to the table.
- Warning:
- You should use the vtkTable API to change the table data. Performing operations on the object returned by GetRowData() may yield unexpected results. vtkTable does allow the user to set the field data using SetRowData(); the number of rows in the table is determined by the number of tuples in the first array (it is assumed that all arrays are the same length).
Each column added with AddColumn must have its name set to a unique, non-empty string in order for GetValue() to function properly.
- Thanks:
- Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National Laboratories for their help in developing this class API.
- Examples:
- vtkTable (Examples)
- Tests:
- vtkTable (Tests)
Definition at line 66 of file vtkTable.h.
Member Typedef Documentation
| typedef vtkDataObject vtkTable::Superclass |
Constructor & Destructor Documentation
| vtkTable::vtkTable | ( | ) | [protected] |
| vtkTable::~vtkTable | ( | ) | [protected] |
Member Function Documentation
| static vtkTable* vtkTable::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkDataObject.
| virtual const char* vtkTable::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkDataObject.
| static int vtkTable::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 vtkDataObject.
| virtual int vtkTable::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 vtkDataObject.
Reimplemented from vtkDataObject.
| void vtkTable::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 vtkDataObject.
| void vtkTable::Dump | ( | unsigned int | colWidth = 16 |
) |
Dump table contents.
| int vtkTable::GetDataObjectType | ( | ) | [inline, virtual] |
Return what type of dataset this is.
Reimplemented from vtkDataObject.
Definition at line 77 of file vtkTable.h.
| virtual unsigned long vtkTable::GetActualMemorySize | ( | ) | [virtual] |
Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value).
Reimplemented from vtkDataObject.
| virtual vtkDataSetAttributes* vtkTable::GetRowData | ( | ) | [virtual] |
Get/Set the main data (columns) of the table.
| virtual void vtkTable::SetRowData | ( | vtkDataSetAttributes * | data | ) | [virtual] |
Get/Set the main data (columns) of the table.
| vtkIdType vtkTable::GetNumberOfRows | ( | ) |
Get the number of rows in the table.
| void vtkTable::SetNumberOfRows | ( | const | vtkIdType | ) |
Set the number of rows in the table. Note that memory allocation might be performed as a result of this, but no memory will be released.
| vtkVariantArray* vtkTable::GetRow | ( | vtkIdType | row | ) |
Get a row of the table as a vtkVariantArray which has one entry for each column. NOTE: This version of the method is NOT thread safe.
| void vtkTable::GetRow | ( | vtkIdType | row, | |
| vtkVariantArray * | values | |||
| ) |
Get a row of the table as a vtkVariantArray which has one entry for each column.
| void vtkTable::SetRow | ( | vtkIdType | row, | |
| vtkVariantArray * | values | |||
| ) |
Set a row of the table with a vtkVariantArray which has one entry for each column.
| vtkIdType vtkTable::InsertNextBlankRow | ( | double | default_num_val = 0.0 |
) |
Insert a blank row at the end of the table.
| vtkIdType vtkTable::InsertNextRow | ( | vtkVariantArray * | arr | ) |
Insert a row specified by a vtkVariantArray. The number of entries in the array should match the number of columns in the table.
| void vtkTable::RemoveRow | ( | vtkIdType | row | ) |
Delete a row from the table. Rows below the deleted row are shifted up.
| vtkIdType vtkTable::GetNumberOfColumns | ( | ) |
Get the number of columns in the table.
| const char* vtkTable::GetColumnName | ( | vtkIdType | col | ) |
| vtkAbstractArray* vtkTable::GetColumnByName | ( | const char * | name | ) |
Get a column of the table by its name.
| vtkAbstractArray* vtkTable::GetColumn | ( | vtkIdType | col | ) |
Get a column of the table by its column index.
| void vtkTable::AddColumn | ( | vtkAbstractArray * | arr | ) |
Add a column to the table.
| void vtkTable::RemoveColumnByName | ( | const char * | name | ) |
Remove a column from the table by its name.
| void vtkTable::RemoveColumn | ( | vtkIdType | col | ) |
Remove a column from the table by its column index.
| vtkVariant vtkTable::GetValue | ( | vtkIdType | row, | |
| vtkIdType | col | |||
| ) |
Retrieve a value in the table by row and column index as a variant. Note that this calls GetValueByName internally so that each column array must have its name set (and that name should be unique within the table).
| vtkVariant vtkTable::GetValueByName | ( | vtkIdType | row, | |
| const char * | col | |||
| ) |
Retrieve a value in the table by row index and column name as a variant.
| void vtkTable::SetValue | ( | vtkIdType | row, | |
| vtkIdType | col, | |||
| vtkVariant | value | |||
| ) |
Set a value in the table by row and column index as a variant.
| void vtkTable::SetValueByName | ( | vtkIdType | row, | |
| const char * | col, | |||
| vtkVariant | value | |||
| ) |
Set a value in the table by row index and column name as a variant.
| virtual void vtkTable::Initialize | ( | ) | [virtual] |
Initialize to an empty table.
Reimplemented from vtkDataObject.
| static vtkTable* vtkTable::GetData | ( | vtkInformation * | info | ) | [static] |
Retrieve the table from vtkInformation.
Reimplemented from vtkDataObject.
| static vtkTable* vtkTable::GetData | ( | vtkInformationVector * | v, | |
| int | i = 0 | |||
| ) | [static] |
Retrieve the table from vtkInformation.
Reimplemented from vtkDataObject.
| virtual void vtkTable::ShallowCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow/deep copy the data from src into this object.
Reimplemented from vtkDataObject.
| virtual void vtkTable::DeepCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow/deep copy the data from src into this object.
Reimplemented from vtkDataObject.
| virtual vtkFieldData* vtkTable::GetAttributesAsFieldData | ( | int | type | ) | [virtual] |
Returns the attributes of the data object as a vtkFieldData. This returns non-null values in all the same cases as GetAttributes, in addition to the case of FIELD, which will return the field data for any vtkDataObject subclass.
Reimplemented from vtkDataObject.
| virtual vtkIdType vtkTable::GetNumberOfElements | ( | int | type | ) | [virtual] |
Get the number of elements for a specific attribute type (ROW, etc.).
Reimplemented from vtkDataObject.
Member Data Documentation
vtkDataSetAttributes* vtkTable::RowData [protected] |
Holds the column data of the table.
Definition at line 201 of file vtkTable.h.
vtkVariantArray* vtkTable::RowArray [protected] |
Holds row information returned by GetRow().
Definition at line 204 of file vtkTable.h.
The documentation for this class was generated from the following file:
- dox/Filtering/vtkTable.h
