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

A pad grid array with a fixed name, used for things like thermal pads and via grids. More...

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

Public Member Functions

def NamingFunction (self, nx, ny)
 Simply return the firstPadNum. More...
 
- Public Member Functions inherited from plugins.PadArray.PadGridArray
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...
 

Additional Inherited Members

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

Detailed Description

A pad grid array with a fixed name, used for things like thermal pads and via grids.

Definition at line 279 of file PadArray.py.

Member Function Documentation

◆ NamingFunction()

def plugins.PadArray.EPADGridArray.NamingFunction (   self,
  nx,
  ny 
)

Simply return the firstPadNum.

Parameters
nxnot used
nynot used

Reimplemented from plugins.PadArray.PadGridArray.

Definition at line 285 of file PadArray.py.

Here is the caller graph for this function:

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