KiCad Pcbnew Python Scripting
Public Member Functions | Public Attributes | List of all members
plugins.PadArray.PadGridArray Class Reference

A basic grid of pads. More...

Inheritance diagram for plugins.PadArray.PadGridArray:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, pad, nx, ny, px, py, centre=pcbnew.wxPoint(0, 0))
 
def AlphaNameFromNumber (self, n, aIndex=1, alphabet="ABCDEFGHIJKLMNOPQRSTUVWXYZ")
 Utility function to generate an alphabetical name: More...
 
def NamingFunction (self, x, y)
 Implementation of the naming function: right to left, top-to-bottom. More...
 
def AddPadsToModule (self, dc)
 Create the pads and add them to the module in the correct positions. More...
 
- Public Member Functions inherited from plugins.PadArray.PadArray
def __init__ (self, pad)
 
def SetPinNames (self, pinNames)
 Set a name for all the pins. More...
 
def SetFirstPadType (self, firstPad)
 If the array has a different first pad, this is the pad that is used. More...
 
def SetFirstPadInArray (self, fpNum)
 Set the numbering for the first pad in the array. More...
 
def AddPad (self, pad)
 Add a pad to the array, under the same moodule as the main prototype pad. More...
 
def GetPad (self, is_first_pad, pos)
 Get a pad in the array with the given position. More...
 
def GetName (self, args, kwargs)
 Get the pad name from the naming function, or the pre-set pinNames parameter (set with SetPinNames) More...
 
def NamingFunction (self, args, kwargs)
 Implement this as needed for each array type. More...
 

Public Attributes

 nx
 
 ny
 
 px
 
 py
 
 centre
 
- Public Attributes inherited from plugins.PadArray.PadArray
 firstPadNum
 
 pinNames
 
 pad
 
 firstPad
 

Detailed Description

A basic grid of pads.

Definition at line 201 of file PadArray.py.

Constructor & Destructor Documentation

def plugins.PadArray.PadGridArray.__init__ (   self,
  pad,
  nx,
  ny,
  px,
  py,
  centre = pcbnew.wxPoint(0, 0) 
)
Parameters
padthe prototypical pad of the array
nxnumber of pads in x-direction
nynumber of pads in y-direction
pxpitch in x-direction
pypitch in y-direction
centrearray centre point

Definition at line 206 of file PadArray.py.

Member Function Documentation

def plugins.PadArray.PadGridArray.AddPadsToModule (   self,
  dc 
)

Create the pads and add them to the module in the correct positions.

Parameters
dcthe drawing context

Definition at line 254 of file PadArray.py.

def plugins.PadArray.PadGridArray.AlphaNameFromNumber (   self,
  n,
  aIndex = 1,
  alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" 
)

Utility function to generate an alphabetical name:

eg. 1 - A, 2 - B, 26 - AA, etc

Parameters
aIndexindex of 'A': 0 for 0 - A
nthe pad index
alphabetset of allowable chars if not A-Z, e.g. ABCDEFGHJKLMNPRTUVWY for BGA

Definition at line 224 of file PadArray.py.

Here is the caller graph for this function:

def plugins.PadArray.PadGridArray.NamingFunction (   self,
  x,
  y 
)

Implementation of the naming function: right to left, top-to-bottom.

Parameters
xthe pad x index
ythe pad y index

Definition at line 244 of file PadArray.py.

Member Data Documentation

plugins.PadArray.PadGridArray.centre

Definition at line 221 of file PadArray.py.

plugins.PadArray.PadGridArray.nx

Definition at line 217 of file PadArray.py.

plugins.PadArray.PadGridArray.ny

Definition at line 218 of file PadArray.py.

plugins.PadArray.PadGridArray.px

Definition at line 219 of file PadArray.py.

plugins.PadArray.PadGridArray.py

Definition at line 220 of file PadArray.py.


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