Common/KWCommon/vtkVector.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkVector.h,v $

  Copyright (c) Kitware, Inc.
  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 __vtkVector_h
#define __vtkVector_h

#include "vtkAbstractList.h"

extern "C" 
{ 
  typedef int (*vtkVectorSortFunctionType)(const void *, const void *);
}

template <class DType> class vtkVectorIterator;

template <class DType>
class vtkVector : public vtkAbstractList<DType>
{
  friend class vtkVectorIterator<DType>;
  virtual const char* GetClassNameInternal() const { return "vtkVector"; }

public:
  typedef vtkAbstractList<DType> Superclass;
  typedef vtkVectorIterator<DType> IteratorType;
  
  static vtkVector<DType> *New();

  vtkVectorIterator<DType> *NewIterator();
  
  int AppendItem(DType a);
  
  void CopyItems(vtkVector<DType> *in);

  int PrependItem(DType a);
  
  int InsertItem(vtkIdType loc, DType a);
  
  int SetItem(vtkIdType loc, DType a);

  void SetItemNoCheck(vtkIdType loc, DType a);

  int RemoveItem(vtkIdType id);
  
  int GetItem(vtkIdType id, DType& ret);
      
  void GetItemNoCheck(vtkIdType id, DType& ret);
      
  int FindItem(DType a, vtkIdType &res);


  int FindItem(DType a, 
               vtkAbstractListCompareFunction(DType, compare), 
               vtkIdType &res);
  
  int IsItemPresent(DType a);

  vtkIdType GetNumberOfItems() const { return this->NumberOfItems; }
  
  vtkIdType GetSize() const { return this->Size; }

  void RemoveAllItems();

  int SetSize(vtkIdType size);


  void SetResize(int r) { this->Resize = r; }
  void ResizeOn() { this->SetResize(1); }
  void ResizeOff() { this->SetResize(0); }
  int GetResize() const { return this->Resize; }

  void DebugList();

  void Sort(vtkVectorSortFunctionType);

protected:
  vtkVector() {
    this->Array = 0; this->NumberOfItems = 0; this->Size = 0; 
    this->Resize = 1; }
  virtual ~vtkVector();
  vtkIdType NumberOfItems;
  vtkIdType Size;
  int Resize;
  DType *Array;

private:
  vtkVector(const vtkVector<DType>&); // Not implemented
  void operator=(const vtkVector<DType>&); // Not implemented
};

#ifdef VTK_NO_EXPLICIT_TEMPLATE_INSTANTIATION
#include "vtkVector.txx"
#endif 

#endif

---