iso::synth::CTFUnit Class Reference

converts a multi channel single frame buffer on its control port into a single channel multi frame buffer at its output port More...

#include <iso_synth_ctf_unit.h>

Inherits iso::synth::InputUnit.

Inheritance diagram for iso::synth::CTFUnit:

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

[legend]List of all members.

Public Member Functions
	CTFUnit ()
	default constructor
	CTFUnit (const String &pName)
	name constructor
	CTFUnit (const String &pName, unsigned int pFrameCount, unsigned int pRate) throw (SynthException)
	name and parameter based contructor
	CTFUnit (const String &pName, const CTFUnit &pUnit)
	name & copy constructor
	CTFUnit (const data::Values &pValues) throw (SynthException)
	values based constructor
virtual	~CTFUnit ()
	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
Protected Member Functions
void	init ()
	initializes ports
Protected Attributes
ControlPort *	mControlPort
	control port
Static Protected Attributes
static unsigned int	sUnitCount
	total number of multiply units created so far
Friends
std::ostream &	operator<< (std::ostream &pOstream, const CTFUnit &pUnit)
	print unit information

---

Detailed Description

converts a multi channel single frame buffer on its control port into a single channel multi frame buffer at its output port

multi channel single frame buffer on its control port into a single channel multi frame buffer at its output port

control ports:
frames : multi channel single frame port

Created by Daniel Bisig on 4/23/08.

---

Constructor & Destructor Documentation

CTFUnit::CTFUnit

(

)

default constructor

CTFUnit::CTFUnit

(

const String &

pName

)

name constructor

Parameters:

pName

unit name

CTFUnit::CTFUnit	(	const String &	pName,
		unsigned int	pFrameCount,
		unsigned int	pRate
	)			throw (SynthException)

name and parameter based contructor

Parameters:

	pName	unit name
	pFrameCount	number of frames
	pRate	samping rate

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

name & copy constructor

Parameters:

	pName	unit name
	pUnit	unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

CTFUnit::CTFUnit

(

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 : samping rate

CTFUnit::~CTFUnit

(

)

[virtual]

destructor

---

Member Function Documentation

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

String CTFUnit::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 CTFUnit::init

(

)

[protected]

initializes ports

---

Friends And Related Function Documentation

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

print unit information

---

Member Data Documentation

const String CTFUnit::sClassName [static]

default name

Reimplemented from iso::synth::InputUnit.

unsigned int CTFUnit::sUnitCount [static, protected]

total number of multiply units created so far

Reimplemented from iso::synth::InputUnit.

ControlPort* iso::synth::CTFUnit::mControlPort [protected]

control port

---

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

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

---