ASPiK SDK
WdfSeriesAdaptor Class Reference

The WdfSeriesAdaptor object implements the series reflection-free (non-terminated) adaptor. More...

#include <fxobjects.h>

Inheritance diagram for WdfSeriesAdaptor:
WdfAdaptorBase WdfAdaptorBase WdfAdaptorBase WdfAdaptorBase IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor IComponentAdaptor

Public Member Functions

virtual double getR2 ()
 
virtual void initialize (double _R1)
 
virtual void setInput1 (double _in1)
 
virtual void setInput2 (double _in2)
 
virtual void setInput3 (double _in3)
 
virtual double getOutput1 ()
 
virtual double getOutput2 ()
 
virtual double getOutput3 ()
 
virtual double getR2 ()
 
virtual void initialize (double _R1)
 
virtual void setInput1 (double _in1)
 
virtual void setInput2 (double _in2)
 
virtual void setInput3 (double _in3)
 
virtual double getOutput1 ()
 
virtual double getOutput2 ()
 
virtual double getOutput3 ()
 
virtual double getR2 ()
 
virtual void initialize (double _R1)
 
virtual void setInput1 (double _in1)
 
virtual void setInput2 (double _in2)
 
virtual void setInput3 (double _in3)
 
virtual double getOutput1 ()
 
virtual double getOutput2 ()
 
virtual double getOutput3 ()
 
virtual double getR2 ()
 
virtual void initialize (double _R1)
 
virtual void setInput1 (double _in1)
 
virtual void setInput2 (double _in2)
 
virtual void setInput3 (double _in3)
 
virtual double getOutput1 ()
 
virtual double getOutput2 ()
 
virtual double getOutput3 ()
 
- Public Member Functions inherited from WdfAdaptorBase
void setTerminalResistance (double _terminalResistance)
 
void setOpenTerminalResistance (bool _openTerminalResistance=true)
 
void setSourceResistance (double _sourceResistance)
 
void setPort1_CompAdaptor (IComponentAdaptor *_port1CompAdaptor)
 
void setPort2_CompAdaptor (IComponentAdaptor *_port2CompAdaptor)
 
void setPort3_CompAdaptor (IComponentAdaptor *_port3CompAdaptor)
 
virtual void reset (double _sampleRate)
 
void setComponent (wdfComponent componentType, double value1=0.0, double value2=0.0)
 
virtual void initializeAdaptorChain ()
 
virtual void setComponentValue (double _componentValue)
 
virtual void setComponentValue_LC (double componentValue_L, double componentValue_C)
 
virtual void setComponentValue_RL (double componentValue_R, double componentValue_L)
 
virtual void setComponentValue_RC (double componentValue_R, double componentValue_C)
 
IComponentAdaptorgetPort1_CompAdaptor ()
 
IComponentAdaptorgetPort2_CompAdaptor ()
 
IComponentAdaptorgetPort3_CompAdaptor ()
 
void setTerminalResistance (double _terminalResistance)
 
void setOpenTerminalResistance (bool _openTerminalResistance=true)
 
void setSourceResistance (double _sourceResistance)
 
void setPort1_CompAdaptor (IComponentAdaptor *_port1CompAdaptor)
 
void setPort2_CompAdaptor (IComponentAdaptor *_port2CompAdaptor)
 
void setPort3_CompAdaptor (IComponentAdaptor *_port3CompAdaptor)
 
virtual void reset (double _sampleRate)
 
void setComponent (wdfComponent componentType, double value1=0.0, double value2=0.0)
 
virtual void initializeAdaptorChain ()
 
virtual void setComponentValue (double _componentValue)
 
virtual void setComponentValue_LC (double componentValue_L, double componentValue_C)
 
virtual void setComponentValue_RL (double componentValue_R, double componentValue_L)
 
virtual void setComponentValue_RC (double componentValue_R, double componentValue_C)
 
IComponentAdaptorgetPort1_CompAdaptor ()
 
IComponentAdaptorgetPort2_CompAdaptor ()
 
