iso::synth::ETAUnit Class Reference

received event values are transformed into a continuous "sample-and-hold" stream of data
which can then be connected to any InputPort or ControlPort. This is the base class of the event to audio class tree and features no transformation whatsoever. More...

#include <iso_synth_eta_unit.h>

Inherits iso::synth::InputUnit.

Inherited by iso::synth::ETACustomFadeUnit, iso::synth::ETAFadeToValueUnit, and iso::synth::ETAFadeUnit.

Inheritance diagram for iso::synth::ETAUnit:

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

[legend]List of all members.

Public Member Functions
	ETAUnit ()
	default constructor
	ETAUnit (const String &pName)
	name constructor
	ETAUnit (unsigned int pChannelCount)
	default constructor
	ETAUnit (const String &pName, unsigned int pChannelCount)
	name constructor
	ETAUnit (const String &pName, unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate) throw (SynthException)
	name and parameter based contructor
	ETAUnit (const ETAUnit &pUnit)
	copy constructor
	ETAUnit (const String &pName, const ETAUnit &pUnit)
	name & copy constructor
	ETAUnit (const data::Values &pValues) throw (SynthException)
	values based constructor
virtual	~ETAUnit ()
	destructor
void	setValues (Frame pTargetValues)
	set values
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 unit
Protected Attributes
Frame	mTargetValues
	total number of units created so far
Static Protected Attributes
static unsigned int	sUnitCount
	total number of units created so far

---

Detailed Description

received event values are transformed into a continuous "sample-and-hold" stream of data
which can then be connected to any InputPort or ControlPort. This is the base class of the event to audio class tree and features no transformation whatsoever.

values into continuous audio values

switch ports:
event : event receive port

Created by Daniel Bisig & John Flury on 03/12/08. Copyright 2006 Daniel Bisig All rights reserved.

---

Constructor & Destructor Documentation

ETAUnit::ETAUnit

(

)

default constructor

ETAUnit::ETAUnit

(

const String &

pName

)

name constructor

Parameters:

pName

unit name

ETAUnit::ETAUnit

(

unsigned int

pChannelCount

)

default constructor

Parameters:

pChannelCount

number of channels

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

name constructor

Parameters:

	pName	unit name
	pChannelCount	number of channels

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

ETAUnit::ETAUnit

(

const ETAUnit &

pUnit

)

copy constructor

Parameters:

pUnit

unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

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

name & copy constructor

Parameters:

	pName	unit name
	pUnit	unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

ETAUnit::ETAUnit

(

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

ETAUnit::~ETAUnit

(

)

[virtual]

destructor

---

Member Function Documentation

void ETAUnit::setValues

(

Frame

pTargetValues

)

set values

Parameters:

pTargetValues

( values )

Reimplemented in iso::synth::ETAFadeToValueUnit.

void ETAUnit::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.

Reimplemented in iso::synth::ETACustomFadeUnit, iso::synth::ETAFadeToValueUnit, and iso::synth::ETAFadeUnit.

base::String ETAUnit::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.

Reimplemented in iso::synth::ETACustomFadeUnit, iso::synth::ETAFadeToValueUnit, and iso::synth::ETAFadeUnit.

void ETAUnit::init

(

)

[protected]

initializes unit

Reimplemented in iso::synth::ETACustomFadeUnit, iso::synth::ETAFadeToValueUnit, and iso::synth::ETAFadeUnit.

---

Member Data Documentation

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

default name

Reimplemented from iso::synth::InputUnit.

Reimplemented in iso::synth::ETACustomFadeUnit, iso::synth::ETAFadeToValueUnit, and iso::synth::ETAFadeUnit.

unsigned int ETAUnit::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::InputUnit.

Reimplemented in iso::synth::ETACustomFadeUnit, iso::synth::ETAFadeToValueUnit, and iso::synth::ETAFadeUnit.

Frame iso::synth::ETAUnit::mTargetValues [protected]

total number of units created so far

---

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

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

---