Buffers the Transformation input. More...

#include <InputBuffering.h>

Inheritance diagram for dsp::InputBuffering:
dsp::BufferingPolicy OwnStream Reference::Able Reference::HeapTracked dsp::UniversalInputBuffering< Class, Method >

Classes

class  Share
 Buffers the Transformation input. More...
 

Public Member Functions

 InputBuffering (HasInput< TimeSeries > *target=0)
 Default constructor.
 
void set_target (HasInput< TimeSeries > *input)
 Set the target with input TimeSeries to be buffered.
 
void pre_transformation ()
 Perform all buffering tasks required before transformation. More...
 
void post_transformation ()
 Perform all buffering tasks required after transformation. More...
 
void set_next_start (uint64_t next_start_sample)
 Set the first sample to be used from the input next time. More...
 
void set_maximum_samples (uint64_t samples)
 Set the maximum number of samples to be buffered.
 
int64_t get_next_contiguous () const
 Get the next contiguous sample following the current buffer.
 
uint64_t bytes_storage () const override
 Get the number of bytes of storage required by this buffer.
 
virtual const TimeSeriesget_input ()
 Get the TimeSeries to be buffered.
 
- Public Member Functions inherited from dsp::BufferingPolicy
std::string get_name ()
 Returns the name.
 
- Public Member Functions inherited from OwnStream
 OwnStream (const OwnStream &)
 
const OwnStreamoperator= (const OwnStream &)
 
virtual void set_cout (std::ostream &) const
 
virtual void set_cerr (std::ostream &) const
 
- Public Member Functions inherited from Reference::Able
 Able (const Able &)
 
Ableoperator= (const Able &)
 
unsigned get_reference_count () const
 
- Public Member Functions inherited from Reference::HeapTracked
 HeapTracked (const HeapTracked &)
 
HeapTrackedoperator= (const HeapTracked &)
 
bool __is_on_heap () const
 

Protected Member Functions

void resize_buffer ()
 Resize and configure.
 
- Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 

Protected Attributes

uint64_t next_start_sample = 0
 The next start sample.
 
HasInput< TimeSeries > * target = nullptr
 The target with input TimeSeries to be buffered.
 
Reference::To< TimeSeriesbuffer
 The buffer.
 
Reference::To< Reservereserve
 The reserve manager.
 
- Protected Attributes inherited from dsp::BufferingPolicy
std::string name
 Descriptive name.
 

Additional Inherited Members

- Static Public Member Functions inherited from Reference::Able
static size_t get_instance_count ()
 
- Static Public Member Functions inherited from Reference::HeapTracked
static void * operator new (size_t size, void *ptr=0)
 
static void operator delete (void *location, void *ptr)
 
static void operator delete (void *location)
 
static size_t get_heap_queue_size ()
 

Detailed Description

Buffers the Transformation input.

Member Function Documentation

◆ post_transformation()

void dsp::InputBuffering::post_transformation ( )
virtual

Perform all buffering tasks required after transformation.

No action required after transformation

Implements dsp::BufferingPolicy.

◆ pre_transformation()

void dsp::InputBuffering::pre_transformation ( )
virtual

Perform all buffering tasks required before transformation.

Prepend buffered data to target Transformation's input TimeSeries

Implements dsp::BufferingPolicy.

References dsp::TimeSeries::get_input_sample().

◆ set_next_start()

void dsp::InputBuffering::set_next_start ( uint64_t  next)
virtual

Set the first sample to be used from the input next time.

Copy remaining data from the target Transformation's input to buffer

Implements dsp::BufferingPolicy.


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

Generated using doxygen 1.8.17