RT-WDF  0.0.1
Real-time Wave Digital Filter Framework
wdfRootNode Class Referenceabstract

#include <rt-wdf.h>

Inheritance diagram for wdfRootNode:

Public Member Functions

 wdfRootNode (int numPorts)
 
virtual ~wdfRootNode ()
 
virtual void setPortResistance (double Rp)
 
virtual void calculateDownB (vec *ascendingWaves, vec *descendingWaves, size_t *portIndex)=0
 
int getNumPorts ()
 
virtual std::string getType () const =0
 

Protected Attributes

double Rp
 
size_t numPorts
 

Constructor & Destructor Documentation

§ wdfRootNode()

wdfRootNode::wdfRootNode ( int  numPorts)

Base class of a WDF Root Node.

This is the base class for all unadapted WDF elements that can form the closed-form (non-implicit) root of a tree.

Parameters
numPortsnumber of ports on this root node

§ ~wdfRootNode()

wdfRootNode::~wdfRootNode ( )
virtual

Deconstructor

Member Function Documentation

§ calculateDownB()

virtual void wdfRootNode::calculateDownB ( vec *  ascendingWaves,
vec *  descendingWaves,
size_t *  portIndex 
)
pure virtual

Virtual placeholder function that is meant to calculate the reflection of the incoming, ascending wave.

This is typically an unadapted expression which involves the component value of the node, the port resistance Rp, past states and the ascending wave itself.

Parameters
*ascendingWavesPointer to a vector of ascending waves
*descendingWavesPointer to a vector to store descending waves
*portIndexPointer to a counter with the port index to use in the vectors of ascending and descending waves. Needs to be incremented by numPorts in the node's implementation.

Implemented in wdfIdealCSource, wdfIdealVSource, wdfUnterminatedRes, wdfUnterminatedInd, wdfUnterminatedCap, and wdfUnterminatedSwitch.

§ getNumPorts()

int wdfRootNode::getNumPorts ( )

Return the number of ports of that root node.

Returns
the value of the numPorts member.

§ getType()

virtual std::string wdfRootNode::getType ( ) const
pure virtual

Virtual placeholder function that is meant to return a String describing the type of this root node.

Returns
a String describing the type of this root node

Implemented in wdfIdealCSource, wdfIdealVSource, wdfUnterminatedRes, wdfUnterminatedInd, wdfUnterminatedCap, and wdfUnterminatedSwitch.

§ setPortResistance()

void wdfRootNode::setPortResistance ( double  Rp)
virtual

Sets the nodes port resistance according to the port it is connected to.

As these nodes sit at the root, their port resistance is dependant on the upfacing port of the subtree they are connected to.

Parameters
Rpport resistance in Ohm

Reimplemented in wdfIdealCSource, wdfIdealVSource, wdfUnterminatedRes, wdfUnterminatedInd, and wdfUnterminatedCap.

Member Data Documentation

§ numPorts

size_t wdfRootNode::numPorts
protected

The number of ports on a root node element.

§ Rp

double wdfRootNode::Rp
protected

The WDF port resistance in Ohm.


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