itkVectorContainer.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkVectorContainer.h,v $
  Language:  C++
  Date:      $Date: 2009-03-03 15:11:39 $
  Version:   $Revision: 1.59 $

  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 __itkVectorContainer_h
#define __itkVectorContainer_h

#include "itkObject.h"
#include "itkObjectFactory.h"

#include <utility>
#include <vector>

namespace itk
{

template <
  typename TElementIdentifier,
  typename TElement
  >
class ITK_EXPORT VectorContainer: 
  public Object,
  public std::vector<TElement>
{
public:
  typedef VectorContainer           Self;
  typedef Object                    Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  typedef TElementIdentifier  ElementIdentifier;
  typedef TElement            Element;

private:
  typedef std::vector<Element>                    VectorType;
  typedef typename VectorType::size_type          size_type;  
  typedef typename VectorType::iterator           VectorIterator;
  typedef typename VectorType::const_iterator     VectorConstIterator;

protected:
  VectorContainer():
    Object(), VectorType() {}
  VectorContainer(size_type n):
    Object(), VectorType(n) {}
  VectorContainer(size_type n, const Element& x):
    Object(), VectorType(n, x) {}
  VectorContainer(const Self& r):
    Object(), VectorType(r) {}
  template <typename TInputIterator>
  VectorContainer(TInputIterator first, TInputIterator last):
    Object(), VectorType(first, last) {}

public:

  typedef VectorType                     STLContainerType;
  typedef typename VectorType::size_type VectorContainerSizeType;

  itkNewMacro(Self);

  itkTypeMacro(VectorContainer, Object);

  class Iterator;
  class ConstIterator;

  STLContainerType & CastToSTLContainer() {
     return dynamic_cast<STLContainerType &>(*this); }

  const STLContainerType & CastToSTLConstContainer() const {
     return dynamic_cast<const STLContainerType &>(*this); }

  friend class Iterator;
  friend class ConstIterator;

  class Iterator
    {
    public:
      Iterator() {}
      Iterator(size_type d, const VectorIterator& i): m_Pos(d), m_Iter(i) {}
      Iterator& operator* ()    { return *this; }
      Iterator* operator-> ()   { return this; }
      Iterator& operator++ ()   { ++m_Pos; ++m_Iter; return *this; }
      Iterator operator++ (int) { Iterator temp(*this); ++m_Pos; ++m_Iter; return temp; }
      Iterator& operator-- ()   { --m_Pos; --m_Iter; return *this; }
      Iterator operator-- (int) { Iterator temp(*this); --m_Pos; --m_Iter; return temp; }
      bool operator == (const Iterator& r) const { return m_Iter == r.m_Iter; }
      bool operator != (const Iterator& r) const { return m_Iter != r.m_Iter; }
      bool operator == (const ConstIterator& r) const { return m_Iter == r.m_Iter; }
      bool operator != (const ConstIterator& r) const { return m_Iter != r.m_Iter; }
      
      ElementIdentifier Index(void) const { return static_cast<ElementIdentifier>( m_Pos ); }

      Element& Value(void) const { return *m_Iter; }

    private:
      size_type m_Pos;
      VectorIterator m_Iter;
      friend class ConstIterator;
  };
  
  class ConstIterator
    {
    public:
      ConstIterator() {}
      ConstIterator(size_type d, const VectorConstIterator& i): m_Pos(d), m_Iter(i) {}
      ConstIterator(const Iterator& r) { m_Pos = r.m_Pos; m_Iter = r.m_Iter; }
      ConstIterator& operator* ()    { return *this; }
      ConstIterator* operator-> ()   { return this; }
      ConstIterator& operator++ ()   { ++m_Pos; ++m_Iter; return *this; }
      ConstIterator operator++ (int) { ConstIterator temp(*this); ++m_Pos; ++m_Iter; return temp; }
      ConstIterator& operator-- ()   { --m_Pos; --m_Iter; return *this; }
      ConstIterator operator-- (int) { ConstIterator temp(*this); --m_Pos; --m_Iter; return temp; }
      ConstIterator& operator = (const Iterator& r) { m_Pos = r.m_Pos; m_Iter = r.m_Iter; return *this; }
      bool operator == (const Iterator& r) const { return m_Iter == r.m_Iter; }
      bool operator != (const Iterator& r) const { return m_Iter != r.m_Iter; }
      bool operator == (const ConstIterator& r) const { return m_Iter == r.m_Iter; }
      bool operator != (const ConstIterator& r) const { return m_Iter != r.m_Iter; }
      
      ElementIdentifier Index(void) const { return static_cast<ElementIdentifier>( m_Pos ); }

      const Element& Value(void) const { return *m_Iter; }

    private:
      size_type m_Pos;
      VectorConstIterator m_Iter;
      friend class Iterator;
  };
  
  /* Declare the public interface routines. */
  
  Element& ElementAt(ElementIdentifier);

  const Element& ElementAt(ElementIdentifier) const;

  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);

  ConstIterator Begin(void) const;

  ConstIterator End(void) const;  

  Iterator Begin(void);

  Iterator End(void);  

  unsigned long Size(void) const;

  void Reserve( ElementIdentifier );

  void Squeeze(void);

  void Initialize(void);

};

} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_VectorContainer(_, EXPORT, x, y) namespace itk { \
  _(2(class EXPORT VectorContainer< ITK_TEMPLATE_2 x >)) \
  namespace Templates { typedef VectorContainer< ITK_TEMPLATE_2 x > \
                                                  VectorContainer##y; } \
  }

#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkVectorContainer+-.h"
#endif

#if ITK_TEMPLATE_TXX
# include "itkVectorContainer.txx"
#endif

#endif