iso::synth::AbsUnit Class Reference

unit that outputs the absolute value of an input signal.
Usage: Change offset to a value bellow which all values are folded up. Default is zero, which is a standard "abs" operation. Also, you can set outputGain to "-1" to invert output polarity. More...

#include <iso_synth_abs_unit.h>

Inherits iso::synth::ProcessUnit.

Inheritance diagram for iso::synth::AbsUnit:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 AbsUnit ()
 default constructor
 AbsUnit (const String &pName, FanInType pFanInType=FANIN_ADD)
 name constructor
 AbsUnit (unsigned int pChannelCount, FanInType pFanInType=FANIN_ADD)
 parameter based contructor
 AbsUnit (const String &pName, unsigned int pChannelCount, FanInType pFanInType=FANIN_ADD)
 parameter based contructor
 AbsUnit (unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate, FanInType pFanInType=FANIN_ADD) throw (SynthException)
 parameter based contructor
 AbsUnit (const String &pName, unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate, FanInType pFanInType=FANIN_ADD) throw (SynthException)
 name and parameter based contructor
 AbsUnit (const Unit &pUnit)
 copy constructor
 AbsUnit (const String &pName, const Unit &pUnit)
 name & copy constructor
virtual ~AbsUnit ()
 destructor
void setOffset (Frame pOffset)
virtual void process (Buffer *pBuffer) throw (SynthException)
 processes buffer

Static Public Attributes

static const String sClassName
 default name

Protected Member Functions

void init ()
 initialize members

Protected Attributes

Frame mOffsets

Static Protected Attributes

static unsigned int sUnitCount
 total number of units created so far

Detailed Description

unit that outputs the absolute value of an input signal.
Usage: Change offset to a value bellow which all values are folded up. Default is zero, which is a standard "abs" operation. Also, you can set outputGain to "-1" to invert output polarity.

absolute value of an input signal

SwitchPorts:
name: offset channelCount: n resizable: false function: setOffset

Created by John Flury on 28/03/08.
Copyright 2008 I.S.O. All rights reserved.


Constructor & Destructor Documentation

AbsUnit::AbsUnit (  ) 

default constructor

AbsUnit::AbsUnit ( const String pName,
FanInType  pFanInType = FANIN_ADD 
)

name constructor

Parameters:
pName unit name
pFanInType strategy for combining audio buffers in case this unit is connected to several units

AbsUnit::AbsUnit ( unsigned int  pChannelCount,
FanInType  pFanInType = FANIN_ADD 
)

parameter based contructor

Parameters:
pChannelCount number of channels
pFanInType strategy for combining audio buffers in case this unit is connected to several units

AbsUnit::AbsUnit ( const String pName,
unsigned int  pChannelCount,
FanInType  pFanInType = FANIN_ADD 
)

parameter based contructor

Parameters:
pName unit name
pChannelCount number of channels
pFanInType strategy for combining audio buffers in case this unit is connected to several units

AbsUnit::AbsUnit ( unsigned int  pFrameCount,
unsigned int  pChannelCount,
unsigned int  pRate,
FanInType  pFanInType = FANIN_ADD 
) throw (SynthException)

parameter based contructor

Parameters:
pFrameCount number of frames
pChannelCount number of channels
pRate samping rate
pFanInType strategy for combining audio buffers in case this unit is connected to several units

AbsUnit::AbsUnit ( const String pName,
unsigned int  pFrameCount,
unsigned int  pChannelCount,
unsigned int  pRate,
FanInType  pFanInType = FANIN_ADD 
) throw (SynthException)

name and parameter based contructor

Parameters:
pName unit name
pFrameCount number of frames
pChannelCount number of channels
pRate samping rate
pFanInType strategy for combining audio buffers in case this unit is connected to several units

AbsUnit::AbsUnit ( const Unit pUnit  ) 

copy constructor

Parameters:
pUnit unit to copy properties from
constructor copies frameCount, channelCount and rate but not unit name

AbsUnit::AbsUnit ( const String pName,
const Unit pUnit 
)

name & copy constructor

Parameters:
pName unit name
pUnit unit to copy properties from
constructor copies frameCount, channelCount and rate but not unit name

AbsUnit::~AbsUnit (  )  [virtual]

destructor


Member Function Documentation

void AbsUnit::setOffset ( Frame  pOffset  ) 

void AbsUnit::process ( Buffer pBuffer  )  throw (SynthException) [virtual]

processes buffer

Parameters:
pBuffer buffer to process

Reimplemented from iso::synth::ProcessUnit.

void AbsUnit::init (  )  [protected]

initialize members


Member Data Documentation

const String AbsUnit::sClassName [static]

default name

Reimplemented from iso::synth::ProcessUnit.

unsigned int AbsUnit::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::ProcessUnit.

Frame iso::synth::AbsUnit::mOffsets [protected]


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