itkRingBuffer.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 __itkRingBuffer_h
#define __itkRingBuffer_h

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkIntTypes.h"

namespace itk
{
template< class TElement >
class ITK_EXPORT RingBuffer : public Object
{
public:

  typedef RingBuffer                    Self;
  typedef Object                        Superclass;
  typedef SmartPointer< Self >          Pointer;
  typedef SmartPointer< const Self >    ConstPointer;

  typedef TElement                      ElementType;
  typedef typename ElementType::Pointer ElementPointer;

  typedef ::itk::SizeValueType          SizeValueType;
  typedef ::itk::OffsetValueType        OffsetValueType;

  itkNewMacro(Self);

  itkTypeMacro(RingBuffer, Object);

  void SetNumberOfBuffers(SizeValueType sz);

  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();
  virtual ~RingBuffer();
  void PrintSelf(std::ostream &os, Indent indent) const;

  OffsetValueType GetOffsetBufferIndex(OffsetValueType offset);

  SizeValueType               m_HeadIndex;

  std::vector<ElementPointer> m_PointerVector;

private:
  RingBuffer(const Self &);     // purposely not implemented
  void operator=(const Self &); // purposely not implemented

};  // end RingBuffer class

} // end namespace itk

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

#endif