PageRenderTime 26ms CodeModel.GetById 23ms RepoModel.GetById 1ms app.codeStats 0ms

/skein_engines/skeinforge-35/documentation/skeinforge_application.skeinforge_plugins.craft_plugins.export.html

https://github.com/nmsl1993/ReplicatorG
HTML | 217 lines | 191 code | 26 blank | 0 comment | 0 complexity | 1e8e7c083d88ac1a4df956ac7d5482cf 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.craft_plugins.export</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.craft_plugins.html"><font color="#ffffff">craft_plugins</font></a>.export</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/craft_plugins/export.py">/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/craft_plugins/export.py</a></font></td></tr></table>
    12. 

  12.     <p>
    13. 

  13. <a href="skeinforge_application.skeinforge_plugins.craft_plugins.drill.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.binary_16_byte.html">Next</a> / <a href="contents.html">Contents</a>
    14. 

  14. </p>
    15. 

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

  16. Export is a script to pick an export plugin and optionally print the output to a file.<br>
    17. 

  17.  <br>
    18. 

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

  19. <a href="http://www.bitsfrombytes.com/wiki/index.php?title=Skeinforge_Export">http://www.bitsfrombytes.com/wiki/index.php?title=Skeinforge_Export</a><br>
    20. 

  20.  <br>
    21. 

  21. <br />
    22. 

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

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

  24. &nbsp;&nbsp;<a href="#Also Send Output To">Also Send Output To</a><br />
    25. 

  25. &nbsp;&nbsp;<a href="#Delete Comments">Delete Comments</a><br />
    26. 

  26. &nbsp;&nbsp;<a href="#Export Operations">Export Operations</a><br />
    27. 

  27. &nbsp;&nbsp;<a href="#File Extension">File Extension</a><br />
    28. 

  28. &nbsp;&nbsp;<a href="#Save Penultimate Gcode">Save Penultimate Gcode</a><br />
    29. 

  29. <a href="#Alterations">Alterations</a><br />
    30. 

  30. &nbsp;&nbsp;<a href="#replace.csv">replace.csv</a><br />
    31. 

  31. <a href="#Examples">Examples</a><br />
    32. 

  32. <br />
    33. 

  33. <a name="Operation" id="Operation"></a><h2>Operation</h2>
    34. 

  34. <hr>
    35. 

  35. 

  36. The default 'Activate Export' checkbox is on.  When it is on, the functions described below will work, when it is off, the functions will not be called.<br>
    37. 

  37.  <br>
    38. 

  38. <a name="Settings" id="Settings"></a><h2>Settings</h2>
    39. 

  39. <hr>
    40. 

  40. 

  41. <a name="Also Send Output To" id="Also Send Output To"></a><h3>Also Send Output To</h3>
    42. 

  42. 

  43. Default is empty.<br>
    44. 

  44.  <br>
    45. 

  45. Defines the output name for sending to a file or pipe.  A common choice is sys.stdout to print the output in the shell screen.  Another common choice is sys.stderr.  With the empty default, nothing will be done.<br>
    46. 

  46.  <br>
    47. 

  47. <a name="Delete Comments" id="Delete Comments"></a><h3>Delete Comments</h3>
    48. 

  48. 

  49. Default is on.<br>
    50. 

  50.  <br>
    51. 

  51. When selected, export will delete the comments.  The comments are not necessary to run a fabricator.<br>
    52. 

  52.  <br>
    53. 

  53. <a name="Export Operations" id="Export Operations"></a><h3>Export Operations</h3>
    54. 

  54. 

  55. Export presents the user with a choice of the export plugins in the export_plugins folder.  The chosen plugin will then modify the gcode or translate it into another format.  There is also the "Do Not Change Output" choice, which will not change the output.  An export plugin is a script in the export_plugins folder which has the getOutput function, the globalIsReplaceable variable and if it's output is not replaceable, the writeOutput function.<br>
    56. 

  56.  <br>
    57. 

  57. <a name="File Extension" id="File Extension"></a><h3>File Extension</h3>
    58. 

  58. 

  59. Default is gcode.<br>
    60. 

  60.  <br>
    61. 

  61. Defines the file extension added to the name of the output file.<br>
    62. 

  62.  <br>
    63. 

  63. <a name="Save Penultimate Gcode" id="Save Penultimate Gcode"></a><h3>Save Penultimate Gcode</h3>
    64. 

  64. 

  65. Default is off.<br>
    66. 

  66.  <br>
    67. 

  67. When selected, export will save the gcode with the suffix '_penultimate.gcode' just before it is exported.  This is useful because the code after it is exported could be in a form which the viewers can not display.<br>
    68. 

  68.  <br>
    69. 

  69. <a name="Alterations" id="Alterations"></a><h2>Alterations</h2>
    70. 

  70. <hr>
    71. 

  71. 

  72. Export looks for alteration files in the alterations folder in the .skeinforge folder in the home directory.  Export does not care if the text file names are capitalized, but some file systems do not handle file name cases properly, so to be on the safe side you should give them lower case names.  If it doesn't find the file it then looks in the alterations folder in the skeinforge_plugins folder. If it doesn't find anything there it looks in the skeinforge_plugins folder.<br>
    73. 

  73.  <br>
    74. 

  74. <a name="replace.csv" id="replace.csv"></a><h3>replace.csv</h3>
    75. 

  75. 

  76. When export is exporting the code, if there is a tab separated file replace.csv, it will replace the string in the first column by its replacement in the second column.  There is an example file replace_example.csv to demonstrate the tab separated format, which can be edited in a text editor or a spreadsheet.<br>
    77. 

  77.  <br>
    78. 

  78. <a name="Examples" id="Examples"></a><h2>Examples</h2>
    79. 

  79. <hr>
    80. 

  80. 

  81. The following examples export the file Screw Holder Bottom.stl.  The examples are run in a terminal in the folder which contains Screw Holder Bottom.stl and export.py.<br>
    82. 

  82.  <br>
    83. 

  83.  <br>
    84. 

  84. &gt; python export.py<br>
    85. 

  85. This brings up the export dialog.<br>
    86. 

  86.  <br>
    87. 

  87.  <br>
    88. 

  88. &gt; python export.py Screw Holder Bottom.stl<br>
    89. 

  89. The export tool is parsing the file:<br>
    90. 

  90. Screw Holder Bottom.stl<br>
    91. 

  91. ..<br>
    92. 

  92. The export tool has created the file:<br>
    93. 

  93. .. Screw Holder Bottom_export.gcode<br>
    94. 

  94.  <br>
    95. 

  95.  <br>
    96. 

  96. &gt; python<br>
    97. 

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

  98. [GCC 4.2.1 (SUSE Linux)] on linux2<br>
    99. 

  99. Type "help", "copyright", "credits" or "license" for more information.<br>
    100. 

  100. &gt;&gt;&gt; import export<br>
    101. 

  101. &gt;&gt;&gt; export.<a href="#-main">main</a>()<br>
    102. 

  102. This brings up the export dialog.<br>
    103. 

  103.  <br>
    104. 

  104.  <br>
    105. 

  105. &gt;&gt;&gt; export.<a href="#-writeOutput">writeOutput</a>('Screw Holder Bottom.stl')<br>
    106. 

  106. The export tool is parsing the file:<br>
    107. 

  107. Screw Holder Bottom.stl<br>
    108. 

  108. ..<br>
    109. 

  109. The export tool has created the file:<br>
    110. 

  110. .. Screw Holder Bottom_export.gcode</tt>
    111. 

  111. <br />
    112. 

  112. <br />
    113. 

  113. <p>
    114. 

  114. <a href="skeinforge_application.skeinforge_plugins.craft_plugins.drill.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.craft_plugins.export_plugins.binary_16_byte.html">Next</a> / <a href="contents.html">Contents</a>
    115. 

  115. </p>
    116. 

  116. <hr>
    117. 

  117. </p>
    118. 

  118. <p>
    119. 

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

  120. <tr bgcolor="#aa55cc">
    121. 

  121. <td colspan=3 valign=bottom>&nbsp;<br>
    122. 

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

  123.     
    124. 

  124. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    125. 

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

  126. <a href="fabmetheus_utilities.archive.html">fabmetheus_utilities.archive</a><br>
    127. 

  127. <a href="cStringIO.html">cStringIO</a><br>
    128. 

  128. <a href="fabmetheus_utilities.euclidean.html">fabmetheus_utilities.euclidean</a><br>
    129. 

  129. </td><td width="25%" valign=top><a href="fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret.html">fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret</a><br>
    130. 

  130. <a href="fabmetheus_utilities.gcodec.html">fabmetheus_utilities.gcodec</a><br>
    131. 

  131. <a href="fabmetheus_utilities.intercircle.html">fabmetheus_utilities.intercircle</a><br>
    132. 

  132. <a href="os.html">os</a><br>
    133. 

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

  134. <a href="skeinforge_application.skeinforge_utilities.skeinforge_analyze.html">skeinforge_application.skeinforge_utilities.skeinforge_analyze</a><br>
    135. 

  135. <a href="skeinforge_application.skeinforge_utilities.skeinforge_craft.html">skeinforge_application.skeinforge_utilities.skeinforge_craft</a><br>
    136. 

  136. <a href="skeinforge_application.skeinforge_utilities.skeinforge_polyfile.html">skeinforge_application.skeinforge_utilities.skeinforge_polyfile</a><br>
    137. 

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

  138. <a href="sys.html">sys</a><br>
    139. 

  139. <a href="time.html">time</a><br>
    140. 

  140. </td></tr></table></td></tr></table><p>
    141. 

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

  142. <tr bgcolor="#ee77aa">
    143. 

  143. <td colspan=3 valign=bottom>&nbsp;<br>
    144. 

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

  145.     
    146. 

  146. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    147. 

  147. <td width="100%"><dl>
    148. 

  148. <dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.craft_plugins.export.html#ExportRepository">ExportRepository</a>
    149. 

  149. </font></dt><dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.craft_plugins.export.html#ExportSkein">ExportSkein</a>
    150. 

  150. </font></dt></dl>
    151. 

  151.  <p>
    152. 

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

  153. <tr bgcolor="#ffc8d8">
    154. 

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

  155. <font color="#000000" face="helvetica, arial"><a name="ExportRepository">class <strong>ExportRepository</strong></a></font></td></tr>
    156. 

  156.     
    157. 

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

  158. <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;handle&nbsp;the&nbsp;export&nbsp;settings.<br>&nbsp;</tt></td></tr>
    159. 

  159. <tr><td>&nbsp;</td>
    160. 

  160. <td width="100%">Methods defined here:<br>
    161. 

  161. <dl><dt><a name="ExportRepository-__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>
    162. 

  162. 

  163. <dl><dt><a name="ExportRepository-execute"><strong>execute</strong></a>(self)</dt><dd><tt>Export&nbsp;button&nbsp;has&nbsp;been&nbsp;clicked.</tt></dd></dl>
    164. 

  164. 

  165. </td></tr></table> <p>
    166. 

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

  167. <tr bgcolor="#ffc8d8">
    168. 

  168. <td colspan=3 valign=bottom>&nbsp;<br>
    169. 

  169. <font color="#000000" face="helvetica, arial"><a name="ExportSkein">class <strong>ExportSkein</strong></a></font></td></tr>
    170. 

  170.     
    171. 

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

  172. <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;export&nbsp;a&nbsp;skein&nbsp;of&nbsp;extrusions.<br>&nbsp;</tt></td></tr>
    173. 

  173. <tr><td>&nbsp;</td>
    174. 

  174. <td width="100%">Methods defined here:<br>
    175. 

  175. <dl><dt><a name="ExportSkein-__init__"><strong>__init__</strong></a>(self)</dt></dl>
    176. 

  176. 

  177. <dl><dt><a name="ExportSkein-addLine"><strong>addLine</strong></a>(self, line)</dt><dd><tt>Add&nbsp;a&nbsp;line&nbsp;of&nbsp;text&nbsp;and&nbsp;a&nbsp;newline&nbsp;to&nbsp;the&nbsp;output.</tt></dd></dl>
    178. 

  178. 

  179. <dl><dt><a name="ExportSkein-getCraftedGcode"><strong>getCraftedGcode</strong></a>(self, exportRepository, gcodeText)</dt><dd><tt>Parse&nbsp;gcode&nbsp;text&nbsp;and&nbsp;store&nbsp;the&nbsp;export&nbsp;gcode.</tt></dd></dl>
    180. 

  180. 

  181. <dl><dt><a name="ExportSkein-getLineWithTruncatedNumber"><strong>getLineWithTruncatedNumber</strong></a>(self, character, line, splitLine)</dt><dd><tt>Get&nbsp;a&nbsp;line&nbsp;with&nbsp;the&nbsp;number&nbsp;after&nbsp;the&nbsp;character&nbsp;truncated.</tt></dd></dl>
    182. 

  182. 

  183. <dl><dt><a name="ExportSkein-parseLine"><strong>parseLine</strong></a>(self, exportRepository, line)</dt><dd><tt>Parse&nbsp;a&nbsp;gcode&nbsp;line.</tt></dd></dl>
    184. 

  184. 

  185. </td></tr></table></td></tr></table><p>
    186. 

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

  187. <tr bgcolor="#eeaa77">
    188. 

  188. <td colspan=3 valign=bottom>&nbsp;<br>
    189. 

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

  190.     
    191. 

  191. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    192. 

  192. <td width="100%"><dl><dt><a name="-getCraftedTextFromText"><strong>getCraftedTextFromText</strong></a>(gcodeText, exportRepository<font color="#909090">=None</font>)</dt><dd><tt>Export&nbsp;a&nbsp;gcode&nbsp;linear&nbsp;move&nbsp;text.</tt></dd></dl>
    193. 

  193.  <dl><dt><a name="-getDistanceGcode"><strong>getDistanceGcode</strong></a>(exportText)</dt><dd><tt>Get&nbsp;gcode&nbsp;lines&nbsp;with&nbsp;distance&nbsp;variable&nbsp;added.</tt></dd></dl>
    194. 

  194.  <dl><dt><a name="-getNewRepository"><strong>getNewRepository</strong></a>()</dt><dd><tt>Get&nbsp;the&nbsp;repository&nbsp;constructor.</tt></dd></dl>
    195. 

  195.  <dl><dt><a name="-getReplaced"><strong>getReplaced</strong></a>(exportText)</dt><dd><tt>Get&nbsp;text&nbsp;with&nbsp;strings&nbsp;replaced&nbsp;according&nbsp;to&nbsp;replace.csv&nbsp;file.</tt></dd></dl>
    196. 

  196.  <dl><dt><a name="-getSelectedPluginModule"><strong>getSelectedPluginModule</strong></a>(plugins)</dt><dd><tt>Get&nbsp;the&nbsp;selected&nbsp;plugin&nbsp;module.</tt></dd></dl>
    197. 

  197.  <dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>Display&nbsp;the&nbsp;export&nbsp;dialog.</tt></dd></dl>
    198. 

  198.  <dl><dt><a name="-writeOutput"><strong>writeOutput</strong></a>(fileName<font color="#909090">=''</font>)</dt><dd><tt>Export&nbsp;a&nbsp;gcode&nbsp;linear&nbsp;move&nbsp;file.</tt></dd></dl>
    199. 

  199. </td></tr></table><p>
    200. 

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

  201. <tr bgcolor="#55aa55">
    202. 

  202. <td colspan=3 valign=bottom>&nbsp;<br>
    203. 

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

  204.     
    205. 

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

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

  207. <strong>__date__</strong> = '$Date: 2008/21/04 $'<br>
    208. 

  208. <strong>__license__</strong> = 'GPL 3.0'<br>
    209. 

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

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

  211. <tr bgcolor="#7799ee">
    212. 

  212. <td colspan=3 valign=bottom>&nbsp;<br>
    213. 

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

  214.     
    215. 

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

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

  217. </body></html>
    218.