The WdfAdaptorBase object acts as the base class for all WDF Adaptors; the static members allow for simplified connection of components. See the FX book for more details. More...

#include <fxobjects.h>

Inheritance diagram for WdfAdaptorBase:

Public Member Functions
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)

IComponentAdaptor *	getPort1_CompAdaptor ()

IComponentAdaptor *	getPort2_CompAdaptor ()

IComponentAdaptor *	getPort3_CompAdaptor ()

Public Member Functions inherited from IComponentAdaptor
virtual void	initialize (double _R1)

virtual void	initializeAdaptorChain ()

virtual void	setInput (double _in)

virtual double	getOutput ()

virtual void	setInput1 (double _in1)=0

virtual void	setInput2 (double _in2)=0

virtual void	setInput3 (double _in3)=0

virtual double	getOutput1 ()=0

virtual double	getOutput2 ()=0

virtual double	getOutput3 ()=0

virtual void	reset (double _sampleRate)

virtual double	getComponentResistance ()

virtual double	getComponentConductance ()

virtual void	updateComponentResistance ()

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)

virtual double	getComponentValue ()

Static Public Member Functions
static void	connectAdaptors (WdfAdaptorBase upstreamAdaptor, WdfAdaptorBase downstreamAdaptor)

Protected Attributes
IComponentAdaptor *	port1CompAdaptor = nullptr
	componant or adaptor connected to port 1

IComponentAdaptor *	port2CompAdaptor = nullptr
	componant or adaptor connected to port 2

IComponentAdaptor *	port3CompAdaptor = nullptr
	componant or adaptor connected to port 3

IComponentAdaptor *	wdfComponent = 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 WdfAdaptorBase object acts as the base class for all WDF Adaptors; the static members allow for simplified connection of components. See the FX book for more details.

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

◆ connectAdaptors()

static void WdfAdaptorBase::connectAdaptors	(	WdfAdaptorBase *	upstreamAdaptor,
		WdfAdaptorBase *	downstreamAdaptor
	)

inlinestatic

connect two adapters together upstreamAdaptor --> downstreamAdaptor

◆ getPort1_CompAdaptor()

IComponentAdaptor * WdfAdaptorBase::getPort1_CompAdaptor ( )

inline

get adaptor connected at port 1: for extended functionality; not used in WDF ladder filter library

◆ getPort2_CompAdaptor()

IComponentAdaptor * WdfAdaptorBase::getPort2_CompAdaptor ( )

inline

get adaptor connected at port 2: for extended functionality; not used in WDF ladder filter library

◆ getPort3_CompAdaptor()

IComponentAdaptor * WdfAdaptorBase::getPort3_CompAdaptor ( )

inline

get adaptor connected at port 3: for extended functionality; not used in WDF ladder filter library

◆ initializeAdaptorChain()

virtual void WdfAdaptorBase::initializeAdaptorChain ( )

inlinevirtual

initialize the chain of adaptors from upstreamAdaptor --> downstreamAdaptor

Reimplemented from IComponentAdaptor.

◆ reset()

virtual void WdfAdaptorBase::reset ( double _sampleRate )

inlinevirtual

reset the connected component

Reimplemented from IComponentAdaptor.

◆ setComponent()

void WdfAdaptorBase::setComponent	(	wdfComponent	componentType,
		double	value1 = `0.0`,
		double	value2 = `0.0`
	)

inline

creates a new WDF component and connects it to Port 3

◆ setComponentValue()

virtual void WdfAdaptorBase::setComponentValue ( double _componentValue )

inlinevirtual

set value of single-component adaptor

Reimplemented from IComponentAdaptor.

◆ setComponentValue_LC()

virtual void WdfAdaptorBase::setComponentValue_LC	(	double	componentValue_L,
		double	componentValue_C
	)

inlinevirtual

set LC value of mjulti-component adaptor

Reimplemented from IComponentAdaptor.

◆ setComponentValue_RC()

virtual void WdfAdaptorBase::setComponentValue_RC	(	double	componentValue_R,
		double	componentValue_C
	)

inlinevirtual

set RC value of mjulti-component adaptor

Reimplemented from IComponentAdaptor.

◆ setComponentValue_RL()

virtual void WdfAdaptorBase::setComponentValue_RL	(	double	componentValue_R,
		double	componentValue_L
	)

inlinevirtual

set RL value of mjulti-component adaptor

Reimplemented from IComponentAdaptor.

◆ setOpenTerminalResistance()

void WdfAdaptorBase::setOpenTerminalResistance ( bool _openTerminalResistance = true )

inline

set the termainal (load) resistance as open circuit for terminating adaptors

◆ setPort1_CompAdaptor()

void WdfAdaptorBase::setPort1_CompAdaptor ( IComponentAdaptor * _port1CompAdaptor )

inline

set the component or connected adaptor at port 1; functions is generic and allows extending the functionality of the WDF Library

◆ setPort2_CompAdaptor()

void WdfAdaptorBase::setPort2_CompAdaptor ( IComponentAdaptor * _port2CompAdaptor )

inline

set the component or connected adaptor at port 2; functions is generic and allows extending the functionality of the WDF Library

◆ setPort3_CompAdaptor()

void WdfAdaptorBase::setPort3_CompAdaptor ( IComponentAdaptor * _port3CompAdaptor )

inline

set the component or connected adaptor at port 3; functions is generic and allows extending the functionality of the WDF Library

◆ setSourceResistance()

void WdfAdaptorBase::setSourceResistance ( double _sourceResistance )

inline

set the input (source) resistance for an input adaptor

◆ setTerminalResistance()

void WdfAdaptorBase::setTerminalResistance ( double _terminalResistance )

inline

set the termainal (load) resistance for terminating adaptors

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

C:/RackAFX_v7/ASPIK_Doxygen/PluginObjects/fxobjects.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ connectAdaptors()

◆ getPort1_CompAdaptor()

◆ getPort2_CompAdaptor()

◆ getPort3_CompAdaptor()

◆ initializeAdaptorChain()

◆ reset()

◆ setComponent()

◆ setComponentValue()

◆ setComponentValue_LC()

◆ setComponentValue_RC()

◆ setComponentValue_RL()

◆ setOpenTerminalResistance()

◆ setPort1_CompAdaptor()

◆ setPort2_CompAdaptor()

◆ setPort3_CompAdaptor()

◆ setSourceResistance()

◆ setTerminalResistance()