iso::synth::Noise Class Reference

simple uniform noise generator More...

#include <iso_synth_noise.h>

Inherits iso::synth::InputUnit.

Inheritance diagram for iso::synth::Noise:

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

[legend]List of all members.

Public Member Functions
	Noise ()
	default constructor
	Noise (const String &pName)
	parameter based contructor
	Noise (unsigned int pChannelCount)
	parameter based contructor
	Noise (const String &pName, unsigned int pChannelCount)
	parameter based contructor
	Noise (unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate) throw (SynthException)
	parameter based contructor
	Noise (const String &pName, unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate) throw (SynthException)
	name and parameter based contructor
	Noise (const Noise &pUnit)
	copy constructor
	Noise (const String &pName, const Noise &pUnit)
	name & copy constructor
	Noise (const data::Values &pValues) throw (SynthException)
	values based constructor
	~Noise ()
	destructor
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 ()
	initializes wavetable and control ports
Protected Attributes
ControlPort *	mAmplitude
	amplitude control port
ControlPort *	mOffset
	amplitude control port
Static Protected Attributes
static unsigned int	sUnitCount
	total number of units created so far
Friends
std::ostream &	operator<< (std::ostream &pOstream, const Noise &pUnit)
	print unit information

---

Detailed Description

simple uniform noise generator

noise generator

simple white noise generator.


ControlPorts
name: amplitude defaultValue: 1.0
name: offset defaultValue: 0.0

SwitchPorts:
name: active channelCount: 1 defaultValue: 1.0 resizable: false function: setActive


Created by Daniel Bisig on 9/03/06.

---

Constructor & Destructor Documentation

Noise::Noise

(

)

default constructor

Noise::Noise

(

const String &

pName

)

parameter based contructor

Parameters:

pName

unit name

Noise::Noise

(

unsigned int

pChannelCount

)

parameter based contructor

Parameters:

pChannelCount

number of channels

Noise::Noise	(	const String &	pName,
		unsigned int	pChannelCount
	)

parameter based contructor

Parameters:

	pName	unit name
	pChannelCount	number of channels

Noise::Noise	(	unsigned int	pFrameCount,
		unsigned int	pChannelCount,
		unsigned int	pRate
	)			throw (SynthException)

parameter based contructor

Parameters:

	pFrameCount	number of frames
	pChannelCount	number of channels
	pRate	samping rate

Noise::Noise	(	const String &	pName,
		unsigned int	pFrameCount,
		unsigned int	pChannelCount,
		unsigned int	pRate
	)			throw (SynthException)

name and parameter based contructor

Parameters:

	pName	unit name
	pFrameCount	number of frames
	pChannelCount	number of channels
	pRate	samping rate

Noise::Noise

(

const Noise &

pUnit

)

copy constructor

Parameters:

pUnit

unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

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

name & copy constructor

Parameters:

	pName	unit name
	pUnit	unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

Noise::Noise

(

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

Noise::~Noise

(

)

destructor

---

Member Function Documentation

void Noise::process

(

Buffer *

pBuffer

)

throw (SynthException) [virtual]

processes buffer

Parameters:

pBuffer

buffer to process

Reimplemented from iso::synth::InputUnit.

String Noise::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::InputUnit.

void Noise::init

(

)

[protected]

initializes wavetable and control ports

---

Friends And Related Function Documentation

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

print unit information

---

Member Data Documentation

const String Noise::sClassName [static]

default name

Reimplemented from iso::synth::InputUnit.

unsigned int Noise::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::InputUnit.

ControlPort* iso::synth::Noise::mAmplitude [protected]

amplitude control port

ControlPort* iso::synth::Noise::mOffset [protected]

amplitude control port

---

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

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

---