# Python: module skeinforge_application.skeinforge_plugins.analyze_plugins.comment

skeinforge_application.skeinforge_plugins.analyze_plugins.comment ($Date: 2008/21/04 $) | index /home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/analyze_plugins/comment.py

Previous / Next / Contents

`
Comment is a script to comment a gcode file.
The comment manual page is at:
http://www.bitsfrombytes.com/wiki/index.php?title=Skeinforge_Comment
Operation
Gcodes
Examples
`

## Operation

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.

## Gcodes

An explanation of the gcodes is at:
http://reprap.org/bin/view/Main/Arduino_GCode_Interpreter
and at:
http://reprap.org/bin/view/Main/MCodeReference
A gode example is at:
http://forums.reprap.org/file.php?12,file=565

## Examples

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.
> python comment.py
This brings up the comment dialog.
> python comment.py Screw Holder_penultimate.gcode
The comment file is saved as Screw_Holder_penultimate_comment.gcode
> python
Python 2.5.1 (r251:54863, Sep 22 2007, 01:43:31)
[GCC 4.2.1 (SUSE Linux)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import comment
>>> comment.main()
This brings up the comment dialog.
>>> comment.getWindowAnalyzeFile('Screw Holder_penultimate.gcode')
The commente file is saved as Screw_Holder_penultimate_comment.gcode

Previous / Next / Contents

Modules

``

__init__ fabmetheus_utilities.archive | cStringIO fabmetheus_utilities.gcodec | fabmetheus_utilities.settings skeinforge_application.skeinforge_utilities.skeinforge_polyfile | sys

Classes

``

CommentRepository
CommentSkein

class CommentRepository
`` | `A class to handle the comment settings.`

Methods defined here:

__init__(self)
  `Set the default settings, execute title & settings fileName.`

execute(self)
  `Write button has been clicked.`

class CommentSkein
`` | `A class to comment a gcode skein.`

Methods defined here:

__init__(self)

addComment(self, comment)
  `Add a gcode comment and a newline to the output.`

linearMove(self, splitLine)
  `Comment a linear move.`

parseGcode(self, gcodeText)
  `Parse gcode text and store the commented gcode.`

parseLine(self, line)
  `Parse a gcode line and add it to the commented gcode.`

setHelicalMoveEndpoint(self, splitLine)
  `Get the endpoint of a helical move.`

Functions

``

getNewRepository()
  `Get the repository constructor.`

getWindowAnalyzeFile(fileName)
  `Comment a gcode file.`

getWindowAnalyzeFileGivenText(fileName, gcodeText)
  `Write a commented gcode file for a gcode file.`

main()
  `Display the comment dialog.`

writeOutput(fileName, fileNameSuffix, gcodeText='')
  `Write a commented gcode file for a skeinforge gcode file, if 'Write Commented File for Skeinforge Chain' is selected.`

Data
`` |  | __author__ = 'Enrique Perez (perez_enrique@yahoo.com)' __date__ = '$Date: 2008/21/04 $' __license__ = 'GPL 3.0' absolute_import = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)

Author
`` |  | Enrique Perez (perez_enrique@yahoo.com)