iso::synth::ChannelMap Class Reference

stores channel remapping information More...

#include <iso_synth_channel_map.h>

List of all members.

Public Member Functions
	ChannelMap (unsigned int pChannelCount) throw (SynthException)
	parameter based constructor
	ChannelMap (const math::Vector< unsigned int > &pMap) throw (SynthException)
	parameter based constructor
	ChannelMap (unsigned int pChannelCount, unsigned int *pMap) throw (SynthException)
	parameter based constructor
	ChannelMap (unsigned int pChannelCount, unsigned int p1,...) throw (SynthException)
	parameter based constructor
	ChannelMap (const ChannelMap &pChannelMap)
	copy constructor
	ChannelMap (const serialize::SerializeData &pSerializeData) throw (serialize::SerializeException)
	serialization based constructor
	~ChannelMap ()
	destructor
virtual serialize::SerializeData	serialize (const String &pSerialName=sClassName) const
	create serializeData for channel map
unsigned int	mapSize () const
	return number of mapped channels
int	channel (unsigned int pChannelIndex) const throw (SynthException)
	return single target channel index
void	setChannel (unsigned int pChannelIndex, int pMapValue) throw (SynthException)
	set single target channel index
void	setChannels (unsigned int *pMap)
	set channel map
Static Public Member Functions
static serialize::Serializable *	deSerialize (const serialize::SerializeData &pSerializeData) throw (serialize::SerializeException)
	create channel map from SerializeData
Static Public Attributes
static const String	sClassName
	default name
Protected Attributes
unsigned int	mMapSize
	number of mapped channels
int *	mChannelArray
	array of target channel indices
Friends
class	ChannelConversionStrategyManager
std::ostream &	operator<< (std::ostream &pOstream, const ChannelMap &pChannelMap)
	print unit information

---

Detailed Description

stores channel remapping information

remapping information

Created by Daniel Bisig on 6/7/06.

---

Constructor & Destructor Documentation

ChannelMap::ChannelMap

(

unsigned int

pChannelCount

)

throw (SynthException)

parameter based constructor

Parameters:

pChannelCount

number of channels

target channel indices and scaling values are set to zero

ChannelMap::ChannelMap

(

const math::Vector< unsigned int > &

pMap

)

throw (SynthException)

parameter based constructor

Parameters:

pMap

channel map values

ChannelMap::ChannelMap	(	unsigned int	pChannelCount,
		unsigned int *	pMap
	)			throw (SynthException)

parameter based constructor

Parameters:

	pChannelCount	number of channels
	pMap	array of map values

make sure that the number of channels and the number of provided channel indexes is the same!

ChannelMap::ChannelMap	(	unsigned int	pChannelCount,
		unsigned int	p1,
			...
	)			throw (SynthException)

parameter based constructor

Parameters:

	pChannelCount	number of channels
	p1	first of a number of target channel indexes

make sure that the number of channels and the number of provided channel indexes is the same!

ChannelMap::ChannelMap

(

const ChannelMap &

pChannelMap

)

copy constructor

Parameters:

pChannelMap

channel map to copy properties from

ChannelMap::ChannelMap

(

const serialize::SerializeData &

pSerializeData

)

throw (serialize::SerializeException)

serialization based constructor

Parameters:

pSerializeData

serialization data

Exceptions:

SerializeException

failed to create channel map

ChannelMap::~ChannelMap

(

)

destructor

---

Member Function Documentation

serialize::SerializeData ChannelMap::serialize

(

const String &

pSerialName = sClassName

)

const [virtual]

create serializeData for channel map

Returns:

serializeData

serialize::Serializable * ChannelMap::deSerialize

(

const serialize::SerializeData &

pSerializeData

)

throw (serialize::SerializeException) [static]

create channel map from SerializeData

Parameters:

pSerializeData

SerializeData

Returns:

Serializable

Exceptions:

SerializeException

incompatible SerializeData

unsigned int iso::synth::ChannelMap::mapSize

(

)

const [inline]

return number of mapped channels

Returns:

number of mapped channels

int iso::synth::ChannelMap::channel

(

unsigned int

pChannelIndex

)

const throw (SynthException) [inline]

return single target channel index

Parameters:

pChannelIndex

channel index

Returns:

target channel index

void ChannelMap::setChannel	(	unsigned int	pChannelIndex,
		int	pMapValue
	)			throw (SynthException)

set single target channel index

Parameters:

	pChannelIndex	channel index
	pMapValue	map index

void ChannelMap::setChannels

(

unsigned int *

pMap

)

set channel map

Parameters:

pMap

channel map array

---

Friends And Related Function Documentation

friend class ChannelConversionStrategyManager [friend]

std::ostream& operator<<	(	std::ostream &	pOstream,
		const ChannelMap &	pChannelMap
	)			[friend]

print unit information

---

Member Data Documentation

const String ChannelMap::sClassName [static]

default name

unsigned int iso::synth::ChannelMap::mMapSize [protected]

number of mapped channels

int* iso::synth::ChannelMap::mChannelArray [protected]

array of target channel indices

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/strategy/iso_synth_channel_map.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/strategy/iso_synth_channel_map.cpp

---