IComponentAdaptorgetPort3_CompAdaptor ()
 
void setTerminalResistance (double _terminalResistance)
 
void setOpenTerminalResistance (bool _openTerminalResistance=true)
 
void setSourceResistance (double _sourceResistance)
 
void setPort1_CompAdaptor (IComponentAdaptor *_port1CompAdaptor)
 
void setPort2_CompAdaptor (IComponentAdaptor *_port2CompAdaptor)
 
void setPort3_CompAdaptor (IComponentAdaptor *_port3CompAdaptor)
 
virtual void reset (double _sampleRate)
 
void setComponent (wdfComponent componentType, double value1=0.0, double value2=0.0)
 
virtual void initializeAdaptorChain ()
 
virtual void setComponentValue (double _componentValue)
 
virtual void setComponentValue_LC (double componentValue_L, double componentValue_C)
 
virtual void setComponentValue_RL (double componentValue_R, double componentValue_L)
 
virtual void setComponentValue_RC (double componentValue_R, double componentValue_C)
 
IComponentAdaptorgetPort1_CompAdaptor ()
 
IComponentAdaptorgetPort2_CompAdaptor ()
 
IComponentAdaptorgetPort3_CompAdaptor ()
 
void setTerminalResistance (double _terminalResistance)
 
void setOpenTerminalResistance (bool _openTerminalResistance=true)
 
void setSourceResistance (double _sourceResistance)
 
void setPort1_CompAdaptor (IComponentAdaptor *_port1CompAdaptor)
 
void setPort2_CompAdaptor (IComponentAdaptor *_port2CompAdaptor)
 
void setPort3_CompAdaptor (IComponentAdaptor *_port3CompAdaptor)
 
virtual void reset (double _sampleRate)
 
void setComponent (wdfComponent componentType, double value1=0.0, double value2=0.0)
 
virtual void initializeAdaptorChain ()
 
virtual void setComponentValue (double _componentValue)
 
virtual void setComponentValue_LC (double componentValue_L, double componentValue_C)
 
virtual void setComponentValue_RL (double componentValue_R, double componentValue_L)
 
virtual void setComponentValue_RC (double componentValue_R, double componentValue_C)
 
IComponentAdaptorgetPort1_CompAdaptor ()
 
IComponentAdaptorgetPort2_CompAdaptor ()
 
IComponentAdaptorgetPort3_CompAdaptor ()
 
- Public Member Functions inherited from IComponentAdaptor
virtual void setInput (double _in)
 
virtual double getOutput ()
 
virtual double getComponentResistance ()
 
virtual double getComponentConductance ()
 
virtual void updateComponentResistance ()
 
virtual double getComponentValue ()
 
virtual void setInput (double _in)
 
virtual double getOutput ()
 
virtual double getComponentResistance ()
 
virtual double getComponentConductance ()
 
virtual void updateComponentResistance ()
 
virtual double getComponentValue ()
 
virtual void setInput (double _in)
 
virtual double getOutput ()
 
virtual double getComponentResistance ()
 
virtual double getComponentConductance ()
 
virtual void updateComponentResistance ()
 
virtual double getComponentValue ()
 
virtual void setInput (double _in)
 
virtual double getOutput ()
 
virtual double getComponentResistance ()
 
virtual double getComponentConductance ()
 
virtual void updateComponentResistance ()
 
virtual double getComponentValue ()
 

Additional Inherited Members

- Static Public Member Functions inherited from WdfAdaptorBase
static void connectAdaptors (WdfAdaptorBase *upstreamAdaptor, WdfAdaptorBase *downstreamAdaptor)
 
static void connectAdaptors (WdfAdaptorBase *upstreamAdaptor, WdfAdaptorBase *downstreamAdaptor)
 
static void connectAdaptors (WdfAdaptorBase *upstreamAdaptor, WdfAdaptorBase *downstreamAdaptor)
 
static void connectAdaptors (WdfAdaptorBase *upstreamAdaptor, WdfAdaptorBase *downstreamAdaptor)
 
