iso::synth::InputPort Class Reference

input port More...

#include <iso_synth_input_port.h>

Inherits iso::synth::AudioPort.

Inherited by iso::synth::ControlPort.

Inheritance diagram for iso::synth::InputPort:

Inheritance graph
[legend]
Collaboration diagram for iso::synth::InputPort:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 InputPort (Unit *pUnit, FanInType pFanInType=FANIN_ADD)
 parameter based contructor
 InputPort (const String &pName, Unit *pUnit, FanInType pFanInType=FANIN_ADD)
 name and parameter based contructor
 InputPort (Unit *pUnit, unsigned int pFrameCount, unsigned int pChannelCount, sample pRate, FanInType pFanInType=FANIN_ADD)
 parameter based contructor
 InputPort (const String &pName, Unit *pUnit, unsigned int pFrameCount, unsigned int pChannelCount, sample pRate, FanInType pFanInType=FANIN_ADD)
 parameter based contructor
virtual ~InputPort ()
 destructor
FanInType fanInType () const
 return FanIn Type
virtual void addLink (Link *pLink)
 add link to port
virtual void removeLink (Link *pLink)
 removes link from output port
bool checkConnection (OutputPort *pPort)
 check if input port is connected to output port
bool checkConnection (Unit *pUnit)
 check if input port is connected to unit
virtual void disconnect ()
 removes all links to this input port
virtual void disconnect (Unit *pUnit)
 removes single link from input port to particular unit
virtual void process (Buffer *pBuffer)
 signal processing function
virtual String info (bool pPropagate=false) const
 obtain textual inport port information

Static Public Attributes

static const String sClassName
 default name

Protected Member Functions

 InputPort ()
 default constructor
Linklink (OutputPort *pPort) throw (SynthException)
 return link

Protected Attributes

FanInType mFanInType
 strategy for combining audio buffers in case this port is connected to several units
BuffermOffsetValueBuffer
 offset value buffer

Friends

class Unit
class DisconnectPortEvent
std::ostream & operator<< (std::ostream &pOstream, const InputPort &pPort)
 print audio port information

Detailed Description

input port

input port

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


Constructor & Destructor Documentation

InputPort::InputPort ( Unit pUnit,
FanInType  pFanInType = FANIN_ADD 
)

parameter based contructor

Parameters:
pUnit the unit this input port belongs to
pFanInType strategy for combining audio buffers in case this port is connected to several units

InputPort::InputPort ( const String pName,
Unit pUnit,
FanInType  pFanInType = FANIN_ADD 
)

name and parameter based contructor

Parameters:
pName name of the input port
pUnit the unit this input port belongs to
pFanInType strategy for combining audio buffers in case this port is connected to several units

InputPort::InputPort ( Unit pUnit,
unsigned int  pFrameCount,
unsigned int  pChannelCount,
sample  pRate,
FanInType  pFanInType = FANIN_ADD 
)

parameter based contructor

Parameters:
pUnit synth unit this port is attached to
pFrameCount frame count
pChannelCount channel count
pRate frame rate
pFanInType strategy for combining audio buffers in case this port is connected to several units

InputPort::InputPort ( const String pName,
Unit pUnit,
unsigned int  pFrameCount,
unsigned int  pChannelCount,
sample  pRate,
FanInType  pFanInType = FANIN_ADD 
)

parameter based contructor

Parameters:
pName name of the input port
pUnit synth unit this port is attached to
pFrameCount frame count
pChannelCount channel count
pRate frame rate
pFanInType strategy for combining audio buffers in case this port is connected to several units

InputPort::~InputPort (  )  [virtual]

destructor

InputPort::InputPort (  )  [protected]

default constructor


Member Function Documentation

FanInType InputPort::fanInType (  )  const

return FanIn Type

void InputPort::addLink ( Link pLink  )  [virtual]

add link to port

Parameters:
pLink link that is added to port
warning, this method does not check whether units connect multiple times!

Implements iso::synth::AudioPort.

void InputPort::removeLink ( Link pLink  )  [virtual]

removes link from output port

Parameters:
pLink link that is removed from port

Implements iso::synth::AudioPort.

bool InputPort::checkConnection ( OutputPort pPort  ) 

check if input port is connected to output port

Returns:
true if it is connected, false otherwise

bool InputPort::checkConnection ( Unit pUnit  ) 

check if input port is connected to unit

Returns:
true if it is connected, false otherwise

void InputPort::disconnect (  )  [virtual]

removes all links to this input port

void InputPort::disconnect ( Unit pUnit  )  [virtual]

removes single link from input port to particular unit

Parameters:
pUnit unit this input port is to be disconnected from

void InputPort::process ( Buffer pBuffer  )  [virtual]

signal processing function

Parameters:
pBuffer signal data

Implements iso::synth::AudioPort.

Reimplemented in iso::synth::ControlPort.

base::String InputPort::info ( bool  pPropagate = false  )  const [virtual]

obtain textual inport port information

Parameters:
pPropagate if true, the input port calls the info method of it's associated Link
Returns:
String containing input port information

Reimplemented from iso::synth::AudioPort.

Reimplemented in iso::synth::ControlPort.

Link * InputPort::link ( OutputPort pPort  )  throw (SynthException) [protected]

return link

Parameters:
pPort output port
Returns:
link
Exceptions:
SynthException no link to port


Friends And Related Function Documentation

friend class Unit [friend]

Reimplemented in iso::synth::ControlPort.

friend class DisconnectPortEvent [friend]

std::ostream& operator<< ( std::ostream &  pOstream,
const InputPort pPort 
) [friend]

print audio port information


Member Data Documentation

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

default name

Reimplemented from iso::synth::AudioPort.

Reimplemented in iso::synth::ControlPort.

FanInType iso::synth::InputPort::mFanInType [protected]

strategy for combining audio buffers in case this port is connected to several units

Buffer* iso::synth::InputPort::mOffsetValueBuffer [protected]

offset value buffer

buffer value that is added to the any buffer values arriving at this port


The documentation for this class was generated from the following files:
Generated on Fri Feb 25 14:18:42 2011 for synth by  doxygen 1.5.1