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

#include <rt-wdf.h>

Inheritance diagram for wdfRootRtype:

Public Member Functions

 wdfRootRtype (int numSubtrees)
 
 ~wdfRootRtype ()
 
virtual void processAscendingWaves (vec *ascendingWaves, vec *descendingWaves)
 
virtual matDatagetRootMatrPtr ()
 
virtual std::string getType () const
 
void setPortResistances (double *Rp)
 

Constructor & Destructor Documentation

§ wdfRootRtype()

wdfRootRtype::wdfRootRtype ( int  numSubtrees)

R-type root implementation.

Parameters
numSubtreesspecifies the number of subtrees which are connected to the root to correctly allocate memory for rootMatrixData

§ ~wdfRootRtype()

wdfRootRtype::~wdfRootRtype ( )

Deconstructor

Member Function Documentation

§ getRootMatrPtr()

matData * wdfRootRtype::getRootMatrPtr ( )
virtual

Function that returns a pointer to the rootMatrixData element.

The pointer is be used to populate or update the S-Matrix of the R-type adapter by the setRootMatrData() function of the tree.

Returns
matData* to the rootMatrixData element

Reimplemented from wdfRoot.

§ getType()

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

Returns a String describing the type of this root.

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

Implements wdfRoot.

§ processAscendingWaves()

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

Function to process a vector of ascending waves in the root and return the descending result.

Scatters the incoming waves according to the S-Matrix of rootMatrixData.

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 wdfRoot::setPortResistances ( double *  Rp)
inherited

Function that does nothing if not overwritten by a method in a subclass.

Acts as an interface towards the tree to do anything with the subtree's upfacing port resistances in the root. Is called during adaptation of the WDF structure.

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

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