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

Public Member Functions

def __init__ (self, aPcb)
 
def GetOffset (self)
 
def SetFormat (self, args)
 
def SetPageInfo (self, aPageInfo)
 
def SetMapFileFormat (self, aMapFmt)
 
def SetOptions (self, aMirror, aMinimalHeader, aOffset, aMerge_PTH_NPTH)
 
def CreateDrillandMapFilesSet
 
def GenDrillReportFile (self, aFullFileName)
 
def GenDrillMapFile (self, aFullFileName, aFormat)
 

Public Attributes

 this
 

Static Public Attributes

 DECIMAL_FORMAT = _pcbnew.EXCELLON_WRITER_DECIMAL_FORMAT
 
 SUPPRESS_LEADING = _pcbnew.EXCELLON_WRITER_SUPPRESS_LEADING
 
 SUPPRESS_TRAILING = _pcbnew.EXCELLON_WRITER_SUPPRESS_TRAILING
 
 KEEP_ZEROS = _pcbnew.EXCELLON_WRITER_KEEP_ZEROS
 
tuple m_Offset = _swig_property(_pcbnew.EXCELLON_WRITER_m_Offset_get, _pcbnew.EXCELLON_WRITER_m_Offset_set)
 
tuple m_ShortHeader = _swig_property(_pcbnew.EXCELLON_WRITER_m_ShortHeader_get, _pcbnew.EXCELLON_WRITER_m_ShortHeader_set)
 

Detailed Description

EXCELLON_WRITER is a class mainly used to create Excellon drill files
However, this class is also used to create drill maps and drill
report.

C++ includes: gendrill_Excellon_writer.h 

Definition at line 12425 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.EXCELLON_WRITER.__init__ (   self,
  aPcb 
)
__init__(EXCELLON_WRITER self, BOARD aPcb) -> EXCELLON_WRITER

EXCELLON_WRITER::EXCELLON_WRITER(BOARD *aPcb)

See:  for EXCELLON format,
see:http://www.excellon.com/manuals/program.htm and the CNC-7 manual.

Definition at line 12453 of file pcbnew.py.

Member Function Documentation

def pcbnew.EXCELLON_WRITER.CreateDrillandMapFilesSet (   self,
  aPlotDirectory,
  aGenDrill,
  aGenMap,
  aReporter = None 
)
CreateDrillandMapFilesSet(EXCELLON_WRITER self, wxString aPlotDirectory, bool aGenDrill, bool aGenMap, REPORTER * aReporter=None)
CreateDrillandMapFilesSet(EXCELLON_WRITER self, wxString aPlotDirectory, bool aGenDrill, bool aGenMap)

void EXCELLON_WRITER::CreateDrillandMapFilesSet(const wxString
&aPlotDirectory, bool aGenDrill, bool aGenMap, REPORTER
*aReporter=NULL)

Function CreateDrillandMapFilesSet Creates the full set of Excellon
drill file for the board filenames are computed from the board name,
and layers id.

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

aPlotDirectory:  = the output folder

aGenDrill:  = true to generate the EXCELLON drill file

aGenMap:  = true to generate a drill map file

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

Definition at line 12578 of file pcbnew.py.

def pcbnew.EXCELLON_WRITER.GenDrillMapFile (   self,
  aFullFileName,
  aFormat 
)
GenDrillMapFile(EXCELLON_WRITER self, wxString aFullFileName, PlotFormat aFormat) -> bool

bool
EXCELLON_WRITER::GenDrillMapFile(const wxString &aFullFileName,
PlotFormat aFormat)

Function GenDrillMapFile Plot a map of drill marks for holes.

the paper sheet to use to plot the map is set in m_pageInfo ( calls
SetPageInfo() to set it ) if NULL, A4 format will be used

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

aFullFileName:  : the full filename of the map file to create,

aFormat:  : one of the supported plot formats (see enum PlotFormat )

Definition at line 12662 of file pcbnew.py.

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

bool
EXCELLON_WRITER::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 m_unitsDecimal =
false to use inches, true to use mm in report file

success if the file is created 

Definition at line 12606 of file pcbnew.py.

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

const wxPoint
EXCELLON_WRITER::GetOffset()

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

