iso::synth::Encoder Class Reference

#include <iso_synth_encoder.h>

Inherits iso::synth::ProcessUnit.

Inheritance diagram for iso::synth::Encoder:

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

[legend]List of all members.

Public Member Functions
	Encoder ()
	default constructor
	Encoder (const String &pName)
	name constructor
	Encoder (unsigned int pAmbiOrder, unsigned int pAmbiDim) throw (SynthException)
	default constructor
	Encoder (const String &pName, unsigned int pAmbiOrder, unsigned int pAmbiDim) throw (SynthException)
	default constructor
	Encoder (unsigned int pAmbiOrder, unsigned int pAmbiDim, unsigned int pFrameCount, unsigned int pRate, FanInType pFanInType=FANIN_ADD) throw (SynthException)
	name and parameter based contructor
	Encoder (const String &pName, unsigned int pAmbiOrder, unsigned int pAmbiDim, unsigned int pFrameCount, unsigned int pRate, FanInType pFanInType=FANIN_ADD) throw (SynthException)
	name and parameter based contructor
	Encoder (const Encoder &pUnit)
	copy constructor
	Encoder (const String &pName, const Encoder &pUnit)
	name & copy constructor
	Encoder (const data::Values &pValues) throw (SynthException)
	values based constructor
virtual	~Encoder ()
	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
unsigned int	mAmbiOrder
	ambisonics order
unsigned int	mAmbiDim
	ambisonics dimension
ControlPort *	mPosition
	position control port
EncodeStrategy *	mStrategy
	ambisonics encoding strategy
Static Protected Attributes
static unsigned int	sUnitCount
	total number of units created so far
Friends
std::ostream &	operator<< (std::ostream &pOstream, const Encoder &pUnit)
	print unit information

---

Constructor & Destructor Documentation

Encoder::Encoder

(

)

default constructor

Encoder::Encoder

(

const String &

pName

)

name constructor

Parameters:

pName

unit name

Encoder::Encoder	(	unsigned int	pAmbiOrder,
		unsigned int	pAmbiDim
	)			throw (SynthException)

default constructor

Parameters:

	pAmbiOrder	ambisonics order ( > 0 )
	pAmbiDim	ambisonics dimension ( 2 or 3 )

Exceptions:

SynthException

ambisonics order < 1 pr amisonics dimenson != 2 & != 3

Encoder::Encoder	(	const String &	pName,
		unsigned int	pAmbiOrder,
		unsigned int	pAmbiDim
	)			throw (SynthException)

default constructor

Parameters:

	pName	unit name
	pAmbiOrder	ambisonics order ( > 0 )
	pAmbiDim	ambisonics dimension ( 2 or 3 )

Exceptions:

SynthException

ambisonics order < 1 pr amisonics dimenson != 2 & != 3

Encoder::Encoder	(	unsigned int	pAmbiOrder,
		unsigned int	pAmbiDim,
		unsigned int	pFrameCount,
		unsigned int	pRate,
		FanInType	pFanInType = FANIN_ADD
	)			throw (SynthException)

name and parameter based contructor

Parameters:

	pAmbiOrder	ambisonics order ( > 0 )
	pAmbiDim	ambisonics dimension ( 2 or 3 )
	pFrameCount	number of frames
	pRate	samping rate
	pFanInType	strategy for combining audio buffers in case this unit is connected to several units

Encoder::Encoder	(	const String &	pName,
		unsigned int	pAmbiOrder,
		unsigned int	pAmbiDim,
		unsigned int	pFrameCount,
		unsigned int	pRate,
		FanInType	pFanInType = FANIN_ADD
	)			throw (SynthException)

name and parameter based contructor

Parameters:

	pName	unit name
	pAmbiOrder	ambisonics order ( > 0 )
	pAmbiDim	ambisonics dimension ( 2 or 3 )
	pFrameCount	number of frames
	pRate	samping rate
	pFanInType	strategy for combining audio buffers in case this unit is connected to several units

Encoder::Encoder

(

const Encoder &

pUnit

)

copy constructor

Parameters:

pUnit

unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

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

name & copy constructor

Parameters:

	pName	unit name
	pUnit	unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

Encoder::Encoder

(

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 : ambisonics order 2: unsigned int : ambisonics dimension 3: unsigned int : frame count 4: unsigned int : sample rate

Encoder::~Encoder

(

)

[virtual]

destructor

---

Member Function Documentation

void Encoder::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::ProcessUnit.

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

void Encoder::init

(

)

[protected]

initializes ports

---

Friends And Related Function Documentation

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

print unit information

---

Member Data Documentation

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

default name

Reimplemented from iso::synth::ProcessUnit.

unsigned int Encoder::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::ProcessUnit.

unsigned int iso::synth::Encoder::mAmbiOrder [protected]

ambisonics order

unsigned int iso::synth::Encoder::mAmbiDim [protected]

ambisonics dimension

ControlPort* iso::synth::Encoder::mPosition [protected]

position control port

EncodeStrategy* iso::synth::Encoder::mStrategy [protected]

ambisonics encoding strategy

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/unit/proc/ambisonics/iso_synth_encoder.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/unit/proc/ambisonics/iso_synth_encoder.cpp

---