- Protected Attributes inherited from WdfAdaptorBase
IComponentAdaptorport1CompAdaptor = nullptr
 componant or adaptor connected to port 1
 
IComponentAdaptorport2CompAdaptor = nullptr
 componant or adaptor connected to port 2
 
IComponentAdaptorport3CompAdaptor = nullptr
 componant or adaptor connected to port 3
 
IComponentAdaptorwdfComponent = nullptr
 WDF componant connected to port 3 (default operation)
 
double R1 = 0.0
 input port resistance
 
double R2 = 0.0
 output port resistance
 
double R3 = 0.0
 component resistance
 
double in1 = 0.0
 stored port 1 input; not used in this implementation but may be required for extended versions
 
double in2 = 0.0
 stored port 2 input; not used in this implementation but may be required for extended versions
 
double in3 = 0.0
 stored port 3 input; not used in this implementation but may be required for extended versions
 
double out1 = 0.0
 stored port 1 output; not used in this implementation but may be required for extended versions
 
double out2 = 0.0
 stored port 2 output; it is y(n) for this library
 
double out3 = 0.0
 stored port 3 output; not used in this implementation but may be required for extended versions
 
double terminalResistance = 600.0
 value of terminal (load) resistance
 
bool openTerminalResistance = false
 flag for open circuit load
 
double sourceResistance = 600.0
 source impedance; OK for this to be set to 0.0 for Rs = 0
 

Detailed Description

The WdfSeriesAdaptor object implements the series reflection-free (non-terminated) adaptor.

Author
Will Pirkle http://www.willpirkle.com
Remarks
This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle
Version
Revision : 1.0
Date
Date : 2018 / 09 / 7

Member Function Documentation

◆ getOutput1() [1/4]

virtual double WdfSeriesAdaptor::getOutput1 ( )
inlinevirtual

get OUT1 = reflected output pin on Port 1

Implements IComponentAdaptor.

◆ getOutput1() [2/4]

virtual double WdfSeriesAdaptor::getOutput1 ( )
inlinevirtual

get OUT1 = reflected output pin on Port 1

Implements IComponentAdaptor.

◆ getOutput1() [3/4]

virtual double WdfSeriesAdaptor::getOutput1 ( )
inlinevirtual

get OUT1 = reflected output pin on Port 1

Implements IComponentAdaptor.

◆ getOutput1() [4/4]

virtual double WdfSeriesAdaptor::getOutput1 ( )
inlinevirtual

get OUT1 = reflected output pin on Port 1

Implements IComponentAdaptor.

◆ getOutput2() [1/4]

virtual double WdfSeriesAdaptor::getOutput2 ( )
inlinevirtual

get OUT2 = incident (normal) output pin on Port 2

Implements IComponentAdaptor.

◆ getOutput2() [2/4]

virtual double WdfSeriesAdaptor::getOutput2 ( )
inlinevirtual

get OUT2 = incident (normal) output pin on Port 2

Implements IComponentAdaptor.

◆ getOutput2() [3/4]

virtual double WdfSeriesAdaptor::getOutput2 ( )
inlinevirtual

get OUT2 = incident (normal) output pin on Port 2

Implements IComponentAdaptor.

◆ getOutput2() [4/4]

virtual double WdfSeriesAdaptor::getOutput2 ( )
inlinevirtual

get OUT2 = incident (normal) output pin on Port 2

Implements IComponentAdaptor.

◆ getOutput3() [1/4]

virtual double WdfSeriesAdaptor::getOutput3 ( )
inlinevirtual

get OUT3 always connects to component

Implements IComponentAdaptor.

◆ getOutput3() [2/4]

virtual double WdfSeriesAdaptor::getOutput3 ( )
inlinevirtual

get OUT3 always connects to component

Implements IComponentAdaptor.

◆ getOutput3() [3/4]

virtual double WdfSeriesAdaptor::getOutput3 ( )
inlinevirtual

get OUT3 always connects to component

Implements IComponentAdaptor.

◆ getOutput3() [4/4]

virtual double WdfSeriesAdaptor::getOutput3 ( )
inlinevirtual

