itkObjectStore.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkObjectStore_h
#define __itkObjectStore_h

#include "itkObjectFactory.h"
#include "itkObject.h"
#include "itkIntTypes.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, SizeValueType);

  void Reserve(SizeValueType n);

  void Squeeze();

  void Clear();

  itkSetMacro(LinearGrowthSize, SizeValueType);
  itkGetConstMacro(LinearGrowthSize, SizeValueType);

  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;

  SizeValueType GetGrowthSize();

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

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

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

    void Delete()
    { if ( Begin != 0 ) { delete[] Begin; } }

    ObjectType *Begin;
    SizeValueType Size;
  };
private:
  ObjectStore(const Self &);    //purposely not implemented
  void operator=(const Self &); //purposely not implemented

  GrowthStrategyType m_GrowthStrategy;

  SizeValueType m_Size;
  SizeValueType m_LinearGrowthSize;

  FreeListType m_FreeList;

  std::vector< MemoryBlock > m_Store;
};
} // end namespace itk

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

#endif