152 lines
10 KiB
HTML
152 lines
10 KiB
HTML
|
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
|
|
<html><head><title>Python: module skeinforge_application.skeinforge_plugins.analyze_plugins.comment</title>
|
||
|
|
</head><body bgcolor="#f0f0f8">
|
||
|
|
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||
|
|
<tr bgcolor="#7799ee">
|
||
|
|
<td valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="skeinforge_application.html"><font color="#ffffff">skeinforge_application</font></a>.<a href="skeinforge_application.skeinforge_plugins.html"><font color="#ffffff">skeinforge_plugins</font></a>.<a href="skeinforge_application.skeinforge_plugins.analyze_plugins.html"><font color="#ffffff">analyze_plugins</font></a>.comment</strong></big></big> ($Date: 2008/21/04 $)</font></td
|
||
|
|
><td align=right valign=bottom
|
||
|
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/analyze_plugins/comment.py">/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/analyze_plugins/comment.py</a></font></td></tr></table>
|
||
|
|
<p>
|
||
|
|
<a href="skeinforge_application.skeinforge_plugins.analyze_plugins.clairvoyance.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.analyze_plugins.export_canvas_plugins.postscript.html">Next</a> / <a href="contents.html">Contents</a>
|
||
|
|
</p>
|
||
|
|
<p><tt><br>
|
||
|
|
Comment is an analyze plugin to comment a gcode file.<br>
|
||
|
|
<br>
|
||
|
|
The comment manual page is at:<br>
|
||
|
|
<a href="http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge_Comment">http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge_Comment</a><br>
|
||
|
|
<br>
|
||
|
|
<br />
|
||
|
|
<a href="#Operation">Operation</a><br />
|
||
|
|
<a href="#Gcodes">Gcodes</a><br />
|
||
|
|
<a href="#Examples">Examples</a><br />
|
||
|
|
<br />
|
||
|
|
<a name="Operation" id="Operation"></a><h2>Operation</h2>
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
The default 'Activate Comment' checkbox is off. When it is on, the file will be commented when called from the skeinforge toolchain, when it is off, the file will not be commented when called from the toolchain. The file will still be commented, whether or not the 'Activate Comment' checkbox is on, when comment is run directly.<br>
|
||
|
|
<br>
|
||
|
|
<a name="Gcodes" id="Gcodes"></a><h2>Gcodes</h2>
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
An explanation of the gcodes is at:<br>
|
||
|
|
<a href="http://reprap.org/bin/view/Main/Arduino_GCode_Interpreter">http://reprap.org/bin/view/Main/Arduino_GCode_Interpreter</a><br>
|
||
|
|
<br>
|
||
|
|
and at:<br>
|
||
|
|
<a href="http://reprap.org/bin/view/Main/MCodeReference">http://reprap.org/bin/view/Main/MCodeReference</a><br>
|
||
|
|
<br>
|
||
|
|
A gode example is at:<br>
|
||
|
|
<a href="http://forums.reprap.org/file.php?12,file=565">http://forums.reprap.org/file.php?12,file=565</a><br>
|
||
|
|
<br>
|
||
|
|
<a name="Examples" id="Examples"></a><h2>Examples</h2>
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
Below are examples of comment being used. These examples are run in a terminal in the folder which contains Screw_Holder_penultimate.gcode and comment.py.<br>
|
||
|
|
<br>
|
||
|
|
> python comment.py<br>
|
||
|
|
This brings up the comment dialog.<br>
|
||
|
|
<br>
|
||
|
|
> python comment.py Screw Holder_penultimate.gcode<br>
|
||
|
|
The comment file is saved as Screw_Holder_penultimate_comment.gcode</tt>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
<p>
|
||
|
|
<a href="skeinforge_application.skeinforge_plugins.analyze_plugins.clairvoyance.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.analyze_plugins.export_canvas_plugins.postscript.html">Next</a> / <a href="contents.html">Contents</a>
|
||
|
|
</p>
|
||
|
|
<hr>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#aa55cc">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__init__.html">__init__</a><br>
|
||
|
|
<a href="fabmetheus_utilities.archive.html">fabmetheus_utilities.archive</a><br>
|
||
|
|
</td><td width="25%" valign=top><a href="cStringIO.html">cStringIO</a><br>
|
||
|
|
<a href="fabmetheus_utilities.gcodec.html">fabmetheus_utilities.gcodec</a><br>
|
||
|
|
</td><td width="25%" valign=top><a href="fabmetheus_utilities.settings.html">fabmetheus_utilities.settings</a><br>
|
||
|
|
<a href="skeinforge_application.skeinforge_utilities.skeinforge_polyfile.html">skeinforge_application.skeinforge_utilities.skeinforge_polyfile</a><br>
|
||
|
|
</td><td width="25%" valign=top><a href="skeinforge_application.skeinforge_utilities.skeinforge_profile.html">skeinforge_application.skeinforge_utilities.skeinforge_profile</a><br>
|
||
|
|
<a href="sys.html">sys</a><br>
|
||
|
|
</td></tr></table></td></tr></table><p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#ee77aa">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%"><dl>
|
||
|
|
<dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.analyze_plugins.comment.html#CommentRepository">CommentRepository</a>
|
||
|
|
</font></dt><dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.analyze_plugins.comment.html#CommentSkein">CommentSkein</a>
|
||
|
|
</font></dt></dl>
|
||
|
|
<p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#ffc8d8">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#000000" face="helvetica, arial"><a name="CommentRepository">class <strong>CommentRepository</strong></a></font></td></tr>
|
||
|
|
|
||
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||
|
|
<td colspan=2><tt>A class to handle the comment settings.<br> </tt></td></tr>
|
||
|
|
<tr><td> </td>
|
||
|
|
<td width="100%">Methods defined here:<br>
|
||
|
|
<dl><dt><a name="CommentRepository-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Set the default settings, execute title & settings fileName.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CommentRepository-execute"><strong>execute</strong></a>(self)</dt><dd><tt>Write button has been clicked.</tt></dd></dl>
|
||
|
|
|
||
|
|
</td></tr></table> <p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#ffc8d8">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#000000" face="helvetica, arial"><a name="CommentSkein">class <strong>CommentSkein</strong></a></font></td></tr>
|
||
|
|
|
||
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||
|
|
<td colspan=2><tt>A class to comment a gcode skein.<br> </tt></td></tr>
|
||
|
|
<tr><td> </td>
|
||
|
|
<td width="100%">Methods defined here:<br>
|
||
|
|
<dl><dt><a name="CommentSkein-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CommentSkein-addComment"><strong>addComment</strong></a>(self, comment)</dt><dd><tt>Add a gcode comment and a newline to the output.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CommentSkein-linearMove"><strong>linearMove</strong></a>(self, splitLine)</dt><dd><tt>Comment a linear move.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CommentSkein-parseGcode"><strong>parseGcode</strong></a>(self, gcodeText)</dt><dd><tt>Parse gcode text and store the commented gcode.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CommentSkein-parseLine"><strong>parseLine</strong></a>(self, line)</dt><dd><tt>Parse a gcode line and add it to the commented gcode.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CommentSkein-setHelicalMoveEndpoint"><strong>setHelicalMoveEndpoint</strong></a>(self, splitLine)</dt><dd><tt>Get the endpoint of a helical move.</tt></dd></dl>
|
||
|
|
|
||
|
|
</td></tr></table></td></tr></table><p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#eeaa77">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%"><dl><dt><a name="-getNewRepository"><strong>getNewRepository</strong></a>()</dt><dd><tt>Get new repository.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-getWindowAnalyzeFile"><strong>getWindowAnalyzeFile</strong></a>(fileName)</dt><dd><tt>Comment a gcode file.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-getWindowAnalyzeFileGivenText"><strong>getWindowAnalyzeFileGivenText</strong></a>(fileName, gcodeText)</dt><dd><tt>Write a commented gcode file for a gcode file.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>Display the comment dialog.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-writeOutput"><strong>writeOutput</strong></a>(fileName, fileNamePenultimate, fileNameSuffix, filePenultimateWritten, gcodeText<font color="#909090">=''</font>)</dt><dd><tt>Write a commented gcode file for a skeinforge gcode file, if 'Write Commented File for Skeinforge Chain' is selected.</tt></dd></dl>
|
||
|
|
</td></tr></table><p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#55aa55">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%"><strong>__author__</strong> = 'Enrique Perez (perez_enrique@yahoo.com)'<br>
|
||
|
|
<strong>__date__</strong> = '$Date: 2008/21/04 $'<br>
|
||
|
|
<strong>__license__</strong> = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html'<br>
|
||
|
|
<strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)</td></tr></table><p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#7799ee">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%">Enrique Perez (perez_enrique@yahoo.com)</td></tr></table>
|
||
|
|
</body></html>
|