itkConditionalConstIterator.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 itkConditionalConstIterator_h
#define itkConditionalConstIterator_h
 
#include "itkIndex.h"
 
namespace itk
{
template <typename TImage>
class ITK_TEMPLATE_EXPORT ConditionalConstIterator
{
public:
  using Self = ConditionalConstIterator;

  static constexpr unsigned int NDimension = TImage::ImageDimension;

  using IndexType = typename TImage::IndexType;

  using SizeType = typename TImage::SizeType;

  using RegionType = typename TImage::RegionType;

  using ImageType = TImage;

  using InternalPixelType = typename TImage::InternalPixelType;

  using PixelType = typename TImage::PixelType;

  [[nodiscard]] virtual bool
  IsPixelIncluded(const IndexType & index) const = 0;

  Self &
  operator=(const Self & it) = default;

  static unsigned int
  GetIteratorDimension()
  {
    return Self::NDimension;
  }

  virtual const IndexType
  GetIndex() = 0;

  [[nodiscard]] virtual const PixelType
  Get() const = 0;

  [[nodiscard]] virtual bool
  IsAtEnd() const = 0;

  virtual void
  operator++() = 0;

  ConditionalConstIterator() = default;

  virtual ~ConditionalConstIterator() = default;
 
protected: // made protected so other iterators can access
  // SmartPointer<const ImageType> m_Image;
  typename ImageType::ConstWeakPointer m_Image{};

  RegionType m_Region{};

  bool m_IsAtEnd{ false };
};
} // end namespace itk
 
#endif