get OUT3 always connects to component

Implements IComponentAdaptor.

◆ getR2() [1/4]

virtual double WdfSeriesAdaptor::getR2 ( )
inlinevirtual

get the resistance at port 2; R2 = R1 + component (series)

◆ getR2() [2/4]

virtual double WdfSeriesAdaptor::getR2 ( )
inlinevirtual

get the resistance at port 2; R2 = R1 + component (series)

◆ getR2() [3/4]

virtual double WdfSeriesAdaptor::getR2 ( )
inlinevirtual

get the resistance at port 2; R2 = R1 + component (series)

◆ getR2() [4/4]

virtual double WdfSeriesAdaptor::getR2 ( )
inlinevirtual

get the resistance at port 2; R2 = R1 + component (series)

◆ initialize() [1/4]

virtual void WdfSeriesAdaptor::initialize ( double  _R1)
inlinevirtual

initialize adaptor with input resistance

Reimplemented from IComponentAdaptor.

◆ initialize() [2/4]

virtual void WdfSeriesAdaptor::initialize ( double  _R1)
inlinevirtual

initialize adaptor with input resistance

Reimplemented from IComponentAdaptor.

◆ initialize() [3/4]

virtual void WdfSeriesAdaptor::initialize ( double  _R1)
inlinevirtual

initialize adaptor with input resistance

Reimplemented from IComponentAdaptor.

◆ initialize() [4/4]

virtual void WdfSeriesAdaptor::initialize ( double  _R1)
inlinevirtual

initialize adaptor with input resistance

Reimplemented from IComponentAdaptor.

◆ setInput1() [1/4]

virtual void WdfSeriesAdaptor::setInput1 ( double  _in1)
inlinevirtual

push audio input sample into incident wave input

Implements IComponentAdaptor.

◆ setInput1() [2/4]

virtual void WdfSeriesAdaptor::setInput1 ( double  _in1)
inlinevirtual

push audio input sample into incident wave input

Implements IComponentAdaptor.

◆ setInput1() [3/4]

virtual void WdfSeriesAdaptor::setInput1 ( double  _in1)
inlinevirtual

push audio input sample into incident wave input

Implements IComponentAdaptor.

◆ setInput1() [4/4]

virtual void WdfSeriesAdaptor::setInput1 ( double  _in1)
inlinevirtual

push audio input sample into incident wave input

Implements IComponentAdaptor.

◆ setInput2() [1/4]

virtual void WdfSeriesAdaptor::setInput2 ( double  _in2)
inlinevirtual

push audio input sample into reflected wave input

Implements IComponentAdaptor.

◆ setInput2() [2/4]

virtual void WdfSeriesAdaptor::setInput2 ( double  _in2)
inlinevirtual

push audio input sample into reflected wave input

Implements IComponentAdaptor.

◆ setInput2() [3/4]

virtual void WdfSeriesAdaptor::setInput2 ( double  _in2)
inlinevirtual

push audio input sample into reflected wave input

Implements IComponentAdaptor.

◆ setInput2() [4/4]

virtual void WdfSeriesAdaptor::setInput2 ( double  _in2)
inlinevirtual

push audio input sample into reflected wave input

Implements IComponentAdaptor.

◆ setInput3() [1/4]

virtual void WdfSeriesAdaptor::setInput3 ( double  _in3)
inlinevirtual

set input 3 always connects to component

Implements IComponentAdaptor.

◆ setInput3() [2/4]

virtual void WdfSeriesAdaptor::setInput3 ( double  _in3)
inlinevirtual

set input 3 always connects to component

Implements IComponentAdaptor.

◆ setInput3() [3/4]

virtual void WdfSeriesAdaptor::setInput3 ( double  _in3)
inlinevirtual

set input 3 always connects to component

Implements IComponentAdaptor.

◆ setInput3() [4/4]

virtual void WdfSeriesAdaptor::setInput3 ( double  _in3)
inlinevirtual

set input 3 always connects to component

Implements IComponentAdaptor.


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