itkImageContainerInterface.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 itkImageContainerInterface_h
#define itkImageContainerInterface_h
 
#include "itkObject.h"
 
namespace itk
{
template <typename TElementIdentifier, typename TElement>
class ImageContainerInterface : public Object
{
public:
  using Self = ImageContainerInterface;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ImageContainerInterface);

  using ElementIdentifier = TElementIdentifier;
  using Element = TElement;

  virtual TElement &
  operator[](const ElementIdentifier) = 0;

  virtual const TElement &
  operator[](const ElementIdentifier) const = 0;

  virtual TElement *
  GetBufferPointer() = 0;

  virtual ElementIdentifier
  Size() const = 0;

  virtual void Reserve(ElementIdentifier) = 0;

  virtual void
  Squeeze() = 0;
};
} // end namespace itk
 
#endif