freCollectionBase.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: freCollectionBase.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 __freCollectionBase_h
#define __freCollectionBase_h

#include "freElementals.h"
#include "freExceptions.h"

namespace FREE
{

template <class TElement, class TStorageType = TElement*>
class CollectionBase
{
public:
  typedef TElement ElementType;
  typedef TStorageType StorageType;
  typedef std::vector<StorageType> ElementVectorType;
  typedef typename ElementVectorType::size_type ElementsCountType;

  static const ElementsCountType NULL_Index = -1;  

  virtual const char *GetNameOfClass() const
        {return "CollectionBase";};

  CollectionBase()
  {};

  CollectionBase( const CollectionBase<ElementType>& rCollection )
  {
    *this = rCollection;
  };

  virtual ~CollectionBase()
  {
    Reset();
  };

  virtual void Reset();

  virtual CollectionBase& operator = (const CollectionBase& rCollection);

  virtual CollectionBase& operator + (const CollectionBase& collection);

  virtual ElementType* GetElement(const ElementsCountType& index) const;

  ElementsCountType Size() const
  {
    return m_Elements.size();
  };
  
  virtual void DeleteElement(const ElementsCountType& index);

  virtual ElementsCountType AddElement(ElementType* pElement);

  virtual ElementsCountType AddElement(const ElementType& element) = 0;

  void AddElements(const CollectionBase& collection);

protected:

  ElementVectorType m_Elements;
};

}//end of namespace FREE


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

#endif

---