1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*=========================================================================
*
* 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
{
/** \class RingBuffer
* \brief Templated ring buffer for holding anything
*
* This ring buffer can hold any type of itk class that supports smart
* pointers. A HEAD pointer is maintained and the buffer pointers can be
* accessed in order using either positive or negative offsets. The HEAD
* pointer can also be moved forward or backward in the ring.
*
* \ingroup ITKVideoCore
*/
template< typename TElement >
class ITK_TEMPLATE_EXPORT RingBuffer : public Object
{
public:
/**-TYPEDEFS---------------------------------------------------------------*/
/** Standard class typedefs */
typedef RingBuffer Self;
typedef Object Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/** Contained type */
typedef TElement ElementType;
typedef typename ElementType::Pointer ElementPointer;
typedef ::itk::SizeValueType SizeValueType;
typedef ::itk::OffsetValueType OffsetValueType;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(RingBuffer, Object);
/** Set the number of buffers
* WARNING: If the size is set smaller than the current buffer size, the tail
* of the buffer will be chopped off */
void SetNumberOfBuffers(SizeValueType sz);
/** Get the buffer size */
SizeValueType GetNumberOfBuffers();
/** Move the Head pointer along the ring using the given offset */
void MoveHead(OffsetValueType offset);
/** Convenience methods for moving Head +/- 1 */
void MoveHeadForward();
void MoveHeadBackward();
/** Report whether or not the indicated buffer is full */
bool BufferIsFull(OffsetValueType offset);
/** Report the current position of Head (mostly used for testing) */
SizeValueType GetHeadIndex() {
return this->m_HeadIndex;
}
/** Access the data from the indicated buffer */
typename ElementType::Pointer GetBufferContents(OffsetValueType offset);
/** Set the buffer contents of a buffer */
void SetBufferContents(OffsetValueType offset, ElementPointer element);
protected:
/**-PROTECTED METHODS------------------------------------------------------*/
RingBuffer();
virtual ~RingBuffer() ITK_OVERRIDE;
virtual void PrintSelf(std::ostream &os, Indent indent) const ITK_OVERRIDE;
/** Get the proper buffer index from an offset */
OffsetValueType GetOffsetBufferIndex(OffsetValueType offset);
/**-PROTECTED MEMBERS------------------------------------------------------*/
/** Pointer to the current active buffer */
SizeValueType m_HeadIndex;
/** Vector of pointers to elements */
std::vector<ElementPointer> m_PointerVector;
private:
ITK_DISALLOW_COPY_AND_ASSIGN(RingBuffer);
}; // end RingBuffer class
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkRingBuffer.hxx"
#endif
#endif
|
