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;

//BTX
namespace boost { namespace serialization { class access; } }
//ETX

class VTKCOMMONCORE_EXPORT vtkVariantArray : public vtkAbstractArray
{
//BTX
  friend class boost::serialization::access;
//ETX

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

  //
  // Functions required by vtkAbstractArray
  //

  virtual int Allocate(vtkIdType sz, vtkIdType ext=1000);

  virtual void Initialize();

  virtual int GetDataType();

  virtual int GetDataTypeSize();

  virtual int GetElementComponentSize();

  virtual void SetNumberOfTuples(vtkIdType number);

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

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


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


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

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

  virtual void *GetVoidPointer(vtkIdType id);

  virtual void DeepCopy(vtkAbstractArray *da);


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


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

  virtual void Squeeze();

  virtual int Resize(vtkIdType numTuples);


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

  virtual unsigned long GetActualMemorySize();

  virtual int IsNumeric();

  virtual vtkArrayIterator* NewIterator();

  //
  // Additional functions
  //

  vtkVariant & GetValue(vtkIdType id) const;

  void SetValue(vtkIdType id, vtkVariant value);

  void InsertValue(vtkIdType id, vtkVariant value);

  void SetVariantValue(vtkIdType idx, vtkVariant value);

  void InsertVariantValue(vtkIdType idx, vtkVariant value);

  vtkIdType InsertNextValue(vtkVariant value);

  //BTX
  vtkVariant* GetPointer(vtkIdType id);


  void SetArray(vtkVariant* arr, vtkIdType size, int save);
  //ETX

  void SetNumberOfValues(vtkIdType number);

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


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

  virtual void DataChanged();

  virtual void DataElementChanged(vtkIdType id);

  virtual void ClearLookup();

  ~vtkVariantArray();

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

  // Pointer to data
  //BTX
  vtkVariant* Array;

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

  int SaveUserArray;

private:
  vtkVariantArray(const vtkVariantArray&);  // Not implemented.
  void operator=(const vtkVariantArray&);  // Not implemented.

  vtkVariantArrayLookup* Lookup;
  void UpdateLookup();
};

#endif