PageRenderTime 58ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 0ms

/skein_engines/skeinforge-39/documentation/skeinforge_application.skeinforge_plugins.analyze_plugins.comment.html

https://github.com/hmeyer/ReplicatorG
HTML | 168 lines | 148 code | 20 blank | 0 comment | 0 complexity | df00e1cdc6554670746f67774c5c380c MD5 | raw file
    

  1. 

  2. <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
    3. 

  3. <html><head><title>Python: module skeinforge_application.skeinforge_plugins.analyze_plugins.comment</title>
    4. 

  4. </head><body bgcolor="#f0f0f8">
    5. 

  5. 

  6. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
    7. 

  7. <tr bgcolor="#7799ee">
    8. 

  8. <td valign=bottom>&nbsp;<br>
    9. 

  9. <font color="#ffffff" face="helvetica, arial">&nbsp;<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
    10. 

  10. ><td align=right valign=bottom
    11. 

  11. ><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>
    12. 

  12.     <p>
    13. 

  13. <a href="skeinforge_application.skeinforge_plugins.analyze_plugins.analyze_utilities.zoom_out.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.analyze_plugins.export_canvas_plugins.postscript.html">Next</a> / <a href="contents.html">Contents</a>
    14. 

  14. </p>
    15. 

  15. <p><tt><br>
    16. 

  16. Comment is a script to comment a gcode file.<br>
    17. 

  17.  <br>
    18. 

  18. The comment manual page is at:<br>
    19. 

  19. <a href="http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge_Comment">http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge_Comment</a><br>
    20. 

  20.  <br>
    21. 

  21. <br />
    22. 

  22. <a href="#Operation">Operation</a><br />
    23. 

  23. <a href="#Gcodes">Gcodes</a><br />
    24. 

  24. <a href="#Examples">Examples</a><br />
    25. 

  25. <br />
    26. 

  26. <a name="Operation" id="Operation"></a><h2>Operation</h2>
    27. 

  27. <hr>
    28. 

  28. 

  29. The default 'Activate Comment' checkbox is on.  When it is on, the functions described below will work when called from the skeinforge toolchain, when it is off, the functions will not be called from the toolchain.  The functions will still be called, whether or not the 'Activate Comment' checkbox is on, when comment is run directly.<br>
    30. 

  30.  <br>
    31. 

  31. <a name="Gcodes" id="Gcodes"></a><h2>Gcodes</h2>
    32. 

  32. <hr>
    33. 

  33. 

  34.  <br>
    35. 

  35. An explanation of the gcodes is at:<br>
    36. 

  36. <a href="http://reprap.org/bin/view/Main/Arduino_GCode_Interpreter">http://reprap.org/bin/view/Main/Arduino_GCode_Interpreter</a><br>
    37. 

  37.  <br>
    38. 

  38. and at:<br>
    39. 

  39. <a href="http://reprap.org/bin/view/Main/MCodeReference">http://reprap.org/bin/view/Main/MCodeReference</a><br>
    40. 

  40.  <br>
    41. 

  41. A gode example is at:<br>
    42. 

  42. <a href="http://forums.reprap.org/file.php?12,file=565">http://forums.reprap.org/file.php?12,file=565</a><br>
    43. 

  43.  <br>
    44. 

  44. <a name="Examples" id="Examples"></a><h2>Examples</h2>
    45. 

  45. <hr>
    46. 

  46. 

  47.  <br>
    48. 

  48. 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>
    49. 

  49.  <br>
    50. 

  50. &gt; python comment.py<br>
    51. 

  51. This brings up the comment dialog.<br>
    52. 

  52.  <br>
    53. 

  53.  <br>
    54. 

  54. &gt; python comment.py Screw Holder_penultimate.gcode<br>
    55. 

  55. The comment file is saved as Screw_Holder_penultimate_comment.gcode<br>
    56. 

  56.  <br>
    57. 

  57.  <br>
    58. 

  58. &gt; python<br>
    59. 

  59. Python 2.5.1 (r251:54863, Sep 22 2007, 01:43:31)<br>
    60. 

  60. [GCC 4.2.1 (SUSE Linux)] on linux2<br>
    61. 

  61. Type "help", "copyright", "credits" or "license" for more information.<br>
    62. 

  62. &gt;&gt;&gt; import comment<br>
    63. 

  63. &gt;&gt;&gt; comment.<a href="#-main">main</a>()<br>
    64. 

  64. This brings up the comment dialog.<br>
    65. 

  65.  <br>
    66. 

  66.  <br>
    67. 

  67. &gt;&gt;&gt; comment.<a href="#-getWindowAnalyzeFile">getWindowAnalyzeFile</a>('Screw Holder_penultimate.gcode')<br>
    68. 

  68. The commente file is saved as Screw_Holder_penultimate_comment.gcode</tt>
    69. 

  69. <br />
    70. 

  70. <br />
    71. 

  71. <p>
    72. 

  72. <a href="skeinforge_application.skeinforge_plugins.analyze_plugins.analyze_utilities.zoom_out.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.analyze_plugins.export_canvas_plugins.postscript.html">Next</a> / <a href="contents.html">Contents</a>
    73. 

  73. </p>
    74. 

  74. <hr>
    75. 

  75. </p>
    76. 

  76. <p>
    77. 

  77. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    78. 

  78. <tr bgcolor="#aa55cc">
    79. 

  79. <td colspan=3 valign=bottom>&nbsp;<br>
    80. 

  80. <font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    81. 

  81.     
    82. 

  82. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    83. 

  83. <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__init__.html">__init__</a><br>
    84. 

  84. <a href="fabmetheus_utilities.archive.html">fabmetheus_utilities.archive</a><br>
    85. 

  85. </td><td width="25%" valign=top><a href="cStringIO.html">cStringIO</a><br>
    86. 

  86. <a href="fabmetheus_utilities.gcodec.html">fabmetheus_utilities.gcodec</a><br>
    87. 

  87. </td><td width="25%" valign=top><a href="fabmetheus_utilities.settings.html">fabmetheus_utilities.settings</a><br>
    88. 

  88. <a href="skeinforge_application.skeinforge_utilities.skeinforge_polyfile.html">skeinforge_application.skeinforge_utilities.skeinforge_polyfile</a><br>
    89. 

  89. </td><td width="25%" valign=top><a href="skeinforge_application.skeinforge_utilities.skeinforge_profile.html">skeinforge_application.skeinforge_utilities.skeinforge_profile</a><br>
    90. 

  90. <a href="sys.html">sys</a><br>
    91. 

  91. </td></tr></table></td></tr></table><p>
    92. 

  92. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    93. 

  93. <tr bgcolor="#ee77aa">
    94. 

  94. <td colspan=3 valign=bottom>&nbsp;<br>
    95. 

  95. <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    96. 

  96.     
    97. 

  97. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    98. 

  98. <td width="100%"><dl>
    99. 

  99. <dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.analyze_plugins.comment.html#CommentRepository">CommentRepository</a>
    100. 

  100. </font></dt><dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.analyze_plugins.comment.html#CommentSkein">CommentSkein</a>
    101. 

  101. </font></dt></dl>
    102. 

  102.  <p>
    103. 

  103. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    104. 

  104. <tr bgcolor="#ffc8d8">
    105. 

  105. <td colspan=3 valign=bottom>&nbsp;<br>
    106. 

  106. <font color="#000000" face="helvetica, arial"><a name="CommentRepository">class <strong>CommentRepository</strong></a></font></td></tr>
    107. 

  107.     
    108. 

  108. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    109. 

  109. <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;handle&nbsp;the&nbsp;comment&nbsp;settings.<br>&nbsp;</tt></td></tr>
    110. 

  110. <tr><td>&nbsp;</td>
    111. 

  111. <td width="100%">Methods defined here:<br>
    112. 

  112. <dl><dt><a name="CommentRepository-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Set&nbsp;the&nbsp;default&nbsp;settings,&nbsp;execute&nbsp;title&nbsp;&amp;&nbsp;settings&nbsp;fileName.</tt></dd></dl>
    113. 

  113. 

  114. <dl><dt><a name="CommentRepository-execute"><strong>execute</strong></a>(self)</dt><dd><tt>Write&nbsp;button&nbsp;has&nbsp;been&nbsp;clicked.</tt></dd></dl>
    115. 

  115. 

  116. </td></tr></table> <p>
    117. 

  117. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    118. 

  118. <tr bgcolor="#ffc8d8">
    119. 

  119. <td colspan=3 valign=bottom>&nbsp;<br>
    120. 

  120. <font color="#000000" face="helvetica, arial"><a name="CommentSkein">class <strong>CommentSkein</strong></a></font></td></tr>
    121. 

  121.     
    122. 

  122. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    123. 

  123. <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;comment&nbsp;a&nbsp;gcode&nbsp;skein.<br>&nbsp;</tt></td></tr>
    124. 

  124. <tr><td>&nbsp;</td>
    125. 

  125. <td width="100%">Methods defined here:<br>
    126. 

  126. <dl><dt><a name="CommentSkein-__init__"><strong>__init__</strong></a>(self)</dt></dl>
    127. 

  127. 

  128. <dl><dt><a name="CommentSkein-addComment"><strong>addComment</strong></a>(self, comment)</dt><dd><tt>Add&nbsp;a&nbsp;gcode&nbsp;comment&nbsp;and&nbsp;a&nbsp;newline&nbsp;to&nbsp;the&nbsp;output.</tt></dd></dl>
    129. 

  129. 

  130. <dl><dt><a name="CommentSkein-linearMove"><strong>linearMove</strong></a>(self, splitLine)</dt><dd><tt>Comment&nbsp;a&nbsp;linear&nbsp;move.</tt></dd></dl>
    131. 

  131. 

  132. <dl><dt><a name="CommentSkein-parseGcode"><strong>parseGcode</strong></a>(self, gcodeText)</dt><dd><tt>Parse&nbsp;gcode&nbsp;text&nbsp;and&nbsp;store&nbsp;the&nbsp;commented&nbsp;gcode.</tt></dd></dl>
    133. 

  133. 

  134. <dl><dt><a name="CommentSkein-parseLine"><strong>parseLine</strong></a>(self, line)</dt><dd><tt>Parse&nbsp;a&nbsp;gcode&nbsp;line&nbsp;and&nbsp;add&nbsp;it&nbsp;to&nbsp;the&nbsp;commented&nbsp;gcode.</tt></dd></dl>
    135. 

  135. 

  136. <dl><dt><a name="CommentSkein-setHelicalMoveEndpoint"><strong>setHelicalMoveEndpoint</strong></a>(self, splitLine)</dt><dd><tt>Get&nbsp;the&nbsp;endpoint&nbsp;of&nbsp;a&nbsp;helical&nbsp;move.</tt></dd></dl>
    137. 

  137. 

  138. </td></tr></table></td></tr></table><p>
    139. 

  139. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    140. 

  140. <tr bgcolor="#eeaa77">
    141. 

  141. <td colspan=3 valign=bottom>&nbsp;<br>
    142. 

  142. <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    143. 

  143.     
    144. 

  144. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    145. 

  145. <td width="100%"><dl><dt><a name="-getNewRepository"><strong>getNewRepository</strong></a>()</dt><dd><tt>Get&nbsp;the&nbsp;repository&nbsp;constructor.</tt></dd></dl>
    146. 

  146.  <dl><dt><a name="-getWindowAnalyzeFile"><strong>getWindowAnalyzeFile</strong></a>(fileName)</dt><dd><tt>Comment&nbsp;a&nbsp;gcode&nbsp;file.</tt></dd></dl>
    147. 

  147.  <dl><dt><a name="-getWindowAnalyzeFileGivenText"><strong>getWindowAnalyzeFileGivenText</strong></a>(fileName, gcodeText)</dt><dd><tt>Write&nbsp;a&nbsp;commented&nbsp;gcode&nbsp;file&nbsp;for&nbsp;a&nbsp;gcode&nbsp;file.</tt></dd></dl>
    148. 

  148.  <dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>Display&nbsp;the&nbsp;comment&nbsp;dialog.</tt></dd></dl>
    149. 

  149.  <dl><dt><a name="-writeOutput"><strong>writeOutput</strong></a>(fileName, fileNameSuffix, gcodeText<font color="#909090">=''</font>)</dt><dd><tt>Write&nbsp;a&nbsp;commented&nbsp;gcode&nbsp;file&nbsp;for&nbsp;a&nbsp;skeinforge&nbsp;gcode&nbsp;file,&nbsp;if&nbsp;'Write&nbsp;Commented&nbsp;File&nbsp;for&nbsp;Skeinforge&nbsp;Chain'&nbsp;is&nbsp;selected.</tt></dd></dl>
    150. 

  150. </td></tr></table><p>
    151. 

  151. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    152. 

  152. <tr bgcolor="#55aa55">
    153. 

  153. <td colspan=3 valign=bottom>&nbsp;<br>
    154. 

  154. <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    155. 

  155.     
    156. 

  156. <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    157. 

  157. <td width="100%"><strong>__author__</strong> = 'Enrique Perez (perez_enrique@yahoo.com)'<br>
    158. 

  158. <strong>__date__</strong> = '$Date: 2008/21/04 $'<br>
    159. 

  159. <strong>__license__</strong> = 'GPL 3.0'<br>
    160. 

  160. <strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)</td></tr></table><p>
    161. 

  161. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    162. 

  162. <tr bgcolor="#7799ee">
    163. 

  163. <td colspan=3 valign=bottom>&nbsp;<br>
    164. 

  164. <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
    165. 

  165.     
    166. 

  166. <tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    167. 

  167. <td width="100%">Enrique&nbsp;Perez&nbsp;(perez_enrique@yahoo.com)</td></tr></table>
    168. 

  168. </body></html>
    169.