iso::synth::SawtoothUnit Class Reference

#include <iso_synth_sawtooth_unit.h>

Inherits iso::synth::InputUnit.

Inheritance diagram for iso::synth::SawtoothUnit:

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

[legend]List of all members.

Public Member Functions
	SawtoothUnit ()
	default contructor
	SawtoothUnit (const String &pName)
	parameter based contructor
	SawtoothUnit (unsigned int pChannelCount)
	parameter based contructor
	SawtoothUnit (const String &pName, unsigned int pChannelCount)
	parameter based contructor
	SawtoothUnit (unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate) throw (SynthException)
	parameter based contructor
	SawtoothUnit (const String &pName, unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate) throw (SynthException)
	name and parameter based contructor
	SawtoothUnit (const SawtoothUnit &pUnit)
	copy constructor
	SawtoothUnit (const String &pName, const SawtoothUnit &pUnit)
	name & copy constructor
	SawtoothUnit (const data::Values &pValues) throw (SynthException)
	values based constructor
	~SawtoothUnit ()
	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
static const float	N
static sample	INVN
static sample	INVFSN
	n times 2 divided by mrate
Protected Member Functions
void	init ()
	initializes wavetable and control ports
Protected Attributes
ControlPort *	mFrequency
	frequency control port
ControlPort *	mAmplitude
	amplitude control port
ControlPort *	mStartPhase
	phase control port
ControlPort *	mOffset
	offset control port
int *	mPhaseOffsetBuffer
	current phase offsets with regard to start phases
Static Protected Attributes
static unsigned int	sUnitCount
	total number of units created so far
Friends
std::ostream &	operator<< (std::ostream &pOstream, const SawtoothUnit &pUnit)
	print unit information

---

Constructor & Destructor Documentation

SawtoothUnit::SawtoothUnit

(

)

default contructor

SawtoothUnit::SawtoothUnit

(

const String &

pName

)

parameter based contructor

Parameters:

pName

unit name

SawtoothUnit::SawtoothUnit

(

unsigned int

pChannelCount

)

parameter based contructor

Parameters:

pChannelCount

number of channels

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

parameter based contructor

Parameters:

	pName	unit name
	pChannelCount	number of channels

SawtoothUnit::SawtoothUnit	(	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

SawtoothUnit::SawtoothUnit	(	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

SawtoothUnit::SawtoothUnit

(

const SawtoothUnit &

pUnit

)

copy constructor

Parameters:

pUnit

unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

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

name & copy constructor

Parameters:

	pName	unit name
	pUnit	unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

SawtoothUnit::SawtoothUnit

(

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

SawtoothUnit::~SawtoothUnit

(

)

destructor

---

Member Function Documentation

void SawtoothUnit::process

(

Buffer *

pBuffer

)

throw (SynthException) [virtual]

processes buffer

Parameters:

pBuffer

buffer to process

two step processing procedure:
1. calls process function of all it's input ports
2. as soon as these other processing functions return, it changes the buffer according to it's function

Reimplemented from iso::synth::InputUnit.

base::String SawtoothUnit::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 SawtoothUnit::init

(

)

[protected]

initializes wavetable and control ports

---

Friends And Related Function Documentation

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

print unit information

---

Member Data Documentation

const base::String SawtoothUnit::sClassName [static]

default name

Reimplemented from iso::synth::InputUnit.

const sample SawtoothUnit::N [static]

sample SawtoothUnit::INVN [static]

sample SawtoothUnit::INVFSN [static]

n times 2 divided by mrate

unsigned int SawtoothUnit::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::InputUnit.

ControlPort* iso::synth::SawtoothUnit::mFrequency [protected]

frequency control port

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

amplitude control port

ControlPort* iso::synth::SawtoothUnit::mStartPhase [protected]

phase control port

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

offset control port

int* iso::synth::SawtoothUnit::mPhaseOffsetBuffer [protected]

current phase offsets with regard to start phases

---

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

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

---