vtkVariantArray.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 vtkVariantArray_h
#define vtkVariantArray_h

#include "vtkAbstractArray.h"
#include "vtkBuffer.h"           // For vtkBuffer
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkVariant.h"          // For variant type
#include "vtkWrappingHints.h"    // For VTK_MARSHALMANUAL

namespace boost
{
namespace serialization
{
class access;
}
}

VTK_ABI_NAMESPACE_BEGIN
class vtkVariantArrayLookup;

class VTKCOMMONCORE_EXPORT VTK_MARSHALMANUAL vtkVariantArray : public vtkAbstractArray
{

  friend class boost::serialization::access;

public:
  enum DeleteMethod
  {
    VTK_DATA_ARRAY_FREE = vtkAbstractArray::VTK_DATA_ARRAY_FREE,
    VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
    VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
    VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
  };
  using ArrayTypeTag = std::integral_constant<int, vtkArrayTypes::VTK_VARIANT_ARRAY>;
  using DataTypeTag = std::integral_constant<int, VTK_VARIANT>;
  using ValueType = vtkVariant;

  static vtkVariantArray* New();
  static vtkVariantArray* ExtendedNew();
  vtkTypeMacro(vtkVariantArray, vtkAbstractArray);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkVariantArray* FastDownCast(vtkAbstractArray* source);

  //
  // Functions required by vtkAbstractArray
  //

  vtkTypeBool ReserveTuples(vtkIdType numTuples) override;

  bool CopyComponent(int dstComponent, vtkAbstractArray* src, int srcComponent) override;

  int GetArrayType() const override { return vtkVariantArray::ArrayTypeTag::value; }

  int GetDataType() const override;

  int GetDataTypeSize() const override;

  int GetElementComponentSize() const override;

  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;

  void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;

  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;

  void InsertTuplesStartingAt(
    vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;

  void InsertTuples(
    vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;

  vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray* source) override;

  void* GetVoidPointer(vtkIdType id) override;

  void DeepCopy(vtkAbstractArray* da) override;

  void ShallowCopy(vtkAbstractArray* src) override;

  void InterpolateTuple(
    vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;

  void InterpolateTuple(vtkIdType i, vtkIdType id1, vtkAbstractArray* source1, vtkIdType id2,
    vtkAbstractArray* source2, double t) override;

  void Squeeze() override;


  void SetVoidArray(void* array, vtkIdType size, int save) override
  {
    this->SetArray(static_cast<ValueType*>(array), size, save);
  }
  void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override
  {
    this->SetArray(static_cast<ValueType*>(array), size, save, deleteMethod);
  }

  unsigned long GetActualMemorySize() const override;

  int IsNumeric() const override;

  VTK_DEPRECATED_IN_9_7_0("Use vtk::DataArrayValueRange, or the array directly")
  VTK_NEWINSTANCE vtkArrayIterator* NewIterator() override;

  ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const
    VTK_EXPECTS(0 <= tupleIdx && GetNumberOfComponents() * tupleIdx + comp < GetNumberOfValues())
      VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents());


  void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value)
    VTK_EXPECTS(0 <= tupleIdx && GetNumberOfComponents() * tupleIdx + comp < GetNumberOfValues())
      VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents());


  void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
    VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());


  void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
    VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples());

  ValueType& GetValue(vtkIdType id) const;

  void SetValue(vtkIdType id, ValueType value)
    VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());

  void InsertValue(vtkIdType id, ValueType value) VTK_EXPECTS(0 <= id);

  vtkVariant GetVariantValue(vtkIdType idx) override;

  void SetVariantValue(vtkIdType idx, ValueType value) override;

  void InsertVariantValue(vtkIdType idx, ValueType value) override;

  vtkIdType InsertNextValue(ValueType value);

  vtkVariant* GetPointer(vtkIdType id);

#ifdef __VTK_WRAP__
  vtkAbstractBuffer* GetBuffer() { return this->Buffer; }
#else
  vtkBuffer<ValueType>* GetBuffer() { return this->Buffer; }
#endif // __VTK_WRAP__

  void SetArray(ValueType* arr, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);

  void SetArrayFreeFunction(void (*callback)(void*)) override;


  vtkIdType LookupValue(ValueType value) override;
  void LookupValue(ValueType value, vtkIdList* ids) override;

  void DataChanged() override;

  VTK_DEPRECATED_IN_9_7_0("Use DataChanged() instead")
  virtual void DataElementChanged(vtkIdType id);

  void ClearLookup() override;

  ~vtkVariantArray() override;

protected:
  // Construct object with default tuple dimension (number of components) of 1.
  vtkVariantArray();

  bool ReallocateTuples(vtkIdType numTuples);

  bool EnsureAccessToTuple(vtkIdType tupleIdx);

  vtkBuffer<ValueType>* Buffer;

  VTK_DEPRECATED_IN_9_7_0("Use ReserveTuples")
  ValueType* ResizeAndExtend(vtkIdType sz)
  {
    this->ReserveTuples(sz);
    return this->Buffer->GetBuffer();
  }

private:
  vtkVariantArray(const vtkVariantArray&) = delete;
  void operator=(const vtkVariantArray&) = delete;

  vtkVariantArrayLookup* Lookup;
  void UpdateLookup();
};

// Declare vtkArrayDownCast implementations for vtkVariantArray:
vtkArrayDownCast_FastCastMacro(vtkVariantArray);

VTK_ABI_NAMESPACE_END
#endif