itkRingBuffer.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 itkRingBuffer_h
#define itkRingBuffer_h
 
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkIntTypes.h"
 
namespace itk
{
 
template <typename TElement>
class ITK_TEMPLATE_EXPORT RingBuffer : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(RingBuffer);


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

  using ElementType = TElement;
  using ElementPointer = typename ElementType::Pointer;
 
  using SizeValueType = itk::SizeValueType;
  using OffsetValueType = itk::OffsetValueType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(RingBuffer);

  void
  SetNumberOfBuffers(SizeValueType n);

  SizeValueType
  GetNumberOfBuffers();

  void
  MoveHead(OffsetValueType offset);

  void
  MoveHeadForward();
  void
  MoveHeadBackward();

  bool
  BufferIsFull(OffsetValueType offset);

  SizeValueType
  GetHeadIndex()
  {
    return this->m_HeadIndex;
  }

  typename ElementType::Pointer
  GetBufferContents(OffsetValueType offset);

  void
  SetBufferContents(OffsetValueType offset, ElementPointer element);
 
protected:
  RingBuffer();
  ~RingBuffer() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  OffsetValueType
  GetOffsetBufferIndex(OffsetValueType offset);


  SizeValueType m_HeadIndex{ 0 };

  std::vector<ElementPointer> m_PointerVector{};
}; // end RingBuffer class
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkRingBuffer.hxx"
#endif
 
#endif