JPL Spatial
Sound spatialization and propagation library
Loading...
Searching...
No Matches
Protected Member Functions | List of all members
JPL::RingImpl::AbstarctRingBase< WriteDirection, OperationMode > Class Template Reference

Base class for Ring-like indexing operations. More...

Inheritance diagram for JPL::RingImpl::AbstarctRingBase< WriteDirection, OperationMode >:
JPL::RingImpl::AbstractRingWrap< OperationMode > JPL::AbstractRingIndex< WindowSize > JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode > JPL::AbstractRingIndex< MaxWindow, WriteDirection, OperationMode >

Protected Member Functions

 AbstarctRingBase (uint32_t minSize)
 
 AbstarctRingBase (const AbstarctRingBase &)=default
 
AbstarctRingBase & operator= (const AbstarctRingBase &)=default
 
uint32_t IncrementIndex (uint32_t index) const
 
uint32_t DecrementIndex (uint32_t index) const
 
uint32_t GetOffset (uint32_t index, uint32_t offset) const
 Get the index of the sample at an offset from the WriteIndex.
 
uint32_t GetMirrorIndex (uint32_t index, uint32_t maxWindow) const
 

Detailed Description

template<CWriteDirection auto WriteDirection, COperationMode auto OperationMode>
class JPL::RingImpl::AbstarctRingBase< WriteDirection, OperationMode >

Base class for Ring-like indexing operations.

Constructor & Destructor Documentation

◆ AbstarctRingBase() [1/2]

template<CWriteDirection auto WriteDirection, COperationMode auto OperationMode>
JPL::RingImpl::AbstarctRingBase< WriteDirection, OperationMode >::AbstarctRingBase ( uint32_t  minSize)
inlineexplicitprotected

◆ AbstarctRingBase() [2/2]

template<CWriteDirection auto WriteDirection, COperationMode auto OperationMode>
JPL::RingImpl::AbstarctRingBase< WriteDirection, OperationMode >::AbstarctRingBase ( const AbstarctRingBase< WriteDirection, OperationMode > &  )
protecteddefault

Member Function Documentation

◆ DecrementIndex()

template<CWriteDirection auto WriteDirection, COperationMode auto OperationMode>
uint32_t JPL::RingImpl::AbstarctRingBase< WriteDirection, OperationMode >::DecrementIndex ( uint32_t  index) const
inlineprotected

◆ GetMirrorIndex()

template<CWriteDirection auto WriteDirection, COperationMode auto OperationMode>
uint32_t JPL::RingImpl::AbstarctRingBase< WriteDirection, OperationMode >::GetMirrorIndex ( uint32_t  index,
uint32_t  maxWindow 
) const
inlineprotected
Parameters
indexindex of the sample to mirror, must be < mRing;

◆ GetOffset()

template<CWriteDirection auto WriteDirection, COperationMode auto OperationMode>
uint32_t JPL::RingImpl::AbstarctRingBase< WriteDirection, OperationMode >::GetOffset ( uint32_t  index,
uint32_t  offset 
) const
inlineprotected

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

◆ IncrementIndex()

template<CWriteDirection auto WriteDirection, COperationMode auto OperationMode>
uint32_t JPL::RingImpl::AbstarctRingBase< WriteDirection, OperationMode >::IncrementIndex ( uint32_t  index) const
inlineprotected

◆ operator=()

template<CWriteDirection auto WriteDirection, COperationMode auto OperationMode>
AbstarctRingBase & JPL::RingImpl::AbstarctRingBase< WriteDirection, OperationMode >::operator= ( const AbstarctRingBase< WriteDirection, OperationMode > &  )
protecteddefault
The documentation for this class was generated from the following file: