ca.nengo.util.impl
Class TimeSeriesImpl

java.lang.Object
  extended by ca.nengo.util.impl.TimeSeriesImpl
All Implemented Interfaces:
TimeSeries, java.io.Serializable, java.lang.Cloneable

public class TimeSeriesImpl
extends java.lang.Object
implements TimeSeries

Default implementation of TimeSeriesND.

Author:
Bryan Tripp
See Also:
Serialized Form

Constructor Summary
TimeSeriesImpl(float[] times, float[][] values, Units[] units)
           
TimeSeriesImpl(float[] times, float[][] values, Units[] units, java.lang.String[] labels)
           
 
Method Summary
 TimeSeries clone()
           
 int getDimension()
           
 java.lang.String[] getLabels()
           
 java.lang.String getName()
           
 float[] getTimes()
           
 Units[] getUnits()
           
 float[][] getValues()
           
 void setLabel(int index, java.lang.String label)
           
 void setName(java.lang.String name)
           
 void setUnits(int index, Units units)
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TimeSeriesImpl

public TimeSeriesImpl(float[] times,
                      float[][] values,
                      Units[] units)
Parameters:
times - @see ca.bpt.cn.util.TimeSeries#getTimes()
values - @see ca.bpt.cn.util.TimeSeries#getValues()
units - @see ca.bpt.cn.util.TimeSeries#getUnits()

TimeSeriesImpl

public TimeSeriesImpl(float[] times,
                      float[][] values,
                      Units[] units,
                      java.lang.String[] labels)
Parameters:
times - @see ca.nengo.util.TimeSeries#getTimes()
values - @see ca.nengo.util.TimeSeries#getValues()
units - @see ca.nengo.util.TimeSeries#getUnits()
labels - @see ca.nengo.util.TimeSeries#getLabels()
Method Detail

getName

public java.lang.String getName()
Specified by:
getName in interface TimeSeries
Returns:
Name of the TimeSeries
See Also:
TimeSeries.getName()

setName

public void setName(java.lang.String name)
Parameters:
name - Name of the TimeSeries

getTimes

public float[] getTimes()
Specified by:
getTimes in interface TimeSeries
Returns:
Times for which values are available
See Also:
TimeSeries.getTimes()

getValues

public float[][] getValues()
Specified by:
getValues in interface TimeSeries
Returns:
Values at getTimes(). Each value is a vector of size getDimension()
See Also:
TimeSeries.getValues()

getUnits

public Units[] getUnits()
Specified by:
getUnits in interface TimeSeries
Returns:
Units in which values in each dimension are expressed (length equals getDimension())
See Also:
TimeSeries.getUnits()

setUnits

public void setUnits(int index,
                     Units units)
Parameters:
index - Index of dimension for which to change units
units - New units for given dimension

getDimension

public int getDimension()
Specified by:
getDimension in interface TimeSeries
Returns:
dimension of vector values
See Also:
TimeSeries.getDimension()

getLabels

public java.lang.String[] getLabels()
Specified by:
getLabels in interface TimeSeries
Returns:
Name of each series (numbered by default)
See Also:
TimeSeries.getLabels()

setLabel

public void setLabel(int index,
                     java.lang.String label)
Parameters:
index - Index of dimension for which to change label
label - New label for given dimension

clone

public TimeSeries clone()
                 throws java.lang.CloneNotSupportedException
Specified by:
clone in interface TimeSeries
Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException