chowdsp_wdf  1.0.0
Wave Digital Filters library for chowdsp
Public Member Functions | Public Attributes | List of all members
InductorT< T > Class Template Referencefinal

WDF Inductor Node. More...

+ Inheritance diagram for InductorT< T >:

Public Member Functions

 InductorT (T value, T fs=(T) 48000.0)
 Creates a new WDF Inductor. More...
 
void prepare (T sampleRate)
 Prepares the inductor to operate at a new sample rate. More...
 
void reset ()
 Resets the inductor state. More...
 
void setInductanceValue (T newL)
 Sets the inductance value of the WDF inductor, in Henries. More...
 
void calcImpedance () override
 Computes the impedance of the WDF inductor, Z_L = 2 * f_s * L. More...
 
void incident (T x) noexcept
 Accepts an incident wave into a WDF inductor. More...
 
reflected () noexcept
 Propogates a reflected wave from a WDF inductor. More...
 
 InductorT (T value, T fs=(T) 48000.0)
 Creates a new WDF Inductor. More...
 
void prepare (T sampleRate)
 Prepares the inductor to operate at a new sample rate. More...
 
void reset ()
 Resets the inductor state. More...
 
void setInductanceValue (T newL)
 Sets the inductance value of the WDF inductor, in Henries. More...
 
void calcImpedance () override
 Computes the impedance of the WDF inductor, Z_L = 2 * f_s * L. More...
 
void incident (T x) noexcept
 Accepts an incident wave into a WDF inductor. More...
 
reflected () noexcept
 Propogates a reflected wave from a WDF inductor. More...
 
- Public Member Functions inherited from BaseWDF
virtual ~BaseWDF ()=default
 
void connectToParent (BaseWDF *p)
 
virtual void propagateImpedanceChange ()
 
virtual ~BaseWDF ()=default
 
void connectToParent (BaseWDF *p)
 
virtual void propagateImpedanceChange ()
 

Public Attributes

WDFMembers< T > wdf
 

Additional Inherited Members

- Protected Attributes inherited from BaseWDF
BaseWDFparent = nullptr
 

Detailed Description

template<typename T>
class chowdsp::wdft::InductorT< T >

WDF Inductor Node.

Constructor & Destructor Documentation

◆ InductorT() [1/2]

InductorT ( value,
fs = (T) 48000.0 
)
explicit

Creates a new WDF Inductor.

Parameters
valueInductance value in Farads
fsWDF sample rate

References InductorT< T >::calcImpedance().

◆ InductorT() [2/2]

InductorT ( value,
fs = (T) 48000.0 
)
explicit

Creates a new WDF Inductor.

Parameters
valueInductance value in Farads
fsWDF sample rate

References InductorT< T >::calcImpedance().

Member Function Documentation

◆ prepare() [1/2]

void prepare ( sampleRate)

Prepares the inductor to operate at a new sample rate.

References BaseWDF::propagateImpedanceChange(), and InductorT< T >::reset().

◆ reset() [1/2]

void reset ( )

Resets the inductor state.

Referenced by InductorT< T >::prepare().

◆ setInductanceValue() [1/2]

void setInductanceValue ( newL)

Sets the inductance value of the WDF inductor, in Henries.

References BaseWDF::propagateImpedanceChange().

◆ calcImpedance() [1/2]

void calcImpedance ( )
overridevirtual

Computes the impedance of the WDF inductor, Z_L = 2 * f_s * L.

Implements BaseWDF.

References InductorT< T >::wdf.

Referenced by InductorT< T >::InductorT().

◆ incident() [1/2]

void incident ( x)
noexcept

Accepts an incident wave into a WDF inductor.

References InductorT< T >::wdf.

◆ reflected() [1/2]

T reflected ( )
noexcept

Propogates a reflected wave from a WDF inductor.

References InductorT< T >::wdf.

◆ prepare() [2/2]

void prepare ( sampleRate)

Prepares the inductor to operate at a new sample rate.

References BaseWDF::propagateImpedanceChange(), and InductorT< T >::reset().

◆ reset() [2/2]

void reset ( )

Resets the inductor state.

◆ setInductanceValue() [2/2]

void setInductanceValue ( newL)

Sets the inductance value of the WDF inductor, in Henries.

References BaseWDF::propagateImpedanceChange().

◆ calcImpedance() [2/2]

void calcImpedance ( )
overridevirtual

Computes the impedance of the WDF inductor, Z_L = 2 * f_s * L.

Implements BaseWDF.

References InductorT< T >::wdf.

◆ incident() [2/2]

void incident ( x)
noexcept

Accepts an incident wave into a WDF inductor.

References InductorT< T >::wdf.

◆ reflected() [2/2]

T reflected ( )
noexcept

Propogates a reflected wave from a WDF inductor.

References InductorT< T >::wdf.

Member Data Documentation

◆ wdf

WDFMembers< T > wdf

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