KiCAD pcbnew scripting
Public Member Functions | 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 SetOptions (self, aMirror, aMinimalHeader, aOffset, aMerge_PTH_NPTH)
 
def CreateDrillandMapFilesSet
 
- Public Member Functions inherited from pcbnew.GENDRILL_WRITER_BASE
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)
 

Public Attributes

 this
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.GENDRILL_WRITER_BASE
 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

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 14302 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 14322 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 14411 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 14340 of file pcbnew.py.

def pcbnew.EXCELLON_WRITER.SetFormat (   self,
  args 
)
SetFormat(EXCELLON_WRITER self, bool aMetric, GENDRILL_WRITER_BASE::ZEROS_FMT aZerosFmt, int aLeftDigits=0, int aRightDigits=0)
SetFormat(EXCELLON_WRITER self, bool aMetric, GENDRILL_WRITER_BASE::ZEROS_FMT aZerosFmt, int aLeftDigits=0)
SetFormat(EXCELLON_WRITER self, bool aMetric, GENDRILL_WRITER_BASE::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 14352 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

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

Definition at line 14383 of file pcbnew.py.

Member Data Documentation

pcbnew.EXCELLON_WRITER.this

Definition at line 14336 of file pcbnew.py.


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