JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode > Class Template Reference

Forward declaration. More...

#include <JPLSpatial/Utilities/AbstractIndex.h>

Inheritance diagram for JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >:

Classes
struct	Index

Public Member Functions
	AbstractRingIndex (uint32_t minSize)
	AbstractRingIndex (const AbstractRingIndex &)=default
AbstractRingIndex &	operator= (const AbstractRingIndex &)=default
uint32_t	GetTotalSize () const
	Get total size of the ring buffer including MaxWindow mirror length.
uint32_t	GetRingSize () const
Index	GetCurrent () const
void	Reset ()
Index	operator++ ()
Index	operator++ (int)
Index	operator-- ()
Index	operator-- (int)
uint32_t	GetOffset (uint32_t offset) const
	Get the index of the sample at an offset from the WriteIndex.

Detailed Description

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>
class JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >

Forward declaration.

Class representing an index of a ring buffer with an optional mirror index to accommodate minimum length of congiguous data.

Constructor & Destructor Documentation

AbstractRingIndex() [1/2]

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::AbstractRingIndex ( uint32_t  minSize )

inlineexplicit

AbstractRingIndex() [2/2]

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::AbstractRingIndex ( const AbstractRingIndex< MaxWindow, WriteDirection, OperationMode > &  )

default

Member Function Documentation

GetCurrent()

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

Index JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::GetCurrent ( ) const

inline

GetOffset()

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

uint32_t JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::GetOffset ( uint32_t  offset ) const

inline

Get the index of the sample at an offset from the WriteIndex.

GetRingSize()

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

uint32_t JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::GetRingSize ( ) const

inline

GetTotalSize()

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

uint32_t JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::GetTotalSize ( ) const

inline

Get total size of the ring buffer including MaxWindow mirror length.

operator++() [1/2]

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

Index JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::operator++ ( )

inline

operator++() [2/2]

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

Index JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::operator++ ( int  )

inline

operator--() [1/2]

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

Index JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::operator-- ( )

inline

operator--() [2/2]

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

Index JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::operator-- ( int  )

inline

operator=()

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

AbstractRingIndex & JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::operator= ( const AbstractRingIndex< MaxWindow, WriteDirection, OperationMode > &  )

default

Reset()

template<uint32_t MaxWindow, RingImpl::CWriteDirection auto WriteDirection, RingImpl::COperationMode auto OperationMode>

void JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >::Reset ( )

inline

---

The documentation for this class was generated from the following file:

• JPLSpatial/Utilities/AbstractIndex.h