dox/Common/Core/vtkVoidArray.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkVoidArray.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.

=========================================================================*/
#ifndef __vtkVoidArray_h
#define __vtkVoidArray_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"

class VTKCOMMONCORE_EXPORT vtkVoidArray : public vtkObject
{
public:
  static vtkVoidArray *New();

  vtkTypeMacro(vtkVoidArray,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

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

  void Initialize();

  int GetDataType() {return VTK_VOID;}

  int GetDataTypeSize() { return sizeof(void*); }


  void SetNumberOfPointers(vtkIdType number)
    {this->Allocate(number); this->NumberOfPointers = number;}


  vtkIdType GetNumberOfPointers()
    {return this->NumberOfPointers;}


  void* GetVoidPointer(vtkIdType id)
    {return this->Array[id];}


  void SetVoidPointer(vtkIdType id, void* ptr)
    {this->Array[id] = ptr;}

  void InsertVoidPointer(vtkIdType i, void* ptr);

  vtkIdType InsertNextVoidPointer(void* tuple);


  void Reset()
    {this->NumberOfPointers = 0;}


  void Squeeze()
    {this->ResizeAndExtend (this->NumberOfPointers);}

  void** GetPointer(vtkIdType id) {return this->Array + id;}

  void** WritePointer(vtkIdType id, vtkIdType number);

  void DeepCopy(vtkVoidArray *va);

protected:
  vtkVoidArray();
  ~vtkVoidArray();

  vtkIdType NumberOfPointers;
  vtkIdType Size;
  void**    Array;  // pointer to data

  void** ResizeAndExtend(vtkIdType sz);  // function to resize data

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


#endif