RT-WDF  0.0.1
Real-time Wave Digital Filter Framework
wdfRootSimple Class Reference

#include <rt-wdf.h>

Inheritance diagram for wdfRootSimple:

Public Member Functions

 wdfRootSimple (wdfRootNode *rootElement)
 
void setPortResistances (double *Rp)
 
virtual void processAscendingWaves (vec *ascendingWaves, vec *descendingWaves)
 
virtual std::string getType () const
 
virtual matDatagetRootMatrPtr ()
 

Constructor & Destructor Documentation

§ wdfRootSimple()

wdfRootSimple::wdfRootSimple ( wdfRootNode rootElement)

Single unadapted closed-form element root implementation.

Parameters
*rootElementpointer

Member Function Documentation

§ getRootMatrPtr()

matData * wdfRoot::getRootMatrPtr ( )
virtualinherited

Virtual function that may return a pointer to a root's rootMatrixData element.

Returns a valid pointer or NULL if not applicable for the specific root subclass. The valid pointer is used to populate or update a root's matrix coefficients by setRootMatrData( ) of the tree.

Returns
matData* to the rootMatrixData element

Reimplemented in wdfRootNL, and wdfRootRtype.

§ getType()

std::string wdfRootSimple::getType ( ) const
virtual

Returns a String describing the type of this root.

Returns
a String describing the type of this root as "Root (Simple-type)"

Implements wdfRoot.

§ processAscendingWaves()

void wdfRootSimple::processAscendingWaves ( vec *  ascendingWaves,
vec *  descendingWaves 
)
virtual

Function to process a vector (of length 1) of the ascending wave towards a single unadapted closed-form root node.

Parameters
*ascendingWavesis a pointer to a vector of waves that were collected at the upfacing ports of the subtrees, traveling into the root.
*descendingWavesis a pointer to a vector to store the resulting waves that leave the root afterprocessing into the subtrees

Implements wdfRoot.

§ setPortResistances()

void wdfRootSimple::setPortResistances ( double *  Rp)

Sets correct port resistance from the subtrees in RootNode.

Parameters
Rpis a vector of port resistances of all subtrees of the root.

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