iso::synth::OutputPort Class Reference

audio signal output port More...

#include <iso_synth_output_port.h>

Inherits iso::synth::AudioPort.

Inherited by iso::synth::InternalPort.

Inheritance diagram for iso::synth::OutputPort:

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

[legend]List of all members.

Public Member Functions
	OutputPort (Unit *pUnit)
	parameter based contructor
	OutputPort (const String &pName, Unit *pUnit)
	name and parameter based contructor
	~OutputPort ()
	destructor
virtual void	setChannelCount (unsigned int pChannelCount) throw (SynthException)
	set channel count
virtual void	setFrameCount (unsigned int pFrameCount) throw (SynthException)
	set frame count
virtual void	setRate (sample pRate) throw (SynthException)
	set frame rate
void	addLink (Link *pLink)
	add link to port
void	removeLink (Link *pLink)
	removes link from output port
virtual void	connect (InputPort *pInputPort, ChannelMap *pMap=NULL)
	links output port to input port
virtual void	process (Buffer *pBuffer)
	signal processing
virtual String	info (bool pPropagate=false) const
	obtain textual output port information
Static Public Attributes
static const String	sClassName
	default name
Protected Member Functions
	OutputPort ()
	default constructor
void	createOutputGain ()
	create output gain control port
Protected Attributes
ControlPort *	mOutputGain
	output gain
Friends
class	InputPort
std::ostream &	operator<< (std::ostream &pOstream, const OutputPort &pPort)
	print port information

---

Detailed Description

audio signal output port

output port

Created by Daniel Bisig on 5/18/06. Copyright 2006 __MyCompanyName__. All rights reserved.

---

Constructor & Destructor Documentation

OutputPort::OutputPort

(

Unit *

pUnit

)

parameter based contructor

Parameters:

pUnit

the unit this output port belongs to

OutputPort::OutputPort	(	const String &	pName,
		Unit *	pUnit
	)

name and parameter based contructor

Parameters:

	pName	name of the output port
	pUnit	the unit this input port belongs to

OutputPort::~OutputPort

(

)

destructor

OutputPort::OutputPort

(

)

[protected]

default constructor

---

Member Function Documentation

void OutputPort::setChannelCount

(

unsigned int

pChannelCount

)

throw (SynthException) [virtual]

set channel count

Parameters:

pChannelCount

channel count

Exceptions:

SynthException

channel count change not possible

Reimplemented from iso::synth::AudioPort.

void OutputPort::setFrameCount

(

unsigned int

pFrameCount

)

throw (SynthException) [virtual]

set frame count

Parameters:

pFrameCount

frame count

Exceptions:

SynthException

frame count not a power of two or frame count change not possible

Reimplemented from iso::synth::AudioPort.

void OutputPort::setRate

(

sample

pRate

)

throw (SynthException) [virtual]

set frame rate

Parameters:

pRate

frame rate

Exceptions:

SynthException

frame rate change not possible

Reimplemented from iso::synth::AudioPort.

void OutputPort::addLink

(

Link *

pLink

)

[virtual]

add link to port

Parameters:

pLink

link that is added to port

warning, this method does not check whether units connect multiple times!

Implements iso::synth::AudioPort.

void OutputPort::removeLink

(

Link *

pLink

)

[virtual]

removes link from output port

Parameters:

pLink

link that is removed from port

Implements iso::synth::AudioPort.

void OutputPort::connect	(	InputPort *	pInputPort,
		ChannelMap *	pMap = NULL
	)			[virtual]

links output port to input port

Parameters:

	pInputPort	input port to which output port is connected to
	pMap	channel map

Reimplemented in iso::synth::InternalPort.

void OutputPort::process

(

Buffer *

pBuffer

)

[virtual]

signal processing

Parameters:

pBuffer

signal buffer

Implements iso::synth::AudioPort.

Reimplemented in iso::synth::InternalPort.

base::String OutputPort::info

(

bool

pPropagate = false

)

const [virtual]

obtain textual output port information

Parameters:

pPropagate

if true, the output port calls the info method of it's associated Unit

Returns:

String containing output port information

Reimplemented from iso::synth::AudioPort.

void OutputPort::createOutputGain

(

)

[protected]

create output gain control port

---

Friends And Related Function Documentation

friend class InputPort [friend]

std::ostream& operator<<	(	std::ostream &	pOstream,
		const OutputPort &	pPort
	)			[friend]

print port information

---

Member Data Documentation

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

default name

Reimplemented from iso::synth::AudioPort.

ControlPort* iso::synth::OutputPort::mOutputGain [protected]

output gain

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/port/iso_synth_output_port.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/port/iso_synth_output_port.cpp

---