itkIndexedContainerInterface.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkIndexedContainerInterface.h,v $
  Language:  C++
  Date:      $Date: 2009-02-05 19:04:58 $
  Version:   $Revision: 1.24 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/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 notices for more information.

=========================================================================*/
#ifndef __itkIndexedContainerInterface_h
#define __itkIndexedContainerInterface_h

#include "itkObject.h"

namespace itk
{

template <typename TElementIdentifier, typename TElement>
class IndexedContainerInterface: public Object
{
public:
  typedef IndexedContainerInterface      Self;
  typedef Object                         Superclass;
  typedef SmartPointer<Self>             Pointer;
  typedef SmartPointer<const Self>       ConstPointer;
  
  itkTypeMacro(IndexedContainerInterface, Object);

  typedef TElementIdentifier  ElementIdentifier;
  typedef TElement            Element;
  
  Element& ElementAt(ElementIdentifier);

  Element& CreateElementAt(ElementIdentifier);
  
  Element GetElement(ElementIdentifier) const;
  
  void SetElement(ElementIdentifier, Element);
  
  void InsertElement(ElementIdentifier, Element);
  
  bool IndexExists(ElementIdentifier) const;

  bool GetElementIfIndexExists(ElementIdentifier, Element*) const;
  
  void CreateIndex(ElementIdentifier);

  void DeleteIndex(ElementIdentifier);
  
  class Iterator {}; 

  class ConstIterator {}; 
  
  Iterator Begin();
  
  Iterator End();

  ConstIterator Begin() const;
  
  ConstIterator End() const;

  unsigned long Size(void) const;

  void Reserve(ElementIdentifier);
  
  void Squeeze(void);
  
  void Initialize(void);

};

} // end namespace itk
  
#endif