vtkArray.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 vtkArray_h
#define vtkArray_h
 
#include "vtkArrayCoordinates.h" // for vtkArrayCoordinates
#include "vtkArrayExtents.h"     // for vtkArrayExtents
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkStdString.h" // for vtkStdString
#include "vtkVariant.h"   // for vtkVariant
 
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT vtkArray : public vtkObject
{
public:
  vtkTypeMacro(vtkArray, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  typedef vtkArrayExtents::CoordinateT CoordinateT;
  typedef vtkArrayExtents::DimensionT DimensionT;
  typedef vtkArrayExtents::SizeT SizeT;
 
  enum
  {
    DENSE = 0,
    SPARSE = 1
  };

  VTK_NEWINSTANCE
  static vtkArray* CreateArray(int StorageType, int ValueType);

  virtual bool IsDense() VTK_FUTURE_CONST = 0;


  void Resize(CoordinateT i);
  void Resize(CoordinateT i, CoordinateT j);
  void Resize(CoordinateT i, CoordinateT j, CoordinateT k);
  void Resize(const vtkArrayRange& i);
  void Resize(const vtkArrayRange& i, const vtkArrayRange& j);
  void Resize(const vtkArrayRange& i, const vtkArrayRange& j, const vtkArrayRange& k);
  void Resize(const vtkArrayExtents& extents);

  vtkArrayRange GetExtent(DimensionT dimension);
  virtual const vtkArrayExtents& GetExtents() VTK_FUTURE_CONST = 0;

  DimensionT GetDimensions() VTK_FUTURE_CONST;

  SizeT GetSize() VTK_FUTURE_CONST;

  virtual SizeT GetNonNullSize() VTK_FUTURE_CONST = 0;

  void SetName(const vtkStdString& name);
  vtkStdString GetName() VTK_FUTURE_CONST;

  void SetDimensionLabel(DimensionT i, const vtkStdString& label);

  vtkStdString GetDimensionLabel(DimensionT i) VTK_FUTURE_CONST;

  virtual void GetCoordinatesN(SizeT n, vtkArrayCoordinates& coordinates) VTK_FUTURE_CONST = 0;


  inline vtkVariant GetVariantValue(CoordinateT i);
  inline vtkVariant GetVariantValue(CoordinateT i, CoordinateT j);
  inline vtkVariant GetVariantValue(CoordinateT i, CoordinateT j, CoordinateT k);
  virtual vtkVariant GetVariantValue(const vtkArrayCoordinates& coordinates) = 0;

  virtual vtkVariant GetVariantValueN(SizeT n) = 0;


  inline void SetVariantValue(CoordinateT i, const vtkVariant& value);
  inline void SetVariantValue(CoordinateT i, CoordinateT j, const vtkVariant& value);
  inline void SetVariantValue(CoordinateT i, CoordinateT j, CoordinateT k, const vtkVariant& value);
  virtual void SetVariantValue(const vtkArrayCoordinates& coordinates, const vtkVariant& value) = 0;

  virtual void SetVariantValueN(SizeT n, const vtkVariant& value) = 0;


  virtual void CopyValue(vtkArray* source, const vtkArrayCoordinates& source_coordinates,
    const vtkArrayCoordinates& target_coordinates) = 0;
  virtual void CopyValue(
    vtkArray* source, SizeT source_index, const vtkArrayCoordinates& target_coordinates) = 0;
  virtual void CopyValue(
    vtkArray* source, const vtkArrayCoordinates& source_coordinates, SizeT target_index) = 0;

  virtual VTK_NEWINSTANCE vtkArray* DeepCopy() = 0;
 
protected:
  vtkArray();
  ~vtkArray() override;
 
private:
  vtkArray(const vtkArray&) = delete;
  void operator=(const vtkArray&) = delete;

  vtkStdString Name;

  virtual void InternalResize(const vtkArrayExtents&) = 0;

  virtual void InternalSetDimensionLabel(DimensionT i, const vtkStdString& label) = 0;


  virtual vtkStdString InternalGetDimensionLabel(DimensionT i) VTK_FUTURE_CONST = 0;
};
 
vtkVariant vtkArray::GetVariantValue(CoordinateT i)
{
  return this->GetVariantValue(vtkArrayCoordinates(i));
}
 
vtkVariant vtkArray::GetVariantValue(CoordinateT i, CoordinateT j)
{
  return this->GetVariantValue(vtkArrayCoordinates(i, j));
}
 
vtkVariant vtkArray::GetVariantValue(CoordinateT i, CoordinateT j, CoordinateT k)
{
  return this->GetVariantValue(vtkArrayCoordinates(i, j, k));
}
 
void vtkArray::SetVariantValue(CoordinateT i, const vtkVariant& value)
{
  this->SetVariantValue(vtkArrayCoordinates(i), value);
}
 
void vtkArray::SetVariantValue(CoordinateT i, CoordinateT j, const vtkVariant& value)
{
  this->SetVariantValue(vtkArrayCoordinates(i, j), value);
}
 
void vtkArray::SetVariantValue(CoordinateT i, CoordinateT j, CoordinateT k, const vtkVariant& value)
{
  this->SetVariantValue(vtkArrayCoordinates(i, j, k), value);
}
 
VTK_ABI_NAMESPACE_END
#endif