iso::synth::Link Class Reference

connection between ports More...

#include <iso_synth_link.h>

Collaboration diagram for iso::synth::Link:

[legend]List of all members.

Public Member Functions
	Link (InputPort *pInputPort, OutputPort *pOutputPort, ChannelMap *pMap=NULL) throw (SynthException)
	paramater based contructor
	~Link ()
	destructor
const String &	name () const
	returns link name
InputPort *	inputPort ()
	returns input port
OutputPort *	outputPort ()
	returns output port
unsigned long	processStep ()
	returns process step
ChannelMap *	channelMap ()
	returns channel map
void	process (Buffer *pBuffer)
	signal processing
String	info (bool pPropagate=false) const
	obtain textual link information
void	fade (sample pDuration, LinkFadeMode pFadeMode)
	fade link
bool	fading () const
	check if link is fading
Static Public Attributes
static const String	sClassName
	default name
Protected Member Functions
	Link ()
	default constructor
Protected Attributes
String	mName
	link name
InputPort *	mInputPort
	associated input port
OutputPort *	mOutputPort
	associated output port
ChannelMap *	mChannelMap
	channelMap;
LinkConversionStrategy *	mConversionStrategy
	if not NULL: controls link conversion strategy
LinkFadeStrategy *	mLinkFadeStrategy
	link fade strategy
unsigned long	mProcessStep
	number of times the link has executed it's process function
Friends
std::ostream &	operator<< (std::ostream &pOstream, const Link &pLink)
	print link information

---

Detailed Description

connection between ports

ports

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

---

Constructor & Destructor Documentation

Link::Link	(	InputPort *	pInputPort,
		OutputPort *	pOutputPort,
		ChannelMap *	pMap = NULL
	)			throw (SynthException)

paramater based contructor

Parameters:

	pInputPort	input port
	pOutputPort	output port
	pMap	channel map

Link::~Link

(

)

destructor

Link::Link

(

)

[protected]

default constructor

---

Member Function Documentation

const base::String & Link::name

(

)

const

returns link name

Returns:

String containing link name

InputPort * Link::inputPort

(

)

returns input port

Returns:

pointer to input port

OutputPort * Link::outputPort

(

)

returns output port

Returns:

pointer to output port

unsigned long Link::processStep

(

)

returns process step

Returns:

process step

ChannelMap * Link::channelMap

(

)

returns channel map

Returns:

channel map or zero if there is none

void Link::process

(

Buffer *

pBuffer

)

signal processing

base::String Link::info

(

bool

pPropagate = false

)

const

obtain textual link information

Parameters:

pPropagate

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

Returns:

String containing link information

void Link::fade	(	sample	pDuration,
		LinkFadeMode	pFadeMode
	)

fade link

Parameters:

	pDuration	fade duration in milisecs
	pFadeMode	fade mode

Remarks:

: function is ignored if link is already fading

bool Link::fading

(

)

const

check if link is fading

Returns:

true if links is fading, false otherwise

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	pOstream,
		const Link &	pLink
	)			[friend]

print link information

---

Member Data Documentation

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

default name

String iso::synth::Link::mName [protected]

link name

InputPort* iso::synth::Link::mInputPort [protected]

associated input port

OutputPort* iso::synth::Link::mOutputPort [protected]

associated output port

ChannelMap* iso::synth::Link::mChannelMap [protected]

channelMap;

LinkConversionStrategy* iso::synth::Link::mConversionStrategy [protected]

if not NULL: controls link conversion strategy

LinkFadeStrategy* iso::synth::Link::mLinkFadeStrategy [protected]

link fade strategy

used mainly for fading a link that is going to be disconnected or has recently been connected NULL if link is not fading

unsigned long iso::synth::Link::mProcessStep [protected]

number of times the link has executed it's process function

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/link/iso_synth_link.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/link/iso_synth_link.cpp

---