iso::synth::MultiplyUnit Class Reference

multiplies value with signal data More...

#include <iso_synth_multiply_unit.h>

Inherits iso::synth::BinaryOpUnit.

Inheritance diagram for iso::synth::MultiplyUnit:

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

[legend]List of all members.

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

---

Detailed Description

multiplies value with signal data

with signal data

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

---

Constructor & Destructor Documentation

MultiplyUnit::MultiplyUnit

(

)

default constructor

MultiplyUnit::MultiplyUnit

(

const String &

pName

)

name constructor

Parameters:

pName

unit name

MultiplyUnit::MultiplyUnit

(

unsigned int

pChannelCount

)

parameter based constructor

Parameters:

pChannelCount

number of channels

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

parameter based constructor

Parameters:

	pName	unit name
	pChannelCount	number of channels

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

parameter based constructor

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

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

name and parameter based constructor

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

MultiplyUnit::MultiplyUnit

(

const Unit &

pUnit

)

copy constructor

Parameters:

pUnit

unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

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

MultiplyUnit::MultiplyUnit

(

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

MultiplyUnit::~MultiplyUnit

(

)

destructor

---

Member Function Documentation

void MultiplyUnit::process

(

Buffer *

pBuffer

)

throw (SynthException) [virtual]

processes buffer

Parameters:

pBuffer

buffer to process

Implements iso::synth::BinaryOpUnit.

String MultiplyUnit::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::ProcessUnit.

---

Friends And Related Function Documentation

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

print unit information

---

Member Data Documentation

const String MultiplyUnit::sClassName [static]

default name

Reimplemented from iso::synth::BinaryOpUnit.

unsigned int MultiplyUnit::sUnitCount [static, protected]

total number of multiply units created so far

Reimplemented from iso::synth::ProcessUnit.

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/unit/proc/op/iso_synth_multiply_unit.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/unit/proc/op/iso_synth_multiply_unit.cpp

---