itkImportImageContainer.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkImportImageContainer_h
#define itkImportImageContainer_h
 
#include "itkObject.h"
#include "itkObjectFactory.h"
#include <utility>
 
namespace itk
{
 
template <typename TElementIdentifier, typename TElement>
class ITK_TEMPLATE_EXPORT ImportImageContainer : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImportImageContainer);

  using Self = ImportImageContainer;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using ElementIdentifier = TElementIdentifier;
  using Element = TElement;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ImportImageContainer);

  TElement *
  GetImportPointer()
  {
    return m_ImportPointer;
  }

  void
  SetImportPointer(TElement * ptr, TElementIdentifier num, bool LetContainerManageMemory = false);

  TElement &
  operator[](const ElementIdentifier id)
  {
    return m_ImportPointer[id];
  }

  const TElement &
  operator[](const ElementIdentifier id) const
  {
    return m_ImportPointer[id];
  }

  TElement *
  GetBufferPointer()
  {
    return m_ImportPointer;
  }

  ElementIdentifier
  Capacity() const
  {
    return m_Capacity;
  }

  ElementIdentifier
  Size() const
  {
    return m_Size;
  }

  void
  Reserve(ElementIdentifier size, const bool UseValueInitialization = false);

  void
  Squeeze();

  void
  Initialize();

  itkSetMacro(ContainerManageMemory, bool);
  itkGetConstMacro(ContainerManageMemory, bool);
  itkBooleanMacro(ContainerManageMemory);
 
protected:
  ImportImageContainer() = default;
  ~ImportImageContainer() override;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  virtual TElement *
  AllocateElements(ElementIdentifier size, bool UseValueInitialization = false) const;
 
  virtual void
  DeallocateManagedMemory();
 
  /* Set the m_Size member that represents the number of elements
   * currently stored in the container. Use this function with great
   * care since it only changes the m_Size member and not the actual size
   * of the import pointer m_ImportPointer. It should typically
   * be used only to override AllocateElements and
   * DeallocateManagedMemory. */
  itkSetMacro(Size, TElementIdentifier);
 
  /* Set the m_Capacity member that represents the capacity of
   * the current container. Use this function with great care
   * since it only changes the m_Capacity member and not the actual
   * capacity of the import pointer m_ImportPointer. It should typically
   * be used only to override AllocateElements and
   * DeallocateManagedMemory. */
  itkSetMacro(Capacity, TElementIdentifier);
 
  /* Set the m_ImportPointer member. Use this function with great care
   * since it only changes the m_ImportPointer member but not the m_Size
   * and m_Capacity members. It should typically be used only to override
   * AllocateElements and DeallocateManagedMemory. */
  void
  SetImportPointer(TElement * ptr)
  {
    m_ImportPointer = ptr;
  }
 
private:
  TElement *         m_ImportPointer{};
  TElementIdentifier m_Size{};
  TElementIdentifier m_Capacity{};
  bool               m_ContainerManageMemory{ true };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImportImageContainer.hxx"
#endif
 
#endif