summaryrefslogtreecommitdiff
path: root/doc/source/documentation/rs274x.rst
blob: 00094d407d533297d3beaef7ceaae6518714689a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
:mod:`rs274x` --- RS-274X file handling
==============================================

.. module:: rs274x
   :synopsis: Functions and classes for handling RS-274X  files
.. sectionauthor:: Hamilton Kibbe <ham@hamiltonkib.be>


The RS-274X (Gerber) format is the most common format for exporting PCB
artwork.  The Specification is published by Ucamco and is available
`here <http://www.ucamco.com/files/downloads/file/81/the_gerber_file_format_specification.pdf>`_.
The :mod:`rs274x` submodule implements calsses to read and write
RS-274X files without having to know the precise details of the format.

The :mod:`rs274x` submodule's :func:`read` function serves as a
simple interface for parsing gerber files.  The :class:`GerberFile` class
stores all the information contained in a gerber file allowing the file to be
analyzed, modified, and updated. The :class:`GerberParser` class is used in
the background for parsing RS-274X files.

.. _gerber-contents:

Functions
---------
The :mod:`rs274x` module defines the following functions:

.. autofunction:: gerber.rs274x.read

Classes
-------
The :mod:`rs274x` module defines the following classes:

.. autoclass:: gerber.rs274x.GerberFile
    :members:

.. autoclass:: gerber.rs274x.GerberParser
    :members: