1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
|
/*=========================================================================
Program: Visualization Toolkit
Module: $RCSfile: vtkTable.h,v $
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/*----------------------------------------------------------------------------
Copyright (c) Sandia Corporation
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
----------------------------------------------------------------------------*/
// .NAME vtkTable - A table, which contains similar-typed columns of data
//
// .SECTION Description
// vtkTable is a basic data structure for storing columns of data.
// Internally, columns are stored in a vtkFieldData structure.
// 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).
//
// .SECTION Caveats
// You should use the vtkTable API to change the table data. Performing
// vtkFieldData operations on the object returned by GetFieldData() may
// yield unexpected results. vtkTable does allow the user to set the field
// data using SetFieldData(); 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).
//
// .SECTION Thanks
// Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from
// Sandia National Laboratories for their help in developing this class API.
#ifndef __vtkTable_h
#define __vtkTable_h
#include "vtkDataObject.h"
class vtkAbstractArray;
class vtkVariant;
class vtkVariantArray;
class VTK_FILTERING_EXPORT vtkTable : public vtkDataObject
{
public:
static vtkTable* New();
vtkTypeRevisionMacro(vtkTable, vtkDataObject);
void PrintSelf(ostream &os, vtkIndent indent);
// Description:
// Return what type of dataset this is.
int GetDataObjectType() {return VTK_TABLE;}
// Description:
// Sets the field data for the table.
virtual void SetFieldData(vtkFieldData* data);
//
// Row functions
//
// Description:
// Get the number of rows in the table.
vtkIdType GetNumberOfRows();
// Description:
// Get a row of the table as a vtkVariantArray which has one entry for each column.
vtkVariantArray* GetRow(vtkIdType row);
// Description:
// Set a row of the table with a vtkVariantArray which has one entry for each column.
void SetRow(vtkIdType row, vtkVariantArray* values);
// Description:
// Insert a blank row at the end of the table.
vtkIdType InsertNextBlankRow();
// Description:
// Insert a row specified by a vtkVariantArray. The number of entries in the array
// should match the number of columns in the table.
vtkIdType InsertNextRow(vtkVariantArray* arr);
// Description:
// Delete a row from the table. Rows below the deleted row are shifted up.
void RemoveRow(vtkIdType row);
//
// Column functions
//
// Description:
// Get the number of columns in the table.
vtkIdType GetNumberOfColumns();
// Description:
// Get the name of a column of the table.
const char* GetColumnName(vtkIdType col);
// Description:
// Get a column of the table by its name.
vtkAbstractArray* GetColumnByName(const char* name);
// Description:
// Get a column of the table by its column index.
vtkAbstractArray* GetColumn(vtkIdType col);
// Description:
// Add a column to the table.
void AddColumn(vtkAbstractArray* arr);
// Description:
// Remove a column from the table by its name.
void RemoveColumnByName(const char* name);
// Description:
// Remove a column from the table by its column index.
void RemoveColumn(vtkIdType col);
//
// Table single entry functions
//
//BTX
// Description:
// Retrieve a value in the table by row and column index as a variant.
vtkVariant GetValue(vtkIdType row, vtkIdType col);
// Description:
// Retrieve a value in the table by row index and column name as a variant.
vtkVariant GetValueByName(vtkIdType row, const char* col);
// Description:
// Set a value in the table by row and column index as a variant.
void SetValue(vtkIdType row, vtkIdType col, vtkVariant value);
// Description:
// Set a value in the table by row index and column name as a variant.
void SetValueByName(vtkIdType row, const char* col, vtkVariant value);
//ETX
// Description:
// Initialize to an empty table.
virtual void Initialize();
// Description:
// Retrieve the table from vtkInformation.
static vtkTable* GetData(vtkInformation* info);
static vtkTable* GetData(vtkInformationVector* v, int i=0);
virtual void ShallowCopy(vtkDataObject* src);
protected:
vtkTable();
~vtkTable() {}
private:
vtkTable(const vtkTable&); // Not implemented
void operator=(const vtkTable&); // Not implemented
vtkIdType Rows;
};
#endif
|