Definition at line 12471 of file pcbnew.py.

def pcbnew.EXCELLON_WRITER.SetFormat (   self,
  args 
)
SetFormat(EXCELLON_WRITER self, bool aMetric, EXCELLON_WRITER::ZEROS_FMT aZerosFmt, int aLeftDigits=0, int aRightDigits=0)
SetFormat(EXCELLON_WRITER self, bool aMetric, EXCELLON_WRITER::ZEROS_FMT aZerosFmt, int aLeftDigits=0)
SetFormat(EXCELLON_WRITER self, bool aMetric, EXCELLON_WRITER::ZEROS_FMT aZerosFmt)
SetFormat(EXCELLON_WRITER self, bool aMetric)

void
EXCELLON_WRITER::SetFormat(bool aMetric, ZEROS_FMT
aZerosFmt=DECIMAL_FORMAT, int aLeftDigits=0, int aRightDigits=0)

Function SetFormat Initialize internal parameters to match the given
format.

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

aMetric:  = true for metric coordinates, false for imperial units

aZerosFmt:  = DECIMAL_FORMAT, SUPPRESS_LEADING, SUPPRESS_TRAILING,
KEEP_ZEROS

aLeftDigits:  = number of digits for integer part of coordinates if <=
0 (default), a suitable value will be used, depending on units

aRightDigits:  = number of digits for mantissa part of coordinates if
<= 0 (default), a suitable value will be used, depending on units 

Definition at line 12483 of file pcbnew.py.

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

void
EXCELLON_WRITER::SetMapFileFormat(PlotFormat aMapFmt)

Function SetMapFileFormat Initialize the format for the drill map
file.

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

SetMapFileFormat:  = 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 12533 of file pcbnew.py.

def pcbnew.EXCELLON_WRITER.SetOptions (   self,
  aMirror,
  aMinimalHeader,
  aOffset,
  aMerge_PTH_NPTH 
)
SetOptions(EXCELLON_WRITER self, bool aMirror, bool aMinimalHeader, wxPoint aOffset, bool aMerge_PTH_NPTH)

void
EXCELLON_WRITER::SetOptions(bool aMirror, bool aMinimalHeader, wxPoint
aOffset, bool aMerge_PTH_NPTH)

Function SetOptions Initialize internal parameters to match drill
options.

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

aMirror:  = true to create mirrored coordinates (Y coordinates
negated)

aMinimalHeader:  = true to use a minimal header (no comments, no info)

aOffset:  = drill coordinates offset 

Definition at line 12554 of file pcbnew.py.

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

void
EXCELLON_WRITER::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 12514 of file pcbnew.py.

Here is the caller graph for this function:

Member Data Documentation

pcbnew.EXCELLON_WRITER.DECIMAL_FORMAT = _pcbnew.EXCELLON_WRITER_DECIMAL_FORMAT
static

Definition at line 12440 of file pcbnew.py.

pcbnew.EXCELLON_WRITER.KEEP_ZEROS = _pcbnew.EXCELLON_WRITER_KEEP_ZEROS
static

Definition at line 12443 of file pcbnew.py.

tuple pcbnew.EXCELLON_WRITER.m_Offset = _swig_property(_pcbnew.EXCELLON_WRITER_m_Offset_get, _pcbnew.EXCELLON_WRITER_m_Offset_set)
static

Definition at line 12447 of file pcbnew.py.

tuple pcbnew.EXCELLON_WRITER.m_ShortHeader = _swig_property(_pcbnew.EXCELLON_WRITER_m_ShortHeader_get, _pcbnew.EXCELLON_WRITER_m_ShortHeader_set)
static

Definition at line 12451 of file pcbnew.py.

pcbnew.EXCELLON_WRITER.SUPPRESS_LEADING = _pcbnew.EXCELLON_WRITER_SUPPRESS_LEADING
static

Definition at line 12441 of file pcbnew.py.

pcbnew.EXCELLON_WRITER.SUPPRESS_TRAILING = _pcbnew.EXCELLON_WRITER_SUPPRESS_TRAILING
static

Definition at line 12442 of file pcbnew.py.

pcbnew.EXCELLON_WRITER.this

Definition at line 12467 of file pcbnew.py.


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