freKeyedCollectionBase.h

Go to the documentation of this file.

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

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freKeyedCollection.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/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 __freKeyedCollectionBase_h
#define __freKeyedCollectionBase_h

#include "freSmartCollectionBase.h"

namespace FREE
{

template <class TKey, class TElement>
class CollectionIdentifierBase
{
public:
  static bool KeyMatches (const TKey& rKey, const TElement& rElement) {return false;}; 
};

template <class TKey, class TElement, class TIdentifierClass>
class KeyedCollectionBase : public SmartCollectionBase<TElement>
{
public:
  typedef TKey KeyType;
  typedef TIdentifierClass IdentifierType;
  typedef SmartCollectionBase<TElement> Superclass;
  
  typedef typename Superclass::ElementType ElementType;
  typedef typename Superclass::ElementVectorType ElementVectorType;
  typedef typename Superclass::ElementsCountType ElementsCountType;

  itkTypeMacro(KeyedCollectionBase,CollectionBase);

  KeyedCollectionBase():SmartCollectionBase<TElement>()
  {};

  KeyedCollectionBase( const KeyedCollectionBase<TKey,TElement,TIdentifierClass>& rCollection )
  {
    *this = rCollection;
  };

  KeyedCollectionBase& operator = (const KeyedCollectionBase& rCollection);

  ElementsCountType GetElementIndex(const KeyType& rKey) const;

        ElementType* GetElement(const KeyType& rKey) const;
  using SmartCollectionBase<TElement>::GetElement;
};

}//end of namespace FREE


#ifndef ITK_MANUAL_INSTANTIATION
#include "freKeyedCollectionBase.txx"
#endif

#endif

---