KiCAD pcbnew scripting
Public Member Functions | Static Public Attributes | List of all members
pcbnew.GENDRILL_WRITER_BASE Class Reference
Inheritance diagram for pcbnew.GENDRILL_WRITER_BASE:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, args, kwargs)
 
def SetMergeOption (self, aMerge)
 
def GetOffset (self)
 
def SetPageInfo (self, aPageInfo)
 
def SetMapFileFormat (self, aMapFmt)
 
def CreateMapFilesSet
 
def GenDrillReportFile (self, aFullFileName)
 

Static Public Attributes

 DECIMAL_FORMAT = _pcbnew.GENDRILL_WRITER_BASE_DECIMAL_FORMAT
 
 SUPPRESS_LEADING = _pcbnew.GENDRILL_WRITER_BASE_SUPPRESS_LEADING
 
 SUPPRESS_TRAILING = _pcbnew.GENDRILL_WRITER_BASE_SUPPRESS_TRAILING
 
 KEEP_ZEROS = _pcbnew.GENDRILL_WRITER_BASE_KEEP_ZEROS
 

Detailed Description

GENDRILL_WRITER_BASE is a class to create drill maps and drill report,
and a helper class to created drill files.

drill files are created by specialized derived classes, depenfing on
the file format.

C++ includes: gendrill_file_writer_base.h 

Definition at line 14187 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.GENDRILL_WRITER_BASE.__init__ (   self,
  args,
  kwargs 
)

Definition at line 14204 of file pcbnew.py.

Member Function Documentation

def pcbnew.GENDRILL_WRITER_BASE.CreateMapFilesSet (   self,
  aPlotDirectory,
  aReporter = None 
)
CreateMapFilesSet(GENDRILL_WRITER_BASE self, wxString aPlotDirectory, REPORTER * aReporter=None)
CreateMapFilesSet(GENDRILL_WRITER_BASE self, wxString aPlotDirectory)

void
GENDRILL_WRITER_BASE::CreateMapFilesSet(const wxString
&aPlotDirectory, REPORTER *aReporter=NULL)

Function CreateMapFilesSet Creates the full set of map files for the
board, in PS, PDF ...

format (use SetMapFileFormat() to select the format) filenames are
computed from the board name, and layers id

Parameters:
-----------

aPlotDirectory:  = the output folder

aReporter:  = a REPORTER to return activity or any message (can be
NULL) 

Definition at line 14283 of file pcbnew.py.

def pcbnew.GENDRILL_WRITER_BASE.GenDrillReportFile (   self,
  aFullFileName 
)
GenDrillReportFile(GENDRILL_WRITER_BASE self, wxString aFullFileName) -> bool

bool
GENDRILL_WRITER_BASE::GenDrillReportFile(const wxString
&aFullFileName)

Function GenDrillReportFile Create a plain text report file giving a
list of drill values and drill count for through holes, oblong holes,
and for buried vias, drill values and drill count per layer pair there
is only one report for all drill files even when buried or blinds vias
exist.

Here is a sample created by this function: Drill report for
F:/tmp/interf_u/interf_u.brd Created on 04/10/2012 20:48:38 Selected
Drill Unit: Imperial (inches)

Drill report for plated through holes : T1 0,025"  0,64mm  (88 holes)
T2  0,031" 0,79mm (120 holes) T3 0,032"  0,81mm  (151 holes)  (with
1 slot)  T4  0,040" 1,02mm (43 holes) T5 0,079"  2,00mm  (1 hole)
(with 1 slot)  T6  0,120" 3,05mm (1 hole) (with 1 slot)

Total plated holes count 404

Drill report for buried and blind vias :

Drill report for holes from layer Soudure to layer Interne1 :

Total plated holes count 0

Drill report for holes from layer Interne1 to layer Interne2 : T1
0,025" 0,64mm (3 holes)

Total plated holes count 3

Drill report for holes from layer Interne2 to layer Composant : T1
0,025" 0,64mm (1 hole)

Total plated holes count 1

Drill report for unplated through holes : T1 0,120" 3,05mm (1 hole)
(with 1 slot)

Total unplated holes count 1

Parameters:
-----------

aFullFileName:  : the name of the file to create

true if the file is created 

Definition at line 14309 of file pcbnew.py.

def pcbnew.GENDRILL_WRITER_BASE.GetOffset (   self)
GetOffset(GENDRILL_WRITER_BASE self) -> wxPoint

const wxPoint
GENDRILL_WRITER_BASE::GetOffset()

Return the plot offset (usually the position of the auxiliary axis. 

Definition at line 14232 of file pcbnew.py.

def pcbnew.GENDRILL_WRITER_BASE.SetMapFileFormat (   self,
  aMapFmt 
)
SetMapFileFormat(GENDRILL_WRITER_BASE self, PlotFormat aMapFmt)

void
GENDRILL_WRITER_BASE::SetMapFileFormat(PlotFormat aMapFmt)

Initialize the format for the drill map file.

Parameters:
-----------

aMapFmt:  = a PlotFormat value (one of PLOT_FORMAT_HPGL,
PLOT_FORMAT_POST, PLOT_FORMAT_GERBER, PLOT_FORMAT_DXF,
PLOT_FORMAT_SVG, PLOT_FORMAT_PDF the most useful are PLOT_FORMAT_PDF
and PLOT_FORMAT_POST 

Definition at line 14263 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.GENDRILL_WRITER_BASE.SetMergeOption (   self,
  aMerge 
)
SetMergeOption(GENDRILL_WRITER_BASE self, bool aMerge)

void
GENDRILL_WRITER_BASE::SetMergeOption(bool aMerge)

set the option to make separate drill files for PTH and NPTH

Parameters:
-----------

aMerge:  = true to make only one file containing PTH and NPTH = false
to create 2 separate files 

Definition at line 14214 of file pcbnew.py.

def pcbnew.GENDRILL_WRITER_BASE.SetPageInfo (   self,
  aPageInfo 
)
SetPageInfo(GENDRILL_WRITER_BASE self, PAGE_INFO const * aPageInfo)

void
GENDRILL_WRITER_BASE::SetPageInfo(const PAGE_INFO *aPageInfo)

Sets the page info used to plot drill maps If NULL, a A4 page format
will be used.

Parameters:
-----------

aPageInfo:  = a reference to the page info, usually used to
plot/display the board 

Definition at line 14244 of file pcbnew.py.

Member Data Documentation

pcbnew.GENDRILL_WRITER_BASE.DECIMAL_FORMAT = _pcbnew.GENDRILL_WRITER_BASE_DECIMAL_FORMAT
static

Definition at line 14207 of file pcbnew.py.

pcbnew.GENDRILL_WRITER_BASE.KEEP_ZEROS = _pcbnew.GENDRILL_WRITER_BASE_KEEP_ZEROS
static

Definition at line 14210 of file pcbnew.py.

pcbnew.GENDRILL_WRITER_BASE.SUPPRESS_LEADING = _pcbnew.GENDRILL_WRITER_BASE_SUPPRESS_LEADING
static

Definition at line 14208 of file pcbnew.py.

pcbnew.GENDRILL_WRITER_BASE.SUPPRESS_TRAILING = _pcbnew.GENDRILL_WRITER_BASE_SUPPRESS_TRAILING
static

Definition at line 14209 of file pcbnew.py.


The documentation for this class was generated from the following file: