iso::synth::StringNL Class Reference

non linear string model More...

#include <iso_synth_string_nl_unit.h>

Inherits iso::synth::ProcessUnit.

Inheritance diagram for iso::synth::StringNL:

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

[legend]List of all members.

Public Member Functions
	StringNL (float pMaxDelay)
	parameter based contructor
	StringNL (const String &pName, float pMaxDelay)
	parameter based contructor
	StringNL (unsigned int pChannelCount, float pMaxDelay)
	parameter based contructor
	StringNL (const String &pName, unsigned int pChannelCount, float pMaxDelay)
	parameter based contructor
	StringNL (unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate, float pMaxDelay)
	parameter based contructor
	StringNL (const String &pName, unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate, float pMaxDelay)
	name and parameter based contructor
	StringNL (const StringNL &pUnit)
	copy constructor
	StringNL (const String &pName, const StringNL &pUnit)
	name & copy constructor
	StringNL (const data::Values &pValues) throw (SynthException)
	values based constructor
	~StringNL ()
	destructor
virtual void	process (Buffer *pBuffer=NULL) 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 ()
	initializes ports
Protected Attributes
float	mMaxDelay
MultiplyUnit *	mInputScale
DelayUnit *	mDelayUnit
LPIIRFilter *	mFilter
DCBlocker *	mBlocker
EnvFollower *	mEnvFollower
MultiplyUnit *	mDelayScale
AddUnit *	mDelayOffset
Static Protected Attributes
static unsigned int	sUnitCount
	total number of units created so far
Friends
std::ostream &	operator<< (std::ostream &pOstream, const StringNL &pUnit)
	print unit information

---

Detailed Description

non linear string model

string model

Created by Daniel Bisig on 04/16/10.

---

Constructor & Destructor Documentation

StringNL::StringNL

(

float

pMaxDelay

)

parameter based contructor

Parameters:

pMaxDelay

maximum delay (milisecs)

StringNL::StringNL	(	const String &	pName,
		float	pMaxDelay
	)

parameter based contructor

Parameters:

	pName	unit name
	pMaxDelay	maximum delay (milisecs)

StringNL::StringNL	(	unsigned int	pChannelCount,
		float	pMaxDelay
	)

parameter based contructor

Parameters:

	pChannelCount	number of channels
	pMaxDelay	maximum delay (milisecs)

StringNL::StringNL	(	const String &	pName,
		unsigned int	pChannelCount,
		float	pMaxDelay
	)

parameter based contructor

Parameters:

	pName	unit name
	pChannelCount	number of channels
	pMaxDelay	maximum delay (milisecs)

StringNL::StringNL	(	unsigned int	pFrameCount,
		unsigned int	pChannelCount,
		unsigned int	pRate,
		float	pMaxDelay
	)

parameter based contructor

Parameters:

	pFrameCount	number of frames
	pChannelCount	number of channels
	pRate	samping rate
	pMaxDelay	maximum delay (milisecs)

Exceptions:

SynthException

unit ringbuffer channelcount mismatch

StringNL::StringNL	(	const String &	pName,
		unsigned int	pFrameCount,
		unsigned int	pChannelCount,
		unsigned int	pRate,
		float	pMaxDelay
	)

name and parameter based contructor

Parameters:

	pName	unit name
	pFrameCount	number of frames
	pChannelCount	number of channels
	pRate	samping rate
	pMaxDelay	maximum delay (milisecs)

Exceptions:

SynthException

unit ringbuffer channelcount mismatch

StringNL::StringNL

(

const StringNL &

pUnit

)

copy constructor

Parameters:

pUnit

unit to copy properties from

StringNL::StringNL	(	const String &	pName,
		const StringNL &	pUnit
	)

name & copy constructor

Parameters:

	pName	unit name
	pUnit	unit to copy properties from

StringNL::StringNL

(

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 : number of frames 2: unsigned int : number of channels 3: unsigned int : samping rate 4: float : max delay

StringNL::~StringNL

(

)

destructor

---

Member Function Documentation

void StringNL::process

(

Buffer *

pBuffer = NULL

)

throw (SynthException) [virtual]

processes buffer

Parameters:

pBuffer

buffer to process

Reimplemented from iso::synth::ProcessUnit.

String StringNL::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 StringNL::init

(

)

[protected]

initializes ports

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	pOstream,
		const StringNL &	pUnit
	)			[friend]

print unit information

---

Member Data Documentation

const String StringNL::sClassName [static]

default name

Reimplemented from iso::synth::ProcessUnit.

unsigned int StringNL::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::ProcessUnit.

float iso::synth::StringNL::mMaxDelay [protected]

MultiplyUnit* iso::synth::StringNL::mInputScale [protected]

DelayUnit* iso::synth::StringNL::mDelayUnit [protected]

LPIIRFilter* iso::synth::StringNL::mFilter [protected]

DCBlocker* iso::synth::StringNL::mBlocker [protected]

EnvFollower* iso::synth::StringNL::mEnvFollower [protected]

MultiplyUnit* iso::synth::StringNL::mDelayScale [protected]

AddUnit* iso::synth::StringNL::mDelayOffset [protected]

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/unit/gen/iso_synth_string_nl_unit.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/unit/gen/iso_synth_string_nl_unit.cpp

---