com.softsynth.jmsl
Class DefaultDimensionNameSpace

java.lang.Object
  extended by com.softsynth.jmsl.DefaultDimensionNameSpace
All Implemented Interfaces:
DimensionNameSpace

public class DefaultDimensionNameSpace
extends java.lang.Object
implements DimensionNameSpace

DefaultDimensionNameSpace is a singleton and cannot be instantiated. Use instead: DefaultDimensionNameSpace.instance();

 dim 0 = "duration" 0..8
 dim 1 = "pitch" 0..127
 dim 2 = "amplitude" 0..1
 dim 3 = "hold"

Author:
Nick Didkovsky and Phil Burk. (c) 2002 Nick Didkovsky and Phil Burk, all rights reserved.
See Also:
DimensionNameSpaceTranslator

Method Summary
 int dimension()
           
 java.util.Enumeration dimensionNames()
           
 double getDefault(int dim)
           
 int getDimension(java.lang.String name)
           
 java.lang.String getDimensionName(int dim)
           
 double getHighLimit(int dim)
           
 double getLowLimit(int dim)
           
 int getNumberOfNames()
           
static DefaultDimensionNameSpace instance()
           
 void setDefault(int dim, double value)
          set the default value for a dimension
 void setDimensionName(int dim, java.lang.String name)
          assign a name to a dimension
 void setLimits(int dim, double low, double high)
          set the lowest and highest limits for a dimension
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

instance

public static DefaultDimensionNameSpace instance()

getNumberOfNames

public int getNumberOfNames()
Specified by:
getNumberOfNames in interface DimensionNameSpace
Returns:
number of names stored in name space. Not the same as highest dimension. Not all dimensions require names.

dimension

public int dimension()
Specified by:
dimension in interface DimensionNameSpace
Returns:
number of dimensions. Useful if you are allocating an array for example

getDimensionName

public java.lang.String getDimensionName(int dim)
Specified by:
getDimensionName in interface DimensionNameSpace
Returns:
name of specified dimension

getDimension

public int getDimension(java.lang.String name)
Specified by:
getDimension in interface DimensionNameSpace
Returns:
dimension associated with name, or -1 if not found

setDimensionName

public void setDimensionName(int dim,
                             java.lang.String name)
assign a name to a dimension

Specified by:
setDimensionName in interface DimensionNameSpace

getLowLimit

public double getLowLimit(int dim)
Specified by:
getLowLimit in interface DimensionNameSpace
Returns:
lowest allowable value for specified dimension

getHighLimit

public double getHighLimit(int dim)
Specified by:
getHighLimit in interface DimensionNameSpace
Returns:
highest allowable value for specified dimension

getDefault

public double getDefault(int dim)
Specified by:
getDefault in interface DimensionNameSpace
Returns:
default value for specified dimension

setDefault

public void setDefault(int dim,
                       double value)
set the default value for a dimension

Specified by:
setDefault in interface DimensionNameSpace

setLimits

public void setLimits(int dim,
                      double low,
                      double high)
set the lowest and highest limits for a dimension

Specified by:
setLimits in interface DimensionNameSpace

dimensionNames

public java.util.Enumeration dimensionNames()
Specified by:
dimensionNames in interface DimensionNameSpace