synapse::FilterWrapper< FilterType > Class Template Reference

Wrapper class that adapts various filter implementations to the BaseFilter interface. More...

#include <base_filter.hpp>

Inheritance diagram for synapse::FilterWrapper< FilterType >:

Collaboration diagram for synapse::FilterWrapper< FilterType >:

Public Member Functions
	FilterWrapper (FilterType filter)
	Constructor that takes ownership of a filter instance.
template<typename... Args>
void	setup (Args &&... args)
	Forward setup parameters to the underlying filter.
float	filter (const float sample) override
	Process a single sample through the filter.
void	reset () override
Public Member Functions inherited from synapse::BaseFilter
virtual	~BaseFilter ()=default
	Virtual destructor.

Detailed Description

template<typename FilterType>
class synapse::FilterWrapper< FilterType >

Wrapper class that adapts various filter implementations to the BaseFilter interface.

Template Parameters

FilterType

The specific filter implementation type being wrapped

Constructor & Destructor Documentation

FilterWrapper()

template<typename FilterType>

synapse::FilterWrapper< FilterType >::FilterWrapper ( FilterType filter )

inlineexplicit

Constructor that takes ownership of a filter instance.

Parameters

filter

Filter instance to wrap

Member Function Documentation

filter()

template<typename FilterType>

float synapse::FilterWrapper< FilterType >::filter ( const float sample )

inlineoverridevirtual

Process a single sample through the filter.

Parameters

sample

Input sample value

Returns

The filtered sample value

Implements synapse::BaseFilter.

reset()

template<typename FilterType>

void synapse::FilterWrapper< FilterType >::reset ( )

inlineoverridevirtual

Implements synapse::BaseFilter.

setup()

template<typename FilterType>

template<typename... Args>

void synapse::FilterWrapper< FilterType >::setup ( Args &&... args )

inline

Forward setup parameters to the underlying filter.

Template Parameters

Args	Parameter types for setup

Parameters

args	Arguments to forward to the filter's setup method

---

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

• include/synapse-app-sdk/dsp/filter/base_filter.hpp