iso::synth::OutputUnit Class Reference

base class for all units that possess only an input port More...

#include <iso_synth_output_unit.h>

Inherits iso::synth::Unit.

Inherited by iso::synth::ATEUnit, iso::synth::JackOutputUnit, and iso::synth::OutputFile.

Inheritance diagram for iso::synth::OutputUnit:

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

[legend]List of all members.

Public Member Functions
	OutputUnit ()
	default constructor
	OutputUnit (const String &pName, FanInType pFanInType=FANIN_ADD)
	name constructor
	OutputUnit (unsigned int pChannelCount, FanInType pFanInType=FANIN_ADD)
	parameter based contructor
	OutputUnit (const String &pName, unsigned int pChannelCount, FanInType pFanInType=FANIN_ADD)
	parameter based contructor
	OutputUnit (unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate, FanInType pFanInType=FANIN_ADD) throw (SynthException)
	parameter based contructor
	OutputUnit (const String &pName, unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate, FanInType pFanInType=FANIN_ADD) throw (SynthException)
	name and parameter based contructor
	OutputUnit (const Unit &pUnit)
	copy constructor
	OutputUnit (const String &pName, const Unit &pUnit)
	name & copy constructor
	OutputUnit (const data::Values &pValues) throw (SynthException)
	values based constructor
virtual	~OutputUnit ()
	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
Static Protected Attributes
static unsigned int	sUnitCount
	total number of units created so far
Friends
std::ostream &	operator<< (std::ostream &pOstream, const OutputUnit &pUnit)
	print unit information

---

Detailed Description

base class for all units that possess only an input port

for all units that possess only an input port

This class expands the base unit class in that it possesses an output audio port.
This class is the base class for all units that consume audio data.
Instances of this class form the beginning of the process function call chain.
The process function simply ignores any audio data arriving at it's audio input port.

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

Created by Daniel Bisig on 6/26/06.
Copyright 2006 Daniel Bisig All rights reserved.

---

Constructor & Destructor Documentation

OutputUnit::OutputUnit

(

)

default constructor

OutputUnit::OutputUnit	(	const String &	pName,
		FanInType	pFanInType = FANIN_ADD
	)

name constructor

Parameters:

	pName	unit name
	pFanInType	strategy for combining audio buffers in case this unit is connected to several units

OutputUnit::OutputUnit	(	unsigned int	pChannelCount,
		FanInType	pFanInType = FANIN_ADD
	)

parameter based contructor

Parameters:

	pChannelCount	number of channels
	pFanInType	strategy for combining audio buffers in case this unit is connected to several units

OutputUnit::OutputUnit	(	const String &	pName,
		unsigned int	pChannelCount,
		FanInType	pFanInType = FANIN_ADD
	)

parameter based contructor

Parameters:

	pName	unit name
	pChannelCount	number of channels
	pFanInType	strategy for combining audio buffers in case this unit is connected to several units

OutputUnit::OutputUnit	(	unsigned int	pFrameCount,
		unsigned int	pChannelCount,
		unsigned int	pRate,
		FanInType	pFanInType = FANIN_ADD
	)			throw (SynthException)

parameter based contructor

Parameters:

	pFrameCount	number of frames
	pChannelCount	number of channels
	pRate	samping rate
	pFanInType	strategy for combining audio buffers in case this unit is connected to several units

OutputUnit::OutputUnit	(	const String &	pName,
		unsigned int	pFrameCount,
		unsigned int	pChannelCount,
		unsigned int	pRate,
		FanInType	pFanInType = FANIN_ADD
	)			throw (SynthException)

name and parameter based contructor

Parameters:

	pName	unit name
	pFrameCount	number of frames
	pChannelCount	number of channels
	pRate	samping rate
	pFanInType	strategy for combining audio buffers in case this unit is connected to several units

OutputUnit::OutputUnit

(

const Unit &

pUnit

)

copy constructor

Parameters:

pUnit

unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

OutputUnit::OutputUnit	(	const String &	pName,
		const Unit &	pUnit
	)

name & copy constructor

Parameters:

	pName	unit name
	pUnit	unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

OutputUnit::OutputUnit

(

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: FanInType (optional) : strategy for combining audio buffers in case this unit is connected to several units

OutputUnit::~OutputUnit

(

)

[virtual]

destructor

---

Member Function Documentation

void OutputUnit::process

(

Buffer *

pBuffer = NULL

)

throw (SynthException) [virtual]

processes buffer

Parameters:

pBuffer

buffer to process

Reimplemented from iso::synth::Unit.

Reimplemented in iso::synth::JackOutputUnit, iso::synth::OutputFile, iso::synth::ATEAverageUnit, iso::synth::ATEConditionalUnit, iso::synth::ATEMaxAmpUnit, iso::synth::ATEMaxUnit, iso::synth::ATEMinAmpUnit, iso::synth::ATEMinUnit, and iso::synth::ATEUnit.

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

Reimplemented in iso::synth::JackOutputUnit, iso::synth::OutputFile, iso::synth::ATEAverageUnit, iso::synth::ATEConditionalUnit, iso::synth::ATEMaxAmpUnit, iso::synth::ATEMaxUnit, iso::synth::ATEMinAmpUnit, iso::synth::ATEMinUnit, and iso::synth::ATEUnit.

---

Friends And Related Function Documentation

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

print unit information

---

Member Data Documentation

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

default name

Reimplemented from iso::synth::Unit.

Reimplemented in iso::synth::JackOutputUnit, iso::synth::OutputFile, iso::synth::ATEAverageUnit, iso::synth::ATEConditionalUnit, iso::synth::ATEMaxAmpUnit, iso::synth::ATEMaxUnit, iso::synth::ATEMinAmpUnit, iso::synth::ATEMinUnit, and iso::synth::ATEUnit.

unsigned int OutputUnit::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::Unit.

Reimplemented in iso::synth::JackOutputUnit, iso::synth::OutputFile, iso::synth::ATEAverageUnit, iso::synth::ATEConditionalUnit, iso::synth::ATEMaxAmpUnit, iso::synth::ATEMaxUnit, iso::synth::ATEMinAmpUnit, iso::synth::ATEMinUnit, and iso::synth::ATEUnit.

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/unit/iso_synth_output_unit.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/unit/iso_synth_output_unit.cpp

---