CESE 1.4.7

com.simulogic.dataview
Class TimeChannel

java.lang.Object
  extended by com.simulogic.dataview.DataChannel
      extended by com.simulogic.dataview.TimeChannel

public class TimeChannel
extends DataChannel

Class that generates descrete time marks


Constructor Summary
TimeChannel()
          Default constructor
TimeChannel(double rate, int recs)
          Creates new TimeChannel
TimeChannel(java.lang.String name, int recs)
          Creates new TimeChannel
 
Method Summary
 double getData(int inc)
          Returns value for given index in data array
 double getRate()
          Returns rate of this channel
 void grow(int inc)
          Grows data array by a specific number of data points
 double maxLimit()
          Returns the largest value in data array
 double minLimit()
          Returns the smallest value in data array
 void setData(int inc, double val)
          Sets value at the given index in data array
 void setRate(double rate)
          Sets rate for this channel
 int size()
          Returns size of the data array
 
Methods inherited from class com.simulogic.dataview.DataChannel
getAttribute, getName, getPlot, getUnits, setAttribute, setName, setPlot, setUnits, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TimeChannel

public TimeChannel()
Default constructor


TimeChannel

public TimeChannel(double rate,
                   int recs)
Creates new TimeChannel

Parameters:
rate - rate in us
recs - number of records in the channel

TimeChannel

public TimeChannel(java.lang.String name,
                   int recs)
Creates new TimeChannel

Parameters:
name - name of the channel
recs - number of records in the channel
Method Detail

minLimit

public double minLimit()
Returns the smallest value in data array

Overrides:
minLimit in class DataChannel
Returns:
lower limit

maxLimit

public double maxLimit()
Returns the largest value in data array

Overrides:
maxLimit in class DataChannel
Returns:
upper limit

getRate

public double getRate()
Returns rate of this channel

Returns:
channel rate

setRate

public void setRate(double rate)
Sets rate for this channel

Parameters:
rate - new channel rate

size

public final int size()
Returns size of the data array

Overrides:
size in class DataChannel
Returns:
size of data array

getData

public final double getData(int inc)
Returns value for given index in data array

Overrides:
getData in class DataChannel
Parameters:
inc - index in the array
Returns:
data value

setData

public final void setData(int inc,
                          double val)
Sets value at the given index in data array

Overrides:
setData in class DataChannel
Parameters:
inc - index in the array
val - new data value

grow

public void grow(int inc)
Grows data array by a specific number of data points

Overrides:
grow in class DataChannel
Parameters:
inc - increment for data array size

CESE 1.4.7

Copyright (c) 1999 - 2007 Cell Electrophysiology Simulation Environment (CESE). All rights reserved.