Common/KWCommon/vtkLinkedList.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkLinkedList.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 __vtkLinkedList_h
#define __vtkLinkedList_h

#include "vtkAbstractList.h"

template <class DType> class vtkLinkedListNode;
template <class DType> class vtkLinkedListIterator;

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

public:
  typedef vtkAbstractList<DType> Superclass;
  typedef vtkLinkedListIterator<DType> IteratorType;

  static vtkLinkedList<DType> *New();

  vtkLinkedListIterator<DType> *NewIterator();
  
  int AppendItem(DType a);
  
  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);
      
  int FindItem(DType a, vtkIdType &res);


  int FindItem(DType a, 
               vtkAbstractListCompareFunction(DType, compare), 
               vtkIdType &res);
  
  vtkIdType GetNumberOfItems() const { return this->NumberOfItems; }
  
  vtkIdType GetSize() const { return this->NumberOfItems; }

  void RemoveAllItems();

  int SetSize(vtkIdType ) { return VTK_ERROR; }

  void DebugList();

protected:
  vtkLinkedList() {
    this->Head = 0; this->Tail = 0;
    this->NumberOfItems = 0; 
  }
  virtual ~vtkLinkedList();

  vtkLinkedListNode<DType>* FindNode(vtkIdType i);

  vtkIdType NumberOfItems;
  vtkLinkedListNode<DType> *Head;
  vtkLinkedListNode<DType> *Tail;

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

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

#endif

---