vtkTable.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
#ifndef vtkTable_h
#define vtkTable_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDataObject.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALMANUAL

VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractArray;
class vtkDataSetAttributes;
class vtkVariant;
class vtkVariantArray;

class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALMANUAL 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, unsigned int indent = 0);

  int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_TABLE; }

  unsigned long GetActualMemorySize() override;


  vtkGetObjectMacro(RowData, vtkDataSetAttributes);
  virtual void SetRowData(vtkDataSetAttributes* data);

  //
  // Row functions
  //

  vtkIdType GetNumberOfRows();

  void SetNumberOfRows(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;
};

VTK_ABI_NAMESPACE_END
#endif