iso::synth::EnvelopeFollowerUnit Class Reference

#include <iso_synth_envelope_follower.h>

Inherits iso::synth::ProcessUnit.

Inheritance diagram for iso::synth::EnvelopeFollowerUnit:

[legend]Collaboration diagram for iso::synth::EnvelopeFollowerUnit:

[legend]List of all members.

Public Member Functions
	EnvelopeFollowerUnit () throw (SynthException)
	default constructor
	EnvelopeFollowerUnit (unsigned int pChannelCount) throw (SynthException)
	parameter based contructor
	EnvelopeFollowerUnit (const data::Values &pValues) throw (SynthException)
	values based constructor
	~EnvelopeFollowerUnit () throw (SynthException)
	destructor
void	setDecay (math::Vector< sample > pDecay)
virtual void	process (Buffer *pBuffer) throw (SynthException)
	processes buffer
virtual String	info (bool pPropagate=false, bool pShowPorts=true) const
	obtain textual unit information
Static Public Attributes
static const String	sClassName
	default name
Protected Member Functions
void	init () throw (SynthException)
	called by constructor Exceptions: SynthException  failed to initialize unit
Protected Attributes
QVector< sample >	mDecay
	decay values of each channel (value = max linear amplitude fallof during 1 s)
QVector< sample >	mPreviousPeak
	previous peaks
Static Protected Attributes
static unsigned int	sUnitCount
	total number of units created so far

---

Constructor & Destructor Documentation

EnvelopeFollowerUnit::EnvelopeFollowerUnit

(

)

throw (SynthException)

default constructor

EnvelopeFollowerUnit::EnvelopeFollowerUnit

(

unsigned int

pChannelCount

)

throw (SynthException)

parameter based contructor

Parameters:

pChannelCount

channel count

EnvelopeFollowerUnit::EnvelopeFollowerUnit

(

const data::Values &

pValues

)

throw (SynthException)

values based constructor

Parameters:

pValues

unit values

Exceptions:

SynthException

failed to create unit

pValues structure & data types: 0: const String& : unit name 1: unsigned int : channel count

EnvelopeFollowerUnit::~EnvelopeFollowerUnit

(

)

throw (SynthException)

destructor

---

Member Function Documentation

void EnvelopeFollowerUnit::setDecay

(

math::Vector< sample >

pDecay

)

void EnvelopeFollowerUnit::process

(

Buffer *

pBuffer

)

throw (SynthException) [virtual]

processes buffer

Parameters:

pBuffer

buffer to process

Reimplemented from iso::synth::ProcessUnit.

String EnvelopeFollowerUnit::info	(	bool	pPropagate = false,
		bool	pShowPorts = true
	)			const [virtual]

obtain textual unit information

Parameters:

	pPropagate	if true, the unit calls the info methods of its input ports
	pShowPorts	print port information

Returns:

String containing unit information

Reimplemented from iso::synth::ProcessUnit.

void EnvelopeFollowerUnit::init

(

)

throw (SynthException) [protected]

called by constructor

Exceptions:

SynthException

failed to initialize unit

---

Member Data Documentation

const String EnvelopeFollowerUnit::sClassName [static]

default name

Reimplemented from iso::synth::ProcessUnit.

unsigned int EnvelopeFollowerUnit::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::ProcessUnit.

QVector<sample> iso::synth::EnvelopeFollowerUnit::mDecay [protected]

decay values of each channel (value = max linear amplitude fallof during 1 s)

QVector<sample> iso::synth::EnvelopeFollowerUnit::mPreviousPeak [protected]

previous peaks

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/unit/util/iso_synth_envelope_follower.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/unit/util/iso_synth_envelope_follower.cpp

---