#include <rt-wdf.h>

Inheritance diagram for wdfRoot:

Public Member Functions
	wdfRoot ()

virtual	~wdfRoot ()

void	setPortResistances (double *Rp)

virtual void	processAscendingWaves (vec ascendingWaves, vec descendingWaves)=0

virtual matData *	getRootMatrPtr ()

virtual std::string	getType () const =0

Constructor & Destructor Documentation

§ wdfRoot()

wdfRoot::wdfRoot ( )

Base class for all root subclasses.

§ ~wdfRoot()

wdfRoot::~wdfRoot ( )

virtual

Deconstructor

Member Function Documentation

§ getRootMatrPtr()

matData * wdfRoot::getRootMatrPtr ( )

virtual

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()

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

pure virtual

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

Returns: a String describing the type of this root

Implemented in wdfRootSimple, wdfRootNL, and wdfRootRtype.

§ processAscendingWaves()

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

pure virtual

Virtual placeholder function that is meant to process a vector of ascending waves in the root and return the result.

Acts a an interface to the root for wdfTree and it's cycleWave() function.

Parameters

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

Implemented in wdfRootSimple, wdfRootNL, and wdfRootRtype.

§ setPortResistances()

void wdfRoot::setPortResistances ( double * Rp )

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.