ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkRingBuffer.h>
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.
Definition at line 39 of file itkRingBuffer.h.
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef ElementType::Pointer | ElementPointer |
typedef TElement | ElementType |
typedef ::itk::OffsetValueType | OffsetValueType |
typedef SmartPointer< Self > | Pointer |
typedef RingBuffer | Self |
typedef ::itk::SizeValueType | SizeValueType |
typedef Object | Superclass |
Public Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
bool | BufferIsFull (OffsetValueType offset) |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
ElementType::Pointer | GetBufferContents (OffsetValueType offset) |
SizeValueType | GetHeadIndex () |
virtual const char * | GetNameOfClass () const |
SizeValueType | GetNumberOfBuffers () |
void | MoveHead (OffsetValueType offset) |
void | SetBufferContents (OffsetValueType offset, ElementPointer element) |
void | SetNumberOfBuffers (SizeValueType sz) |
void | MoveHeadForward () |
void | MoveHeadBackward () |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) const |
virtual ModifiedTimeType | GetMTime () const |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
virtual void | Register () const ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
Public Member Functions inherited from itk::LightObject | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Protected Member Functions | |
OffsetValueType | GetOffsetBufferIndex (OffsetValueType offset) |
RingBuffer () | |
virtual | ~RingBuffer () |
virtual void | PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Protected Attributes | |
SizeValueType | m_HeadIndex |
std::vector< ElementPointer > | m_PointerVector |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
Private Member Functions | |
void | operator= (const Self &) |
RingBuffer (const Self &) | |
Additional Inherited Members | |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
typedef SmartPointer< const Self > itk::RingBuffer< TElement >::ConstPointer |
Definition at line 49 of file itkRingBuffer.h.
typedef ElementType::Pointer itk::RingBuffer< TElement >::ElementPointer |
Definition at line 53 of file itkRingBuffer.h.
typedef TElement itk::RingBuffer< TElement >::ElementType |
Contained type
Definition at line 52 of file itkRingBuffer.h.
typedef ::itk::OffsetValueType itk::RingBuffer< TElement >::OffsetValueType |
Definition at line 56 of file itkRingBuffer.h.
typedef SmartPointer< Self > itk::RingBuffer< TElement >::Pointer |
Definition at line 48 of file itkRingBuffer.h.
typedef RingBuffer itk::RingBuffer< TElement >::Self |
-TYPEDEFS---------------------------------------------------------—— Standard class typedefs
Definition at line 46 of file itkRingBuffer.h.
typedef ::itk::SizeValueType itk::RingBuffer< TElement >::SizeValueType |
Definition at line 55 of file itkRingBuffer.h.
typedef Object itk::RingBuffer< TElement >::Superclass |
Definition at line 47 of file itkRingBuffer.h.
|
protected |
-PROTECTED METHODS---------------------------------------------------—
|
protectedvirtual |
-PROTECTED METHODS---------------------------------------------------—
|
private |
bool itk::RingBuffer< TElement >::BufferIsFull | ( | OffsetValueType | offset | ) |
Report whether or not the indicated buffer is full
|
virtual |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::Object.
ElementType::Pointer itk::RingBuffer< TElement >::GetBufferContents | ( | OffsetValueType | offset | ) |
Access the data from the indicated buffer
|
inline |
Report the current position of Head (mostly used for testing)
Definition at line 84 of file itkRingBuffer.h.
References itk::RingBuffer< TElement >::m_HeadIndex.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::Object.
SizeValueType itk::RingBuffer< TElement >::GetNumberOfBuffers | ( | ) |
Get the buffer size
|
protected |
Get the proper buffer index from an offset
void itk::RingBuffer< TElement >::MoveHead | ( | OffsetValueType | offset | ) |
Move the Head pointer along the ring using the given offset
void itk::RingBuffer< TElement >::MoveHeadBackward | ( | ) |
Convenience methods for moving Head +/- 1
void itk::RingBuffer< TElement >::MoveHeadForward | ( | ) |
Convenience methods for moving Head +/- 1
|
static |
Method for creation through the object factory.
|
private |
|
protectedvirtual |
-PROTECTED METHODS---------------------------------------------------—
Reimplemented from itk::Object.
void itk::RingBuffer< TElement >::SetBufferContents | ( | OffsetValueType | offset, |
ElementPointer | element | ||
) |
Set the buffer contents of a buffer
void itk::RingBuffer< TElement >::SetNumberOfBuffers | ( | SizeValueType | sz | ) |
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
|
protected |
-PROTECTED MEMBERS------------------------------------------------—— Pointer to the current active buffer
Definition at line 108 of file itkRingBuffer.h.
Referenced by itk::RingBuffer< TElement >::GetHeadIndex().
|
protected |
Vector of pointers to elements
Definition at line 111 of file itkRingBuffer.h.