com.tagtraum.jipes

Class SignalProcessorSupport<IO>

java.lang.Object

com.tagtraum.jipes.SignalProcessorSupport<IO>

Type Parameters:

IO - type of the output values of the corresponding SignalProcessor

public class SignalProcessorSupport<IO>
extends Object

Helper class for implementing SignalProcessors.

Author:

Hendrik Schreiber

Constructor Summary

Constructors

Constructor and Description
SignalProcessorSupport()

Method Summary

Modifier and Type	Method and Description
<O2> SignalProcessor<IO,O2>	connectTo(int channel, SignalProcessor<IO,O2> signalProcessor) Registers a child processor for a specific channel.
<O2> SignalProcessor<IO,O2>	connectTo(SignalProcessor<IO,O2> signalProcessor) Registers a child processor.
<O2> SignalProcessor<IO,O2>	disconnectFrom(int channel, SignalProcessor<IO,O2> signalProcessor) Removes a child processor.
<O> SignalProcessor<IO,O>	disconnectFrom(SignalProcessor<IO,O> signalProcessor) Removes a child processor.
void	flush() Flush all kids.
int	getChannelCount() Number of the channel with the highest channel number which also has children.
SignalProcessor<IO,?>[]	getConnectedProcessors() Lists all registered processors.
SignalProcessor<IO,?>[]	getConnectedProcessors(int channel) Lists all registered processors.
void	process(int channel, IO i) Propagate the output i to all children by calling their SignalProcessor.process(Object) method.
void	process(IO i) Propagate the output i to all children by calling their SignalProcessor.process(Object) method.
void	process(IO[] signal) Propagate the signal to all children by calling their SignalProcessor.process(Object) method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignalProcessorSupport

public SignalProcessorSupport()

Method Detail

connectTo

public <O2> SignalProcessor<IO,O2> connectTo(SignalProcessor<IO,O2> signalProcessor)

Registers a child processor.

Parameters:

signalProcessor - processor

Returns:

the just added processor

See Also:

disconnectFrom(com.tagtraum.jipes.SignalProcessor), getConnectedProcessors()

connectTo

public <O2> SignalProcessor<IO,O2> connectTo(int channel,
                                             SignalProcessor<IO,O2> signalProcessor)

Registers a child processor for a specific channel.

Type Parameters:

O2 - output type of the processor we want to connect to

Parameters:

channel - channel or band

signalProcessor - processor

Returns:

the just added processor

See Also:

disconnectFrom(com.tagtraum.jipes.SignalProcessor), getConnectedProcessors()

disconnectFrom

public <O> SignalProcessor<IO,O> disconnectFrom(SignalProcessor<IO,O> signalProcessor)

Removes a child processor.

Type Parameters:

O - output type of the processor we want to disconnect from

Parameters:

signalProcessor - processor

Returns:

the processor, if it was indeed removed

See Also:

connectTo(com.tagtraum.jipes.SignalProcessor), getConnectedProcessors()

disconnectFrom

public <O2> SignalProcessor<IO,O2> disconnectFrom(int channel,
                                                  SignalProcessor<IO,O2> signalProcessor)

Removes a child processor.

Type Parameters:

O2 - output type of the processor we want to disconnect from

Parameters:

channel - channel or band

signalProcessor - processor

Returns:

the processor, if it was indeed removed

See Also:

connectTo(com.tagtraum.jipes.SignalProcessor), getConnectedProcessors()

getConnectedProcessors

public SignalProcessor<IO,?>[] getConnectedProcessors()

Lists all registered processors.

Returns:

array of registered processors, never null

See Also:

disconnectFrom(com.tagtraum.jipes.SignalProcessor), connectTo(com.tagtraum.jipes.SignalProcessor)

getConnectedProcessors

public SignalProcessor<IO,?>[] getConnectedProcessors(int channel)

Lists all registered processors.

Parameters:

channel - channel or band

Returns:

array of registered processors, never null

See Also:

disconnectFrom(com.tagtraum.jipes.SignalProcessor), connectTo(com.tagtraum.jipes.SignalProcessor)

process

public void process(IO i)
             throws IOException

Propagate the output i to all children by calling their SignalProcessor.process(Object) method.

Parameters:

i - output

Throws:

IOException - if something goes wrong

process

public void process(IO[] signal)
             throws IOException

Propagate the signal to all children by calling their SignalProcessor.process(Object) method.

Parameters:

signal - array of signals for all channels

Throws:

IOException - if something goes wrong

process

public void process(int channel,
                    IO i)
             throws IOException

Propagate the output i to all children by calling their SignalProcessor.process(Object) method.

Parameters:

channel - channel or band

i - output

Throws:

IOException - if something goes wrong

flush

public void flush()
           throws IOException

Flush all kids.

Throws:

IOException - if something goes wrong

getChannelCount

public int getChannelCount()

Number of the channel with the highest channel number which also has children.

Returns:

channel number