vtkVariantArray.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkVariantArray.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 vtkVariantArray_h
#define vtkVariantArray_h

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

class vtkVariantArrayLookup;

namespace boost { namespace serialization { class access; } }

class VTKCOMMONCORE_EXPORT 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
  };

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

  //
  // Functions required by vtkAbstractArray
  //

  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000) override;

  void Initialize() override;

  int GetDataType() override;

  int GetDataTypeSize() override;

  int GetElementComponentSize() override;

  void SetNumberOfTuples(vtkIdType number) 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 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 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;

  vtkTypeBool Resize(vtkIdType numTuples) override;


  void SetVoidArray(void *arr, vtkIdType size, int save) override;
  void SetVoidArray(void *arr, vtkIdType size, int save,
                    int deleteM) override;

  unsigned long GetActualMemorySize() override;

  int IsNumeric() override;

  VTK_NEWINSTANCE vtkArrayIterator* NewIterator() override;

  //
  // Additional functions
  //

  vtkVariant & GetValue(vtkIdType id) const;

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

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

  void SetVariantValue(vtkIdType idx, vtkVariant value) override;

  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;

  vtkIdType InsertNextValue(vtkVariant value);

  vtkVariant* GetPointer(vtkIdType id);

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

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

  void SetNumberOfValues(vtkIdType number) override;

  vtkIdType GetNumberOfValues() { return this->MaxId + 1; }


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

  void DataChanged() override;

  virtual void DataElementChanged(vtkIdType id);

  void ClearLookup() override;

  ~vtkVariantArray() override;

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

  // Pointer to data

  vtkVariant* Array;

  // Function to resize data
  vtkVariant* ResizeAndExtend(vtkIdType sz);

  void (*DeleteFunction)(void*);

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

  vtkVariantArrayLookup* Lookup;
  void UpdateLookup();
};

#endif