itkObjectStore.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkObjectStore.h,v $
  Language:  C++
  Date:      $Date: 2009-04-25 12:24:12 $
  Version:   $Revision: 1.5 $

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

#include "itkObjectFactory.h"
#include "itkObject.h"
#include <vector>

namespace itk {

template < class TObjectType >
class ITK_EXPORT ObjectStore : public Object
{
public:
  typedef ObjectStore               Self;
  typedef Object                    Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ObjectStore, Object);

  typedef TObjectType ObjectType;

  typedef std::vector<ObjectType *> FreeListType;

  typedef enum {LINEAR_GROWTH = 0, EXPONENTIAL_GROWTH = 1} GrowthStrategyType;

  ObjectType *Borrow();

  void Return(ObjectType *p);

  itkGetConstMacro(Size, ::size_t);

  void Reserve(::size_t n);

  void Squeeze();

  void Clear();

  itkSetMacro(LinearGrowthSize, ::size_t);
  itkGetConstMacro(LinearGrowthSize, ::size_t);

  itkSetMacro(GrowthStrategy, GrowthStrategyType);
  itkGetConstMacro(GrowthStrategy, GrowthStrategyType);

  void SetGrowthStrategyToExponential()
    { this->SetGrowthStrategy(EXPONENTIAL_GROWTH); }

  void SetGrowthStrategyToLinear()
    { this->SetGrowthStrategy(LINEAR_GROWTH); }

protected:
  ObjectStore();
  ~ObjectStore();
  virtual void PrintSelf(std::ostream& os, Indent indent) const;

  ::size_t GetGrowthSize();

  struct MemoryBlock
    {
    MemoryBlock(): Size(0), Begin(0) {}

    MemoryBlock(::size_t n) : Size(n)
      { Begin = new ObjectType[n];  }

    ~MemoryBlock()  {  } // Purposely does *not* free memory

    void Delete()
      { if (Begin !=0) delete[] Begin; }
    
    ObjectType *Begin;
    ::size_t Size;
    };
  
private:
  ObjectStore(const Self&);    //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  GrowthStrategyType m_GrowthStrategy;
  
  ::size_t m_Size;
  ::size_t m_LinearGrowthSize;
  
  FreeListType  m_FreeList;

  std::vector<MemoryBlock>   m_Store;

};

  
} // end namespace itk

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

#endif