com.jsyn.ports

Class UnitInputPort

java.lang.Object

com.jsyn.ports.UnitPort

com.jsyn.ports.UnitBlockPort

com.jsyn.ports.UnitInputPort

All Implemented Interfaces:

ConnectableInput, GettablePort, SettablePort

Direct Known Subclasses:

UnitGatePort

public class UnitInputPort
extends UnitBlockPort
implements ConnectableInput, SettablePort

A port that is used to pass values into a UnitGenerator.

Author:

Phil Burk 2009 Mobileer Inc

Constructor Summary

Constructors

Constructor and Description
UnitInputPort(int numParts, java.lang.String name)
UnitInputPort(int numParts, java.lang.String name, double defaultValue)
UnitInputPort(java.lang.String name)
UnitInputPort(java.lang.String name, double defaultValue)

Method Summary

Modifier and Type	Method and Description
void	connect(ConnectableOutput other)
void	connect(int thisPartNum, UnitOutputPort otherPort, int otherPartNum) Connect an input to an output port.
void	connect(int thisPartNum, UnitOutputPort otherPort, int otherPartNum, TimeStamp timeStamp)
void	connect(UnitOutputPort otherPort)
void	disconnect(ConnectableOutput other)
void	disconnect(int thisPartNum, UnitOutputPort otherPort, int otherPartNum)
double	get(int partNum) Value of a port based on the set() calls.
ConnectableInput	getConnectablePart(int i)
double	getDefault()
double	getMaximum()
double	getMinimum()
PortBlockPart	getPortBlockPart() This is used internally by PortBlockPart to make a connection between specific parts of a port.
boolean	isValueAdded()
protected void	makeParts(int numParts, double defaultValue)
void	printConnections(java.io.PrintStream out, int level)
void	pullData(long frameCount, int start, int limit) This is used internally by the SynthesisEngine to execute units based on their connections.
void	set(double value)
void	set(double value, double time)
void	set(double value, TimeStamp time)
void	set(int partNum, double value)
void	set(int partNum, double value, double time)
void	set(int partNum, double value, TimeStamp timeStamp)
void	setDefault(double defaultValue)
void	setMaximum(double maximum) The minimum and maximum are only used when setting up knobs or other control systems.
void	setMinimum(double minimum)
void	setup(double minimum, double value, double maximum) Convenience function for setting limits on a port.
void	setup(UnitInputPort other)
void	setValueAdded(boolean valueAdded) If set false then the set() value will be ignored when other ports are connected to this port.
protected void	setValueInternal(int partNum, double value) Only for use in the audio thread when implementing UnitGenerators.

Methods inherited from class com.jsyn.ports.UnitBlockPort

disconnectAll, disconnectAll, get, getNumParts, getValue, getValue, getValues, getValues, isConnected, isConnected, setValueInternal

Methods inherited from class com.jsyn.ports.UnitPort

getName, getUnitGenerator, queueCommand, scheduleCommand, setName, setUnitGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jsyn.ports.GettablePort

getName, getNumParts, getUnitGenerator, getValue

Constructor Detail

UnitInputPort

public UnitInputPort(int numParts,
                     java.lang.String name,
                     double defaultValue)

Parameters:

numParts - typically 1, use 2 for stereo ports

name - name that may be used in GUIs

defaultValue -

UnitInputPort

public UnitInputPort(java.lang.String name,
                     double defaultValue)

UnitInputPort

public UnitInputPort(java.lang.String name)

UnitInputPort

public UnitInputPort(int numParts,
                     java.lang.String name)

Method Detail

makeParts

protected void makeParts(int numParts,
                         double defaultValue)

Overrides:

makeParts in class UnitBlockPort

pullData

public void pullData(long frameCount,
                     int start,
                     int limit)

This is used internally by the SynthesisEngine to execute units based on their connections.

Specified by:

pullData in interface ConnectableInput

Parameters:

frameCount -

start -

limit -

setValueInternal

protected void setValueInternal(int partNum,
                                double value)

Description copied from class: UnitBlockPort

Only for use in the audio thread when implementing UnitGenerators.

Overrides:

setValueInternal in class UnitBlockPort

set

public void set(double value)

set

public void set(int partNum,
                double value)

set

public void set(double value,
                TimeStamp time)

set

public void set(double value,
                double time)

set

public void set(int partNum,
                double value,
                double time)

set

public void set(int partNum,
                double value,
                TimeStamp timeStamp)

Specified by:

set in interface SettablePort

get

public double get(int partNum)

Value of a port based on the set() calls. Not affected by connected ports.

Overrides:

get in class UnitBlockPort

Parameters:

partNum -

Returns:

value as set

getMaximum

public double getMaximum()

setMaximum

public void setMaximum(double maximum)

The minimum and maximum are only used when setting up knobs or other control systems. The internal values are not clipped to this range.

Parameters:

maximum -

getMinimum

public double getMinimum()

setMinimum

public void setMinimum(double minimum)

getDefault

public double getDefault()

setDefault

public void setDefault(double defaultValue)

setup

public void setup(double minimum,
                  double value,
                  double maximum)

Convenience function for setting limits on a port. These limits are recommended values when setting up a GUI. It is possible to set a port to a value outside these limits.

Parameters:

minimum -

value - default value, will be clipped to min/max

maximum -

setup

public void setup(UnitInputPort other)

isValueAdded

public boolean isValueAdded()

setValueAdded

public void setValueAdded(boolean valueAdded)

If set false then the set() value will be ignored when other ports are connected to this port. The sum of the connected port values will be used instead. If set true then the set() value will be added to the sum of the connected port values. This is useful when you want to modulate the set value. The default is false.

Parameters:

valueAdded -

connect

public void connect(int thisPartNum,
                    UnitOutputPort otherPort,
                    int otherPartNum,
                    TimeStamp timeStamp)

connect

public void connect(int thisPartNum,
                    UnitOutputPort otherPort,
                    int otherPartNum)

Connect an input to an output port.

connect

public void connect(UnitOutputPort otherPort)

connect

public void connect(ConnectableOutput other)

Specified by:

connect in interface ConnectableInput

disconnect

public void disconnect(int thisPartNum,
                       UnitOutputPort otherPort,
                       int otherPartNum)

getPortBlockPart

public PortBlockPart getPortBlockPart()

Description copied from interface: ConnectableInput

This is used internally by PortBlockPart to make a connection between specific parts of a port.

Specified by:

getPortBlockPart in interface ConnectableInput

Returns:

getConnectablePart

public ConnectableInput getConnectablePart(int i)

disconnect

public void disconnect(ConnectableOutput other)

Specified by:

disconnect in interface ConnectableInput

printConnections

public void printConnections(java.io.PrintStream out,
                             int level)