Module wxmpl :: Class Channel
[show private | hide private]
[frames | no frames]

Class Channel


Provides data for a StripCharter to plot. Subclasses of Channel override the template methods getX() and getY() to provide plot data and call setChanged(True) when that data has changed.
Method Summary
  __init__(self, name, color, style, marker)
Creates a new Channel with the matplotlib label name.
  getColor(self)
Returns the line color string to use when the line is plotted, or None to use an automatically generated color.
  getLabel(self)
Returns the matplotlib label for this channel of data.
  getMarker(self)
Returns the line marker string to use when the line is plotted, or None to use the default line marker.
  getStyle(self)
Returns the line style string to use when the line is plotted, or None to use the default line style.
  getX(self)
Template method that returns the vector of X axis data or None if there is no data available.
  getY(self)
Template method that returns the vector of Y axis data or None if there is no data available.
  hasChanged(self)
Returns a boolean indicating if the line data has changed.
  setChanged(self, changed)
Sets the change indicator to the boolean value changed.

Method Details

__init__(self, name, color=None, style=None, marker=None)
(Constructor)

Creates a new Channel with the matplotlib label name. The keyword arguments specify the strings for the line color, style, and marker to use when the line is plotted.

getColor(self)

Returns the line color string to use when the line is plotted, or None to use an automatically generated color.

getLabel(self)

Returns the matplotlib label for this channel of data.

getMarker(self)

Returns the line marker string to use when the line is plotted, or None to use the default line marker.

getStyle(self)

Returns the line style string to use when the line is plotted, or None to use the default line style.

getX(self)

Template method that returns the vector of X axis data or None if there is no data available.

getY(self)

Template method that returns the vector of Y axis data or None if there is no data available.

hasChanged(self)

Returns a boolean indicating if the line data has changed.

setChanged(self, changed)

Sets the change indicator to the boolean value changed.

Note: StripCharter instances call this method after detecting a change, so a Channel cannot be shared among multiple charts.


Generated by Epydoc 2.1 on Mon Aug 28 13:47:50 2006 http://epydoc.sf.net