CESE 1.4.7

com.simulogic.dataview
Class DataChannel

java.lang.Object
  extended by com.simulogic.dataview.DataChannel
Direct Known Subclasses:
TimeChannel

public class DataChannel
extends java.lang.Object

Class that represents one data set (channel)


Constructor Summary
DataChannel()
          Default constructor
DataChannel(java.lang.String name, int recs)
          Creates new DataChannel
 
Method Summary
 ChannelAttribute getAttribute()
          Returns attribute of this channel
 double getData(int inc)
          Returns value for given index in data array
 java.lang.String getName()
          Returns name of this channel
 AbstractPlot getPlot()
          Returns channel plot
 java.lang.String getUnits()
          Returns units 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 setAttribute(ChannelAttribute attribute)
          Sets attribute for this channel
 void setData(int inc, double val)
          Sets value at the given index in data array
 void setName(java.lang.String name)
          Sets name for this channel
 void setPlot(AbstractPlot plot)
          Sets plot for this channel
 void setUnits(java.lang.String units)
          Sets units for this channel
 int size()
          Returns size of the data array
 java.lang.String toString()
          Returns the string (ASCII) representation of the data contained in this channel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataChannel

public DataChannel()
Default constructor


DataChannel

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

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

Returns:
lower limit

maxLimit

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

Returns:
upper limit

getName

public java.lang.String getName()
Returns name of this channel

Returns:
channel name

setName

public void setName(java.lang.String name)
Sets name for this channel

Parameters:
name - new channel name

getUnits

public java.lang.String getUnits()
Returns units of this channel

Returns:
channel units

setUnits

public void setUnits(java.lang.String units)
Sets units for this channel

Parameters:
units - new channel units

getPlot

public AbstractPlot getPlot()
Returns channel plot

Returns:
channel plot

setPlot

public void setPlot(AbstractPlot plot)
Sets plot for this channel

Parameters:
plot - new channel plot

getAttribute

public ChannelAttribute getAttribute()
Returns attribute of this channel

Returns:
channel attribute

setAttribute

public void setAttribute(ChannelAttribute attribute)
Sets attribute for this channel

Parameters:
attribute - new channel attribute

size

public int size()
Returns size of the data array

Returns:
size of data array

getData

public double getData(int inc)
               throws java.lang.ArrayIndexOutOfBoundsException
Returns value for given index in data array

Parameters:
inc - index in the array
Returns:
data value
Throws:
java.lang.ArrayIndexOutOfBoundsException - when index is wrong

setData

public void setData(int inc,
                    double val)
             throws java.lang.ArrayIndexOutOfBoundsException
Sets value at the given index in data array

Parameters:
inc - index in the array
val - new data value
Throws:
java.lang.ArrayIndexOutOfBoundsException - when index is wrong

grow

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

Parameters:
inc - increment for data array size

toString

public java.lang.String toString()
Returns the string (ASCII) representation of the data contained in this channel

Overrides:
toString in class java.lang.Object
Returns:
ASCII representation of the channel

CESE 1.4.7

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