itkMapContainer.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkMapContainer.h,v $
  Language:  C++
  Date:      $Date: 2009-02-05 19:05:01 $
  Version:   $Revision: 1.49 $

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

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

#include <map>

namespace itk
{

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

  itkTypeMacro(MapContainer, Object);

  typedef TElementIdentifier  ElementIdentifier;
  typedef TElement            Element;

private:
  MapContainer(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  typedef std::map<ElementIdentifier, Element>     MapType;
  typedef typename MapType::iterator               MapIterator;
  typedef typename MapType::const_iterator         MapConstIterator;
  typedef typename MapType::key_compare            MapKeyCompareType;

public:
  MapContainer():MapType() {}
  MapContainer(const MapKeyCompareType& comp):MapType(comp) {}
  //  MapContainer(const Self& r):MapType(r) {}
  template <typename TInputIterator>
  MapContainer(TInputIterator first, TInputIterator last):MapType(first, last) {}
  template <typename TInputIterator>
  MapContainer(TInputIterator first, TInputIterator last,const MapKeyCompareType& comp):
    MapType(first, last, comp) {}  

  itkNewMacro(Self);

  typedef MapType STLContainerType;

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

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

  class Iterator;
  class ConstIterator;
  friend class Iterator;
  friend class ConstIterator;

  class Iterator
  {
  public:
    Iterator() {}
    Iterator( const MapIterator& i ): m_Iter(i) {}
    
    Iterator& operator* ()    { return *this; }
    Iterator* operator-> ()   { return this; }
    Iterator& operator++ ()   { ++m_Iter; return *this; }
    Iterator operator++ (int) { Iterator temp(*this);  ++m_Iter; return temp; }
    Iterator& operator-- ()   { --m_Iter; return *this; }
    Iterator operator-- (int) { Iterator temp(*this); --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 m_Iter->first; }

    Element& Value(void) { return m_Iter->second; }
  private:
    MapIterator      m_Iter;
    friend class     ConstIterator;
  };

  class ConstIterator {
  public:
    ConstIterator() {}
    ConstIterator(const MapConstIterator& ci): m_Iter(ci) {}
    ConstIterator(const Iterator& r) { m_Iter = r.m_Iter; }

    ConstIterator& operator* ()    { return *this; }
    ConstIterator* operator-> ()   { return this; }
    ConstIterator& operator++ ()   { ++m_Iter; return *this; }
    ConstIterator operator++ (int) { ConstIterator temp(*this);  ++m_Iter; return temp; }
    ConstIterator& operator-- ()   { --m_Iter; return *this; }
    ConstIterator operator-- (int) { ConstIterator temp(*this); --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 m_Iter->first; }

    const Element& Value(void) const { return m_Iter->second; }

  private:
    MapConstIterator 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_MapContainer(_, EXPORT, x, y) namespace itk { \
  _(2(class EXPORT MapContainer< ITK_TEMPLATE_2 x >)) \
  namespace Templates { typedef MapContainer< ITK_TEMPLATE_2 x > \
                                                  MapContainer##y; } \
  }

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

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

#endif