<?xml version="1.0" encoding="ascii"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>wxmpl.Channel</title> <link rel="stylesheet" href="epydoc.css" type="text/css" /> <script type="text/javascript" src="epydoc.js"></script> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="wxmpl-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" >WxMpl</th> </tr></table></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="wxmpl-module.html">Module wxmpl</a> :: Class Channel </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="wxmpl.Channel-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class Channel</h1><p class="nomargin-top"><span class="codelink"><a href="wxmpl-pysrc.html#Channel">source code</a></span></p> <p>Provides data for a <code>StripCharter</code> to plot. Subclasses of <code>Channel</code> override the template methods <code>getX()</code> and <code>getY()</code> to provide plot data and call <code>setChanged(True)</code> when that data has changed.</p> <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Instance Methods</span></td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="wxmpl.Channel-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">name</span>, <span class="summary-sig-arg">color</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">style</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">marker</span>=<span class="summary-sig-default">None</span>)</span><br /> Creates a new <code>Channel</code> with the matplotlib label <code>name</code>.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#Channel.__init__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="getLabel"></a><span class="summary-sig-name">getLabel</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns the matplotlib label for this channel of data.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#Channel.getLabel">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="getColor"></a><span class="summary-sig-name">getColor</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns the line color string to use when the line is plotted, or <code>None</code> to use an automatically generated color.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#Channel.getColor">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="getStyle"></a><span class="summary-sig-name">getStyle</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns the line style string to use when the line is plotted, or <code>None</code> to use the default line style.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#Channel.getStyle">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="getMarker"></a><span class="summary-sig-name">getMarker</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns the line marker string to use when the line is plotted, or <code>None</code> to use the default line marker.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#Channel.getMarker">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="hasChanged"></a><span class="summary-sig-name">hasChanged</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns a boolean indicating if the line data has changed.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#Channel.hasChanged">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="wxmpl.Channel-class.html#setChanged" class="summary-sig-name">setChanged</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">changed</span>)</span><br /> Sets the change indicator to the boolean value <code>changed</code>.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#Channel.setChanged">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="getX"></a><span class="summary-sig-name">getX</span>(<span class="summary-sig-arg">self</span>)</span><br /> Template method that returns the vector of X axis data or <code>None</code> if there is no data available.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#Channel.getX">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="getY"></a><span class="summary-sig-name">getY</span>(<span class="summary-sig-arg">self</span>)</span><br /> Template method that returns the vector of Y axis data or <code>None</code> if there is no data available.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#Channel.getY">source code</a></span> </td> </tr> </table> </td> </tr> </table> <!-- ==================== METHOD DETAILS ==================== --> <a name="section-MethodDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Method Details</span></td> </tr> </table> <a name="__init__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">name</span>, <span class="sig-arg">color</span>=<span class="sig-default">None</span>, <span class="sig-arg">style</span>=<span class="sig-default">None</span>, <span class="sig-arg">marker</span>=<span class="sig-default">None</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="wxmpl-pysrc.html#Channel.__init__">source code</a></span> </td> </tr></table> <p>Creates a new <code>Channel</code> with the matplotlib label <code>name</code>. The keyword arguments specify the strings for the line color, style, and marker to use when the line is plotted.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="setChanged"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">setChanged</span>(<span class="sig-arg">self</span>, <span class="sig-arg">changed</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="wxmpl-pysrc.html#Channel.setChanged">source code</a></span> </td> </tr></table> <p>Sets the change indicator to the boolean value <code>changed</code>.</p> <dl class="fields"> </dl> <div class="fields"> <p><strong>Note:</strong> <code>StripCharter</code> instances call this method after detecting a change, so a <code>Channel</code> cannot be shared among multiple charts. </p> </div></td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="wxmpl-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" >WxMpl</th> </tr></table></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Mon Feb 23 12:53:00 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" >http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie(); // --> </script> </body> </html>