vtkTable.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkTable.h
 
  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 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
#ifndef vtkTable_h
#define vtkTable_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDataObject.h"
 
class vtkAbstractArray;
class vtkDataSetAttributes;
class vtkVariant;
class vtkVariantArray;
 
class VTKCOMMONDATAMODEL_EXPORT vtkTable : public vtkDataObject
{
public:
  static vtkTable* New();
  static vtkTable* ExtendedNew();
  vtkTypeMacro(vtkTable, vtkDataObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void Dump(unsigned int colWidth = 16, int rowLimit = -1);
 
  int GetDataObjectType() override { return VTK_TABLE; }
 
  unsigned long GetActualMemorySize() override;
 
 
  vtkGetObjectMacro(RowData, vtkDataSetAttributes);
  virtual void SetRowData(vtkDataSetAttributes* data);
 
  //
  // Row functions
  //
 
  vtkIdType GetNumberOfRows();
 
  void SetNumberOfRows(const vtkIdType);
 
  void SqueezeRows();
 
  vtkVariantArray* GetRow(vtkIdType row);
 
  void GetRow(vtkIdType row, vtkVariantArray* values);
 
  void SetRow(vtkIdType row, vtkVariantArray* values);
 
  void InsertRow(vtkIdType row);
 
  void InsertRows(vtkIdType row, vtkIdType n);
 
  vtkIdType InsertNextBlankRow(double default_num_val = 0.0);
 
  vtkIdType InsertNextRow(vtkVariantArray* values);
 
  void RemoveRow(vtkIdType row);
 
  void RemoveRows(vtkIdType row, vtkIdType n);
 
  void RemoveAllRows();
 
  //
  // Column functions
  //
 
  vtkIdType GetNumberOfColumns();
 
  // Get the name of a column of the table.
  const char* GetColumnName(vtkIdType col);
 
  vtkAbstractArray* GetColumnByName(const char* name);
 
  vtkIdType GetColumnIndex(const char* name);
 
  vtkAbstractArray* GetColumn(vtkIdType col);
 
  void AddColumn(vtkAbstractArray* arr);
 
  void InsertColumn(vtkAbstractArray* arr, vtkIdType index);
 
  void RemoveColumnByName(const char* name);
 
  void RemoveColumn(vtkIdType col);
 
  void RemoveAllColumns();
 
  //
  // Table single entry functions
  //
 
  vtkVariant GetValue(vtkIdType row, vtkIdType col);
 
  vtkVariant GetValueByName(vtkIdType row, const char* col);
 
  void SetValue(vtkIdType row, vtkIdType col, vtkVariant value);
 
  void SetValueByName(vtkIdType row, const char* col, vtkVariant value);
 
  void Initialize() override;
 
 
  static vtkTable* GetData(vtkInformation* info);
  static vtkTable* GetData(vtkInformationVector* v, int i = 0);
 
 
  void ShallowCopy(vtkDataObject* src) override;
  void DeepCopy(vtkDataObject* src) override;
 
  vtkFieldData* GetAttributesAsFieldData(int type) override;
 
  vtkIdType GetNumberOfElements(int type) override;
 
protected:
  vtkTable();
  ~vtkTable() override;
 
  vtkDataSetAttributes* RowData;
 
  vtkVariantArray* RowArray;
 
  void MoveRowData(vtkIdType first, vtkIdType last, vtkIdType delta);
 
private:
  vtkTable(const vtkTable&) = delete;
  void operator=(const vtkTable&) = delete;
};
 
#endif