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

A staggered pin array. More...

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

Public Member Functions

def __init__ (self, pad, pad_count, line_count, line_pitch, pad_pitch, centre=pcbnew.wxPoint(0, 0))
 
def NamingFunction (self, pad_pos)
 Naming just increased with pad index in array. 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

 pad_count
 
 line_count
 
 line_pitch
 
 pad_pitch
 
 centre
 
- Public Attributes inherited from plugins.PadArray.PadArray
 firstPadNum
 
 pinNames
 
 pad
 
 firstPad
 

Detailed Description

A staggered pin array.

Definition at line 294 of file PadArray.py.

Constructor & Destructor Documentation

◆ __init__()

def plugins.PadArray.PadZGridArray.__init__ (   self,
  pad,
  pad_count,
  line_count,
  line_pitch,
  pad_pitch,
  centre = pcbnew.wxPoint(0, 0) 
)
Parameters
padthe prototypical pad
pad_counttotal pad count
line_countnumber of staggered lines
line_pitchdistance between lines
pad_pitchdistance between pads in a line
centrearray centre point

Reimplemented from plugins.PadArray.PadArray.

Definition at line 299 of file PadArray.py.

Here is the caller graph for this function:

Member Function Documentation

◆ AddPadsToModule()

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

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

Parameters
dcthe drawing context

Definition at line 323 of file PadArray.py.

◆ NamingFunction()

def plugins.PadArray.PadZGridArray.NamingFunction (   self,
  pad_pos 
)

Naming just increased with pad index in array.

Reimplemented from plugins.PadArray.PadArray.

Definition at line 317 of file PadArray.py.

Here is the caller graph for this function:

Member Data Documentation

◆ centre

plugins.PadArray.PadZGridArray.centre

Definition at line 315 of file PadArray.py.

◆ line_count

plugins.PadArray.PadZGridArray.line_count

Definition at line 312 of file PadArray.py.

◆ line_pitch

plugins.PadArray.PadZGridArray.line_pitch

Definition at line 313 of file PadArray.py.

◆ pad_count

plugins.PadArray.PadZGridArray.pad_count

Definition at line 311 of file PadArray.py.

◆ pad_pitch

plugins.PadArray.PadZGridArray.pad_pitch

Definition at line 314 of file PadArray.py.


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