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

Classes

class  DLISTIter
 

Public Member Functions

def Get (self)
 
def __deref__ (self)
 
def GetFirst (self)
 
def GetLast (self)
 
def Append (self, args)
 
def Insert (self, aNewElement, aElementAfterMe)
 
def Remove (self, aElement)
 
def begin (self)
 
def end (self)
 
def PopFront (self)
 
def PopBack (self)
 
def PushFront (self, aNewElement)
 
def PushBack (self, aNewElement)
 
def __iter__ (self)
 
def __init__ (self)
 
def StandardMask (self)
 
def SMDMask (self)
 
def ConnSMDMask (self)
 
def UnplatedHoleMask (self)
 
def ClassOf (self, aItem)
 
def Next (self)
 
def GetParent (self)
 
def ImportSettingsFromMaster (self, aMasterPad)
 
def IsFlipped (self)
 
def SetPadName (self, name)
 
def GetPadName (self)
 
def GetPackedPadName (self)
 
def IncrementPadName (self, aSkipUnconnectable, aFillSequenceGaps)
 
def PadNameEqual (self, other)
 
def GetShape (self)
 
def SetShape (self, aShape)
 
def SetPosition (self, aPos)
 
def GetPosition (self)
 
def SetY (self, y)
 
def SetX (self, x)
 
def SetPos0 (self, aPos)
 
def GetPos0 (self)
 
def SetY0 (self, y)
 
def SetX0 (self, x)
 
def SetSize (self, aSize)
 
def GetSize (self)
 
def SetDelta (self, aSize)
 
def GetDelta (self)
 
def SetDrillSize (self, aSize)
 
def GetDrillSize (self)
 
def SetOffset (self, aOffset)
 
def GetOffset (self)
 
def Flip (self, aCentre)
 
def SetOrientation (self, aAngle)
 
def SetOrientationDegrees (self, aOrientation)
 
def GetOrientation (self)
 
def GetOrientationDegrees (self)
 
def GetOrientationRadians (self)
 
def SetDrillShape (self, aDrillShape)
 
def GetDrillShape (self)
 
def GetOblongDrillGeometry (self, aStartPoint, aEndPoint, aWidth)
 
def SetLayerSet (self, aLayerMask)
 
def GetLayerSet (self)
 
def SetAttribute (self, aAttribute)
 
def GetAttribute (self)
 
def SetPadToDieLength (self, aLength)
 
def GetPadToDieLength (self)
 
def GetLocalSolderMaskMargin (self)
 
def SetLocalSolderMaskMargin (self, aMargin)
 
def GetLocalClearance (self)
 
def SetLocalClearance (self, aClearance)
 
def GetLocalSolderPasteMargin (self)
 
def SetLocalSolderPasteMargin (self, aMargin)
 
def GetLocalSolderPasteMarginRatio (self)
 
def SetLocalSolderPasteMarginRatio (self, aRatio)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
def GetClearance
 
def GetSolderMaskMargin (self)
 
def GetSolderPasteMargin (self)
 
def SetZoneConnection (self, aType)
 
def GetZoneConnection (self)
 
def SetThermalWidth (self, aWidth)
 
def GetThermalWidth (self)
 
def SetThermalGap (self, aGap)
 
def GetThermalGap (self)
 
def Draw (self, args)
 
def DrawShape (self, aClipBox, aDC, aDrawInfo)
 
def BuildPadPolygon (self, aCoord, aInflateValue, aRotation)
 
def GetRoundRectCornerRadius (self, args)
 
def BuildPadShapePolygon (self, aCornerBuffer, aInflateValue, aSegmentsPerCircle, aCorrectionFactor)
 
def BuildPadDrillShapePolygon (self, aCornerBuffer, aInflateValue, aSegmentsPerCircle)
 
def BuildSegmentFromOvalShape (self, aSegStart, aSegEnd, aRotation, aMargin)
 
def StringPadName (self, text)
 
def GetBoundingRadius (self)
 
def ShapePos (self)
 
def GetRoundRectRadiusRatio (self)
 
def SetRoundRectRadiusRatio (self, aRadiusScale)
 
def GetSubRatsnest (self)
 
def SetSubRatsnest (self, aSubRatsnest)
 
def GetMsgPanelInfo (self, aList)
 
def IsOnLayer (self, aLayer)
 
def HitTest (self, aPosition)
 
def GetClass (self)
 
def GetBoundingBox (self)
 
def SetDrawCoord (self)
 
def SetLocalCoord (self)
 
def Compare (self, padref, padcmp)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def ShowPadShape (self)
 
def ShowPadAttr (self)
 
def AppendConfigs (self, aResult)
 
def Clone (self)
 
def Duplicate (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
def ViewGetLOD (self, aLayer, aView)
 
def ViewBBox (self)
 
def CopyNetlistSettings (self, aPad, aCopyLocalSettings)
 
def IsConnected (self)
 
def GetNet (self)
 
def SetNet (self, aNetInfo)
 
def GetNetCode (self)
 
def SetNetCode
 
def GetSubNet (self)
 
def SetSubNet (self, aSubNetCode)
 
def GetZoneSubNet (self)
 
def SetZoneSubNet (self, aSubNetCode)
 
def GetNetname (self)
 
def GetShortNetname (self)
 
def GetNetClass (self)
 
def GetNetClassName (self)
 
def GetCenter (self)
 
def Back (self)
 
def GetLayer (self)
 
def SetLayer (self, aLayer)
 
def SwapData (self, aImage)
 
def IsTrack (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (self, aShape)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def FormatInternalUnits (self, args)
 
def FormatAngle (self, aAngle)
 
def Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def GetList (self)
 
def SetParent (self, aParent)
 
def SetList (self, aList)
 
def IsNew (self)
 
def IsModified (self)
 
def IsMoving (self)
 
def IsDragging (self)
 
def IsWireImage (self)
 
def IsSelected (self)
 
def IsResized (self)
 
def IsHighlighted (self)
 
def IsBrightened (self)
 
def SetWireImage (self)
 
def SetSelected (self)
 
def SetHighlighted (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearHighlighted (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def ClearFlags
 
def GetFlags (self)
 
def SetForceVisible (self, aEnable)
 
def IterateForward (self, listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (self, aLeft, aRight)
 
- Public Member Functions inherited from pcbnew.DHEAD
def __init__ (self, args, kwargs)
 
def DeleteAll (self)
 
def SetOwnership (self, Iown)
 
def GetCount (self)
 

Public Attributes

 this
 

Static Public Attributes

tuple ret = self.last.Get()
 
 ret = self.last
 
tuple m_TracksConnected = _swig_property(_pcbnew.PAD_List_m_TracksConnected_get, _pcbnew.PAD_List_m_TracksConnected_set)
 
tuple m_PadsConnected = _swig_property(_pcbnew.PAD_List_m_PadsConnected_get, _pcbnew.PAD_List_m_PadsConnected_set)
 

Detailed Description

Proxy of C++ DLIST<(D_PAD)> class

Definition at line 18877 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.PAD_List.__init__ (   self)
__init__(DLIST<(D_PAD)> self) -> PAD_List

Definition at line 18994 of file pcbnew.py.

Member Function Documentation

def pcbnew.PAD_List.__deref__ (   self)
__deref__(PAD_List self) -> D_PAD

Definition at line 18894 of file pcbnew.py.

def pcbnew.PAD_List.__iter__ (   self)

Definition at line 18989 of file pcbnew.py.

def pcbnew.PAD_List.__lt__ (   self,
  aItem 
)
__lt__(PAD_List self, EDA_ITEM aItem) -> bool

Definition at line 21196 of file pcbnew.py.

def pcbnew.PAD_List.Append (   self,
  args 
)
Append(PAD_List self, D_PAD aNewElement)
Append(PAD_List self, PAD_List aList)

Definition at line 18909 of file pcbnew.py.

def pcbnew.PAD_List.AppendConfigs (   self,
  aResult 
)
AppendConfigs(PAD_List self, PARAM_CFG_ARRAY * aResult)

void
D_PAD::AppendConfigs(PARAM_CFG_ARRAY *aResult)

Function AppendConfigs appends to aResult the configuration setting
accessors which will later allow reading or writing of configuration
file information directly into this object. 

Definition at line 20261 of file pcbnew.py.

def pcbnew.PAD_List.Back (   self)
Back(PAD_List self) -> BOARD_ITEM

BOARD_ITEM*
BOARD_ITEM::Back() const 

Definition at line 20580 of file pcbnew.py.

def pcbnew.PAD_List.begin (   self)
begin(PAD_List self) -> D_PAD

Definition at line 18927 of file pcbnew.py.

def pcbnew.PAD_List.BuildPadDrillShapePolygon (   self,
  aCornerBuffer,
  aInflateValue,
  aSegmentsPerCircle 
)
BuildPadDrillShapePolygon(PAD_List self, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aSegmentsPerCircle) -> bool

bool
D_PAD::BuildPadDrillShapePolygon(SHAPE_POLY_SET &aCornerBuffer, int
aInflateValue, int aSegmentsPerCircle) const

Function BuildPadDrillShapePolygon Build the Corner list of the
polygonal drill shape, depending on shape pad hole and orientation.

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

aCornerBuffer:  = a buffer to fill.

aInflateValue:  = the clearance or margin value. value > 0: inflate, <
0 deflate, = 0 : no change

aSegmentsPerCircle:  = number of segments to approximate a circle
(used for round and oblong shapes only(16 to 32 is a good value)

false if the pad has no hole, true otherwise 

Definition at line 19873 of file pcbnew.py.

def pcbnew.PAD_List.BuildPadPolygon (   self,
  aCoord,
  aInflateValue,
  aRotation 
)
BuildPadPolygon(PAD_List self, wxPoint aCoord, wxSize aInflateValue, double aRotation)

void
D_PAD::BuildPadPolygon(wxPoint aCoord[4], wxSize aInflateValue, double
aRotation) const

Function BuildPadPolygon Has meaning only for polygonal pads
(trapezoid and rectangular) Build the Corner list of the polygonal
shape, depending on shape, extra size (clearance ...) and orientation.

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

aCoord:  = a buffer to fill (4 corners).

aInflateValue:  = wxSize: the clearance or margin value. value > 0:
inflate, < 0 deflate

aRotation:  = full rotation of the polygon 

Definition at line 19788 of file pcbnew.py.

def pcbnew.PAD_List.BuildPadShapePolygon (   self,
  aCornerBuffer,
  aInflateValue,
  aSegmentsPerCircle,
  aCorrectionFactor 
)
BuildPadShapePolygon(PAD_List self, SHAPE_POLY_SET aCornerBuffer, wxSize aInflateValue, int aSegmentsPerCircle, double aCorrectionFactor)

void
D_PAD::BuildPadShapePolygon(SHAPE_POLY_SET &aCornerBuffer, wxSize
aInflateValue, int aSegmentsPerCircle, double aCorrectionFactor) const

Function BuildPadShapePolygon Build the Corner list of the polygonal
shape, depending on shape, extra size (clearance ...) pad and
orientation This function is similar to
TransformShapeWithClearanceToPolygon, but the difference is
BuildPadShapePolygon creates a polygon shape exactly similar to pad
shape, which a size inflated by aInflateValue and
TransformShapeWithClearanceToPolygon creates a more complex shape (for
instance a rectangular pad is converted in a rectangulr shape with
ronded corners)

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

aCornerBuffer:  = a buffer to fill.

aInflateValue:  = the clearance or margin value. value > 0: inflate, <
0 deflate, = 0 : no change the clearance can have different values for
x and y directions (relative to the pad)

aSegmentsPerCircle:  = number of segments to approximate a circle
(used for round and oblong shapes only (16 to 32 is a good value)

aCorrectionFactor:  = the correction to apply to circles radius to
keep the pad size/clearance when the arcs are approximated by segments

Definition at line 19836 of file pcbnew.py.

def pcbnew.PAD_List.BuildSegmentFromOvalShape (   self,
  aSegStart,
  aSegEnd,
  aRotation,
  aMargin 
)
BuildSegmentFromOvalShape(PAD_List self, wxPoint aSegStart, wxPoint aSegEnd, double aRotation, wxSize aMargin) -> int

int
D_PAD::BuildSegmentFromOvalShape(wxPoint &aSegStart, wxPoint &aSegEnd,
double aRotation, const wxSize &aMargin) const

Function BuildSegmentFromOvalShape Has meaning only for OVAL (and
ROUND) pads Build an equivalent segment having the same shape as the
OVAL shape, Useful in draw function and in DRC and HitTest functions,
because segments are already well handled by track tests.

Function BuildSegmentFromOvalShape Has meaning only for OVAL (and
ROUND) pads.

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

aSegStart:  = the starting point of the equivalent segment relative to
the shape position.

aSegEnd:  = the ending point of the equivalent segment, relative to
the shape position

aRotation:  = full rotation of the segment

aRotation:  = full rotation of the segment

aMargin:  = a margin around the shape (for instance mask margin)

the width of the segment  Build an equivalent segment having the same
shape as the OVAL shape, aSegStart and aSegEnd are the ending points
of the equivalent segment of the shape aRotation is the asked rotation
of the segment (usually m_Orient) 

Definition at line 19900 of file pcbnew.py.

def pcbnew.PAD_List.ClassOf (   self,
  aItem 
)
ClassOf(PAD_List self, EDA_ITEM aItem) -> bool

Definition at line 19024 of file pcbnew.py.

def pcbnew.PAD_List.ClearBrightened (   self)
ClearBrightened(PAD_List self)

void
EDA_ITEM::ClearBrightened() 

Definition at line 20972 of file pcbnew.py.

def pcbnew.PAD_List.ClearFlags (   self,
  aMask = -1 
)
ClearFlags(PAD_List self, STATUS_FLAGS aMask=-1)
ClearFlags(PAD_List self)

void
EDA_ITEM::ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS) 

Definition at line 21042 of file pcbnew.py.

def pcbnew.PAD_List.ClearHighlighted (   self)
ClearHighlighted(PAD_List self)

void
EDA_ITEM::ClearHighlighted() 

Definition at line 20962 of file pcbnew.py.

def pcbnew.PAD_List.ClearSelected (   self)
ClearSelected(PAD_List self)

void
EDA_ITEM::ClearSelected() 

Definition at line 20952 of file pcbnew.py.

def pcbnew.PAD_List.Clone (   self)
Clone(PAD_List self) -> EDA_ITEM

EDA_ITEM * D_PAD::Clone() const
override

Function Clone creates a duplicate of this item with linked list
members set to NULL.

The default version will return NULL in release builds and likely
crash the program. In debug builds, a warning message indicating the
derived class has not implemented cloning. This really should be a
pure virtual function. Due to the fact that there are so many objects
derived from EDA_ITEM, the decision was made to return NULL until all
the objects derived from EDA_ITEM implement cloning. Once that
happens, this function should be made pure.

A clone of the item. 

Definition at line 20275 of file pcbnew.py.

def pcbnew.PAD_List.Compare (   self,
  padref,
  padcmp 
)
Compare(PAD_List self, D_PAD padref, D_PAD padcmp) -> int

Definition at line 20155 of file pcbnew.py.

def pcbnew.PAD_List.ConnSMDMask (   self)
ConnSMDMask(PAD_List self) -> LSET

Definition at line 19014 of file pcbnew.py.

def pcbnew.PAD_List.CopyNetlistSettings (   self,
  aPad,
  aCopyLocalSettings 
)
CopyNetlistSettings(PAD_List self, D_PAD aPad, bool aCopyLocalSettings)

void
D_PAD::CopyNetlistSettings(D_PAD *aPad, bool aCopyLocalSettings)

Function CopyNetlistSettings copies the netlist settings to aPad, and
the net name.

Used to copy some pad parameters when replacing a footprint by an
other footprint when reading a netlist, or in exchange footprint
dialog

The netlist settings are all of the D_PAD settings not define by a
D_PAD in a netlist. The copied settings are the net name and
optionally include local clearance, etc. The pad physical geometry
settings are not copied.

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

aPad:  is the D_PAD to copy the settings to.

aCopyLocalSettings:  = false to copy only the net name true to also
copy local prms 

Definition at line 20343 of file pcbnew.py.

def pcbnew.PAD_List.DeleteStructure (   self)
DeleteStructure(PAD_List self)

void
BOARD_ITEM::DeleteStructure()

Function DeleteStructure deletes this object after UnLink()ing it from
its owner if it has one. 

Definition at line 20697 of file pcbnew.py.

def pcbnew.PAD_List.Draw (   self,
  args 
)
Draw(PAD_List self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
Draw(PAD_List self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode)

void D_PAD::Draw(EDA_DRAW_PANEL
*aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, const wxPoint
&aOffset=ZeroOffset) override

Function Draw BOARD_ITEMs have their own color information. 

Definition at line 19756 of file pcbnew.py.

def pcbnew.PAD_List.DrawShape (   self,
  aClipBox,
  aDC,
  aDrawInfo 
)
DrawShape(PAD_List self, EDA_RECT aClipBox, wxDC * aDC, PAD_DRAWINFO aDrawInfo)

void
D_PAD::DrawShape(EDA_RECT *aClipBox, wxDC *aDC, PAD_DRAWINFO
&aDrawInfo)

Function DrawShape basic function to draw a pad.

This function is used by Draw after calculation of parameters (color,
) final orientation transforms are set. It can also be called to draw
a pad on any panel even if this panel is not a EDA_DRAW_PANEL for
instance on a wxPanel inside the pad editor. 

Definition at line 19770 of file pcbnew.py.

def pcbnew.PAD_List.Duplicate (   self)
Duplicate(PAD_List self) -> D_PAD

D_PAD* D_PAD::Duplicate()
const

same as Clone, but returns a D_PAD item.

Useful mainly for pythons scripts, because Clone (virtual function)
returns an EDA_ITEM. 

Definition at line 20298 of file pcbnew.py.

def pcbnew.PAD_List.end (   self)
end(PAD_List self) -> D_PAD

Definition at line 18932 of file pcbnew.py.

def pcbnew.PAD_List.Flip (   self,
  aCentre 
)
Flip(PAD_List self, wxPoint aCentre)

void D_PAD::Flip(const wxPoint
&aCentre) override

Function Flip Flip this object, i.e.

change the board side for this object

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

aCentre:  - the rotation point. 

Definition at line 19336 of file pcbnew.py.

def pcbnew.PAD_List.FormatAngle (   self,
  aAngle 
)
FormatAngle(PAD_List self, double aAngle) -> string

Definition at line 20752 of file pcbnew.py.

def pcbnew.PAD_List.FormatInternalUnits (   self,
  args 
)
FormatInternalUnits(PAD_List self, int aValue) -> string
FormatInternalUnits(PAD_List self, wxPoint aPoint) -> string
FormatInternalUnits(PAD_List self, wxSize aSize) -> string

Definition at line 20743 of file pcbnew.py.

def pcbnew.PAD_List.Get (   self)
Get(PAD_List self) -> D_PAD

Definition at line 18889 of file pcbnew.py.

def pcbnew.PAD_List.GetAttribute (   self)
GetAttribute(PAD_List self) -> PAD_ATTR_T

PAD_ATTR_T
D_PAD::GetAttribute() const 

Definition at line 19500 of file pcbnew.py.

def pcbnew.PAD_List.GetBoard (   self)
GetBoard(PAD_List self) -> BOARD

BOARD *
BOARD_ITEM::GetBoard() const

Function GetBoard returns the BOARD in which this BOARD_ITEM resides,
or NULL if none. 

Definition at line 20715 of file pcbnew.py.

def pcbnew.PAD_List.GetBoundingBox (   self)
GetBoundingBox(PAD_List self) -> EDA_RECT

const EDA_RECT
D_PAD::GetBoundingBox() const override

Function GetBoundingBox returns the orthogonal, bounding box of this
object for display purposes.

This box should be an enclosing perimeter for visible components of
this object, and the units should be in the pcb or schematic
coordinate system. It is OK to overestimate the size by a few counts.

Definition at line 20113 of file pcbnew.py.

def pcbnew.PAD_List.GetBoundingRadius (   self)
GetBoundingRadius(PAD_List self) -> int

int
D_PAD::GetBoundingRadius() const

Function GetBoundingRadius returns the radius of a minimum sized
circle which fully encloses this pad.

The center is the pad position 

Definition at line 19949 of file pcbnew.py.

def pcbnew.PAD_List.GetCenter (   self)
GetCenter(PAD_List self) -> wxPoint

virtual const wxPoint
BOARD_ITEM::GetCenter() const

Function GetCenter()

This defaults to the same point as returned by GetPosition(), unless
overridden

centre point of the item 

Definition at line 20563 of file pcbnew.py.

def pcbnew.PAD_List.GetClass (   self)
GetClass(PAD_List self) -> wxString

wxString D_PAD::GetClass()
const override

Function GetClass returns the class name.

wxString 

Definition at line 20099 of file pcbnew.py.

def pcbnew.PAD_List.GetClearance (   self,
  aItem = None 
)
GetClearance(PAD_List self, BOARD_CONNECTED_ITEM aItem=None) -> int
GetClearance(PAD_List self) -> int

int
D_PAD::GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override

Function GetClearance returns the clearance in internal units.

If aItem is not NULL then the returned clearance is the greater of
this object's clearance and aItem's clearance. If aItem is NULL, then
this objects clearance is returned.

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

aItem:  is another BOARD_CONNECTED_ITEM or NULL

int - the clearance in internal units. 

Definition at line 19639 of file pcbnew.py.

def pcbnew.PAD_List.GetDelta (   self)
GetDelta(PAD_List self) -> wxSize

const wxSize&
D_PAD::GetDelta() const 

Definition at line 19286 of file pcbnew.py.

def pcbnew.PAD_List.GetDrillShape (   self)
GetDrillShape(PAD_List self) -> PAD_DRILL_SHAPE_T

PAD_DRILL_SHAPE_T
D_PAD::GetDrillShape() const 

Definition at line 19428 of file pcbnew.py.

def pcbnew.PAD_List.GetDrillSize (   self)
GetDrillSize(PAD_List self) -> wxSize

const wxSize&
D_PAD::GetDrillSize() const 

Definition at line 19306 of file pcbnew.py.

def pcbnew.PAD_List.GetFirst (   self)
GetFirst(PAD_List self) -> D_PAD

Definition at line 18899 of file pcbnew.py.

def pcbnew.PAD_List.GetFlags (   self)
GetFlags(PAD_List self) -> STATUS_FLAGS

STATUS_FLAGS
EDA_ITEM::GetFlags() const 

Definition at line 21053 of file pcbnew.py.

def pcbnew.PAD_List.GetLast (   self)
GetLast(PAD_List self) -> D_PAD

Definition at line 18904 of file pcbnew.py.

def pcbnew.PAD_List.GetLayer (   self)
GetLayer(PAD_List self) -> PCB_LAYER_ID

PCB_LAYER_ID
BOARD_ITEM::GetLayer() const

Function GetLayer returns the primary layer this item is on. 

Definition at line 20590 of file pcbnew.py.

def pcbnew.PAD_List.GetLayerName (   self)
GetLayerName(PAD_List self) -> wxString

wxString
BOARD_ITEM::GetLayerName() const

Function GetLayerName returns the name of the PCB layer on which the
item resides.

wxString containing the layer name associated with this item. 

Definition at line 20728 of file pcbnew.py.

def pcbnew.PAD_List.GetLayerSet (   self)
GetLayerSet(PAD_List self) -> LSET

LSET D_PAD::GetLayerSet()
const override

Function GetLayerSet returns a "layer mask", which is a bitmap of
all layers on which the TRACK segment or VIA physically resides.

int - a layer mask, see layers_id_colors_visibility.h. 

Definition at line 19475 of file pcbnew.py.

def pcbnew.PAD_List.GetList (   self)
GetList(PAD_List self) -> DHEAD

DHEAD* EDA_ITEM::GetList()
const 

Definition at line 20792 of file pcbnew.py.

def pcbnew.PAD_List.GetLocalClearance (   self)
GetLocalClearance(PAD_List self) -> int

int
D_PAD::GetLocalClearance() const 

Definition at line 19550 of file pcbnew.py.

def pcbnew.PAD_List.GetLocalSolderMaskMargin (   self)
GetLocalSolderMaskMargin(PAD_List self) -> int

int
D_PAD::GetLocalSolderMaskMargin() const 

Definition at line 19530 of file pcbnew.py.

def pcbnew.PAD_List.GetLocalSolderPasteMargin (   self)
GetLocalSolderPasteMargin(PAD_List self) -> int

int
D_PAD::GetLocalSolderPasteMargin() const 

Definition at line 19570 of file pcbnew.py.

def pcbnew.PAD_List.GetLocalSolderPasteMarginRatio (   self)
GetLocalSolderPasteMarginRatio(PAD_List self) -> double

double
D_PAD::GetLocalSolderPasteMarginRatio() const 

Definition at line 19590 of file pcbnew.py.

def pcbnew.PAD_List.GetMenuImage (   self)
GetMenuImage(PAD_List self) -> BITMAP_DEF

BITMAP_DEF
D_PAD::GetMenuImage() const override

Function GetMenuImage returns a pointer to an image to be used in
menus.

The default version returns the right arrow image. Override this
function to provide object specific menu images. The menu image
associated with the item. 

Definition at line 20216 of file pcbnew.py.

def pcbnew.PAD_List.GetMsgPanelInfo (   self,
  aList 
)
GetMsgPanelInfo(PAD_List self, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

void
D_PAD::GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList) override

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects
with it's internal state for display purposes.

This method replaces DisplayInfo() so that KiCad objects no longer
have any knowledge of wxWidgets UI objects.

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

aList:  is the list to populate. 

Definition at line 20030 of file pcbnew.py.

def pcbnew.PAD_List.GetNet (   self)
GetNet(PAD_List self) -> NETINFO_ITEM

NETINFO_ITEM*
BOARD_CONNECTED_ITEM::GetNet() const

Function GetNet Returns NET_INFO object for a given item. 

Definition at line 20397 of file pcbnew.py.

def pcbnew.PAD_List.GetNetClass (   self)
GetNetClass(PAD_List self) -> std::shared_ptr< NETCLASS >

NETCLASSPTR
BOARD_CONNECTED_ITEM::GetNetClass() const

Function GetNetClass returns the NETCLASS for this item. 

Definition at line 20535 of file pcbnew.py.

def pcbnew.PAD_List.GetNetClassName (   self)
GetNetClassName(PAD_List self) -> wxString

wxString BOARD_CONNECTED_ITEM::GetNetClassName() const

Function GetNetClassName returns a pointer to the netclass of the
zone.

If the net is not found (can happen when a netlist is reread, and the
net name does not exist, return the default net class (should not
return a null pointer). the Net Class name of this item 

Definition at line 20547 of file pcbnew.py.

def pcbnew.PAD_List.GetNetCode (   self)
GetNetCode(PAD_List self) -> int

int
BOARD_CONNECTED_ITEM::GetNetCode() const

Function GetNetCode.

int - the net code. 

Definition at line 20421 of file pcbnew.py.

def pcbnew.PAD_List.GetNetname (   self)
GetNetname(PAD_List self) -> wxString

const
wxString& BOARD_CONNECTED_ITEM::GetNetname() const

Function GetNetname.

wxString - the full netname 

Definition at line 20507 of file pcbnew.py.

def pcbnew.PAD_List.GetOblongDrillGeometry (   self,
  aStartPoint,
  aEndPoint,
  aWidth 
)
GetOblongDrillGeometry(PAD_List self, wxPoint aStartPoint, wxPoint aEndPoint, int & aWidth)

void
D_PAD::GetOblongDrillGeometry(wxPoint &aStartPoint, wxPoint
&aEndPoint, int &aWidth) const

Function GetOblongDrillGeometry calculates the start point, end point
and width of an equivalent segment which have the same position and
width as the hole Usefull to plot/draw oblong holes like segments with
rounded ends used in draw and plot functions.

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

aStartPoint:  = first point of the equivalent segment, relative to the
pad position.

aEndPoint:  = second point of the equivalent segment, relative to the
pad position.

aWidth:  = width equivalent segment. 

Definition at line 19438 of file pcbnew.py.

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

const wxPoint&
D_PAD::GetOffset() const 

Definition at line 19326 of file pcbnew.py.

def pcbnew.PAD_List.GetOrientation (   self)
GetOrientation(PAD_List self) -> double

double
D_PAD::GetOrientation() const

Function GetOrientation returns the rotation angle of the pad in
tenths of degrees, but soon degrees. 

Definition at line 19385 of file pcbnew.py.

def pcbnew.PAD_List.GetOrientationDegrees (   self)
GetOrientationDegrees(PAD_List self) -> double

double
D_PAD::GetOrientationDegrees() const 

Definition at line 19398 of file pcbnew.py.

def pcbnew.PAD_List.GetOrientationRadians (   self)
GetOrientationRadians(PAD_List self) -> double

double
D_PAD::GetOrientationRadians() const 

Definition at line 19408 of file pcbnew.py.

def pcbnew.PAD_List.GetPackedPadName (   self)
GetPackedPadName(PAD_List self) -> wxUint32

wxUint32
D_PAD::GetPackedPadName() const

the pad name in a wxUint32 which is possible because the pad name is
limited to 4 ASCII chars The packed pad name should be used only to
compare 2 pad names, not to try to print this name 

Definition at line 19106 of file pcbnew.py.

def pcbnew.PAD_List.GetPadName (   self)
GetPadName(PAD_List self) -> wxString

wxString
D_PAD::GetPadName() const

the pad name the pad name is limited to 4 ASCII chars 

Definition at line 19094 of file pcbnew.py.

def pcbnew.PAD_List.GetPadToDieLength (   self)
GetPadToDieLength(PAD_List self) -> int

int
D_PAD::GetPadToDieLength() const 

Definition at line 19520 of file pcbnew.py.

def pcbnew.PAD_List.GetParent (   self)
GetParent(PAD_List self) -> MODULE

MODULE* D_PAD::GetParent()
const 

Definition at line 19038 of file pcbnew.py.

def pcbnew.PAD_List.GetPos0 (   self)
GetPos0(PAD_List self) -> wxPoint

const wxPoint&
D_PAD::GetPos0() const 

Definition at line 19228 of file pcbnew.py.

def pcbnew.PAD_List.GetPosition (   self)
GetPosition(PAD_List self) -> wxPoint

const wxPoint&
D_PAD::GetPosition() const override 

Definition at line 19190 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.PAD_List.GetRoundRectCornerRadius (   self,
  args 
)
GetRoundRectCornerRadius(PAD_List self) -> int
GetRoundRectCornerRadius(PAD_List self, wxSize aSize) -> int

int
D_PAD::GetRoundRectCornerRadius(const wxSize &aSize) const

Helper function GetRoundRectCornerRadius Has meaning only for rounded
rect pads Returns the radius of the rounded corners of a rectangle
size aSize, using others setting of the pad.

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

aSize:  = size of the of the round rect. Usually the pad size but can
be the size of the pad on solder mask or solder paste

The radius of the rounded corners for this pad size. 

Definition at line 19813 of file pcbnew.py.

def pcbnew.PAD_List.GetRoundRectRadiusRatio (   self)
GetRoundRectRadiusRatio(PAD_List self) -> double

double
D_PAD::GetRoundRectRadiusRatio() const

has meaning only for rounded rect pads

the scaling factor between the smaller Y or Y size and the radius of
the rounded corners. Cannot be > 0.5 the normalized IPC-7351C value is
0.25 

Definition at line 19974 of file pcbnew.py.

def pcbnew.PAD_List.GetSelectMenuText (   self)
GetSelectMenuText(PAD_List self) -> wxString

wxString
D_PAD::GetSelectMenuText() const override

Function GetSelectMenuText returns the text to display to be used in
the selection clarification context menu when multiple items are found
at the current cursor position.

The default version of this function raises an assertion in the debug
mode and returns a string to indicate that it was not overridden to
provide the object specific text.

The menu text string. 

Definition at line 20196 of file pcbnew.py.

def pcbnew.PAD_List.GetShape (   self)
GetShape(PAD_List self) -> PAD_SHAPE_T

PAD_SHAPE_T D_PAD::GetShape()
const

Function GetShape.

the shape of this pad. 

Definition at line 19156 of file pcbnew.py.

def pcbnew.PAD_List.GetShortNetname (   self)
GetShortNetname(PAD_List self) -> wxString

const
wxString& BOARD_CONNECTED_ITEM::GetShortNetname() const

Function GetShortNetname.

wxString - the short netname 

Definition at line 20521 of file pcbnew.py.

def pcbnew.PAD_List.GetSize (   self)
GetSize(PAD_List self) -> wxSize

const wxSize& D_PAD::GetSize()
const 

Definition at line 19266 of file pcbnew.py.

def pcbnew.PAD_List.GetSolderMaskMargin (   self)
GetSolderMaskMargin(PAD_List self) -> int

int
D_PAD::GetSolderMaskMargin() const

Function GetSolderMaskMargin.

the margin for the solder mask layer usually > 0 (mask shape bigger
than pad value is 1 - the local value 2 - if null, the parent
footprint value 1 - if null, the global value 

Definition at line 19663 of file pcbnew.py.

def pcbnew.PAD_List.GetSolderPasteMargin (   self)
GetSolderPasteMargin(PAD_List self) -> wxSize

wxSize
D_PAD::GetSolderPasteMargin() const

Function GetSolderPasteMargin.

the margin for the solder mask layer usually < 0 (mask shape smaller
than pad because the margin can be dependent on the pad size, the
margin has a x and a y value value is 1 - the local value 2 - if null,
the parent footprint value 1 - if null, the global value 

Definition at line 19679 of file pcbnew.py.

def pcbnew.PAD_List.GetState (   self,
  type 
)
GetState(PAD_List self, int type) -> int

int EDA_ITEM::GetState(int
type) const 

Definition at line 20992 of file pcbnew.py.

def pcbnew.PAD_List.GetStatus (   self)
GetStatus(PAD_List self) -> STATUS_FLAGS

STATUS_FLAGS
EDA_ITEM::GetStatus() const 

Definition at line 21012 of file pcbnew.py.

def pcbnew.PAD_List.GetSubNet (   self)
GetSubNet(PAD_List self) -> int

int
BOARD_CONNECTED_ITEM::GetSubNet() const

Function GetSubNet.

int - the sub net code. 

Definition at line 20459 of file pcbnew.py.

def pcbnew.PAD_List.GetSubRatsnest (   self)
GetSubRatsnest(PAD_List self) -> int

int
D_PAD::GetSubRatsnest() const

Function GetSubRatsnest.

int - the netcode 

Definition at line 20006 of file pcbnew.py.

def pcbnew.PAD_List.GetThermalGap (   self)
GetThermalGap(PAD_List self) -> int

int
D_PAD::GetThermalGap() const 

Definition at line 19746 of file pcbnew.py.

def pcbnew.PAD_List.GetThermalWidth (   self)
GetThermalWidth(PAD_List self) -> int

int
D_PAD::GetThermalWidth() const 

Definition at line 19726 of file pcbnew.py.

def pcbnew.PAD_List.GetTimeStamp (   self)
GetTimeStamp(PAD_List self) -> time_t

time_t
EDA_ITEM::GetTimeStamp() const 

Definition at line 20782 of file pcbnew.py.

def pcbnew.PAD_List.GetZoneConnection (   self)
GetZoneConnection(PAD_List self) -> ZoneConnection

ZoneConnection
D_PAD::GetZoneConnection() const 

Definition at line 19706 of file pcbnew.py.

def pcbnew.PAD_List.GetZoneSubNet (   self)
GetZoneSubNet(PAD_List self) -> int

int
BOARD_CONNECTED_ITEM::GetZoneSubNet() const

Function GetZoneSubNet.

int - the sub net code in zone connections. 

Definition at line 20483 of file pcbnew.py.

def pcbnew.PAD_List.HitTest (   self,
  aPosition 
)
HitTest(PAD_List self, wxPoint aPosition) -> bool

virtual bool
BOARD_ITEM::HitTest(const EDA_RECT &aRect, bool aContained=true, int
aAccuracy=0) const

Function HitTest tests if the aRect intersects or contains this object
(depending on aContained).

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

aRect:  A reference to an EDA_RECT object containg the area to test.

aContained:  Test if aRect contains this object completly.

aAccuracy:  Increase the item bounding box by this amount.

bool - True if aRect contains this object completly or if aRect
intersects the object and aContained is False, otherwise false. 

Definition at line 20073 of file pcbnew.py.

def pcbnew.PAD_List.ImportSettingsFromMaster (   self,
  aMasterPad 
)
ImportSettingsFromMaster(PAD_List self, D_PAD aMasterPad)

void
D_PAD::ImportSettingsFromMaster(const D_PAD &aMasterPad)

Imports the pad settings from aMasterPad.

The result is "this" has the same settinds (sizes, shapes ... ) as
aMasterPad

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

aMasterPad:  = the template pad 

Definition at line 19048 of file pcbnew.py.

def pcbnew.PAD_List.IncrementPadName (   self,
  aSkipUnconnectable,
  aFillSequenceGaps 
)
IncrementPadName(PAD_List self, bool aSkipUnconnectable, bool aFillSequenceGaps) -> bool

bool
D_PAD::IncrementPadName(bool aSkipUnconnectable, bool
aFillSequenceGaps)

Function IncrementPadName.

Increments the pad name to the next available name in the module.

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

aSkipUnconnectable:  skips any pads that are not connectable (for
example NPTH)

aFillSequenceGaps:  if true, the next reference in a sequence like
A1,A3,A4 will be A2. If false, it will be A5.

pad name incremented 

Definition at line 19120 of file pcbnew.py.

def pcbnew.PAD_List.Insert (   self,
  aNewElement,
  aElementAfterMe 
)
Insert(PAD_List self, D_PAD aNewElement, D_PAD aElementAfterMe)

Definition at line 18917 of file pcbnew.py.

def pcbnew.PAD_List.IsBrightened (   self)
IsBrightened(PAD_List self) -> bool

bool
EDA_ITEM::IsBrightened() const 

Definition at line 20902 of file pcbnew.py.

def pcbnew.PAD_List.IsConnected (   self)
IsConnected(PAD_List self) -> bool

bool
BOARD_CONNECTED_ITEM::IsConnected() const override

>

Function IsConnected() Returns information if the object is derived
from BOARD_CONNECTED_ITEM. True if the object is of
BOARD_CONNECTED_ITEM type, false otherwise. 

Definition at line 20381 of file pcbnew.py.

def pcbnew.PAD_List.IsDragging (   self)
IsDragging(PAD_List self) -> bool

bool
EDA_ITEM::IsDragging() const 

Definition at line 20852 of file pcbnew.py.

def pcbnew.PAD_List.IsFlipped (   self)
IsFlipped(PAD_List self) -> bool

bool D_PAD::IsFlipped()
const

true if the pad has a footprint parent flipped (on the back/bottom
layer) 

Definition at line 19068 of file pcbnew.py.

def pcbnew.PAD_List.IsHighlighted (   self)
IsHighlighted(PAD_List self) -> bool

bool
EDA_ITEM::IsHighlighted() const 

Definition at line 20892 of file pcbnew.py.

def pcbnew.PAD_List.IsLocked (   self)
IsLocked(PAD_List self) -> bool

virtual bool
BOARD_ITEM::IsLocked() const

Function IsLocked.

bool - true if the object is locked, else false 

Definition at line 20657 of file pcbnew.py.

def pcbnew.PAD_List.IsModified (   self)
IsModified(PAD_List self) -> bool

bool
EDA_ITEM::IsModified() const 

Definition at line 20832 of file pcbnew.py.

def pcbnew.PAD_List.IsMoving (   self)
IsMoving(PAD_List self) -> bool

bool EDA_ITEM::IsMoving()
const 

Definition at line 20842 of file pcbnew.py.

def pcbnew.PAD_List.IsNew (   self)
IsNew(PAD_List self) -> bool

bool EDA_ITEM::IsNew() const

Definition at line 20822 of file pcbnew.py.

def pcbnew.PAD_List.IsOnLayer (   self,
  aLayer 
)
IsOnLayer(PAD_List self, PCB_LAYER_ID aLayer) -> bool

bool
D_PAD::IsOnLayer(PCB_LAYER_ID aLayer) const override

Function IsOnLayer tests to see if this object is on the given layer.

Is virtual so objects like D_PAD, which reside on multiple layers can
do their own form of testing.

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

aLayer:  The layer to test for.

bool - true if on given layer, else false. 

Definition at line 20051 of file pcbnew.py.

def pcbnew.PAD_List.IsReplaceable (   self)
IsReplaceable(PAD_List self) -> bool

virtual bool
EDA_ITEM::IsReplaceable() const

Function IsReplaceable.

Override this method in any derived object that supports test find and
replace.

True if the item has replaceable text that can be modified using the
find and replace dialog. 

Definition at line 21178 of file pcbnew.py.

def pcbnew.PAD_List.IsResized (   self)
IsResized(PAD_List self) -> bool

bool
EDA_ITEM::IsResized() const 

Definition at line 20882 of file pcbnew.py.

def pcbnew.PAD_List.IsSelected (   self)
IsSelected(PAD_List self) -> bool

bool
EDA_ITEM::IsSelected() const 

Definition at line 20872 of file pcbnew.py.

def pcbnew.PAD_List.IsTrack (   self)
IsTrack(PAD_List self) -> bool

bool
BOARD_ITEM::IsTrack() const

Function IsTrack tests to see if this object is a track or via (or
microvia).

form of testing. bool - true if a track or via, else false. 

Definition at line 20642 of file pcbnew.py.

def pcbnew.PAD_List.IsWireImage (   self)
IsWireImage(PAD_List self) -> bool

bool
EDA_ITEM::IsWireImage() const 

Definition at line 20862 of file pcbnew.py.

def pcbnew.PAD_List.IterateForward (   self,
  listStart,
  inspector,
  testData,
  scanTypes 
)
IterateForward(PAD_List self, EDA_ITEM listStart, INSPECTOR inspector, void * testData, KICAD_T const [] scanTypes) -> SEARCH_RESULT

Definition at line 21083 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.PAD_List.Matches (   self,
  aSearchData,
  aAuxData,
  aFindLocation 
)
Matches(PAD_List self, wxFindReplaceData & aSearchData, void * aAuxData, wxPoint aFindLocation) -> bool

virtual bool
EDA_ITEM::Matches(wxFindReplaceData &aSearchData, void *aAuxData,
wxPoint *aFindLocation)

Function Matches compares the item against the search criteria in
aSearchData.

The base class returns false since many of the objects derived from
EDA_ITEM do not have any text to search.

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

aSearchData:  A reference to a wxFindReplaceData object containing the
search criteria.

aAuxData:  A pointer to optional data required for the search or NULL
if not used.

aFindLocation:  A pointer to a wxPoint object to store the location of
matched item. The pointer can be NULL if it is not used.

True if the item's text matches the search criteria in aSearchData. 

Definition at line 21119 of file pcbnew.py.

def pcbnew.PAD_List.Move (   self,
  aMoveVector 
)
Move(PAD_List self, wxPoint aMoveVector)

void D_PAD::Move(const wxPoint
&aMoveVector) override

Function Move move this object.

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

aMoveVector:  - the move vector for this object. 

Definition at line 20160 of file pcbnew.py.

def pcbnew.PAD_List.Next (   self)
Next(PAD_List self) -> D_PAD

D_PAD* D_PAD::Next() const 

Definition at line 19029 of file pcbnew.py.

def pcbnew.PAD_List.PadNameEqual (   self,
  other 
)
PadNameEqual(PAD_List self, D_PAD other) -> bool

bool
D_PAD::PadNameEqual(const D_PAD *other) const 

Definition at line 19146 of file pcbnew.py.

def pcbnew.PAD_List.PopBack (   self)
PopBack(PAD_List self) -> D_PAD

Definition at line 18942 of file pcbnew.py.

def pcbnew.PAD_List.PopFront (   self)
PopFront(PAD_List self) -> D_PAD

Definition at line 18937 of file pcbnew.py.

def pcbnew.PAD_List.PushBack (   self,
  aNewElement 
)
PushBack(PAD_List self, D_PAD aNewElement)

Definition at line 18952 of file pcbnew.py.

def pcbnew.PAD_List.PushFront (   self,
  aNewElement 
)
PushFront(PAD_List self, D_PAD aNewElement)

Definition at line 18947 of file pcbnew.py.

def pcbnew.PAD_List.Remove (   self,
  aElement 
)
Remove(PAD_List self, D_PAD aElement) -> D_PAD

Definition at line 18922 of file pcbnew.py.

def pcbnew.PAD_List.Replace (   self,
  args 
)
Replace(PAD_List self, wxFindReplaceData & aSearchData, wxString aText) -> bool
Replace(PAD_List self, wxFindReplaceData & aSearchData, void * aAuxData=None) -> bool
Replace(PAD_List self, wxFindReplaceData & aSearchData) -> bool

virtual bool
EDA_ITEM::Replace(wxFindReplaceData &aSearchData, void *aAuxData=NULL)

Function Replace performs a text replace using the find and replace
criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

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

aSearchData:  A reference to a wxFindReplaceData object containing the
search and replace criteria.

aAuxData:  A pointer to optional data required for the search or NULL
if not used.

True if the item text was modified, otherwise false. 

Definition at line 21150 of file pcbnew.py.

def pcbnew.PAD_List.Rotate (   self,
  aRotCentre,
  aAngle 
)
Rotate(PAD_List self, wxPoint aRotCentre, double aAngle)

void D_PAD::Rotate(const
wxPoint &aRotCentre, double aAngle) override

Function Rotate Rotate this object.

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

aRotCentre:  - the rotation point.

aAngle:  - the rotation angle in 0.1 degree. 

Definition at line 20177 of file pcbnew.py.

def pcbnew.PAD_List.SetAttribute (   self,
  aAttribute 
)
SetAttribute(PAD_List self, PAD_ATTR_T aAttribute)

void
D_PAD::SetAttribute(PAD_ATTR_T aAttribute) 

Definition at line 19490 of file pcbnew.py.

def pcbnew.PAD_List.SetBrightened (   self)
SetBrightened(PAD_List self)

void
EDA_ITEM::SetBrightened() 

Definition at line 20942 of file pcbnew.py.

def pcbnew.PAD_List.SetDelta (   self,
  aSize 
)
SetDelta(PAD_List self, wxSize aSize)

void D_PAD::SetDelta(const
wxSize &aSize) 

Definition at line 19276 of file pcbnew.py.

def pcbnew.PAD_List.SetDrawCoord (   self)
SetDrawCoord(PAD_List self)

void
D_PAD::SetDrawCoord()

Set absolute coordinates. 

Definition at line 20131 of file pcbnew.py.

def pcbnew.PAD_List.SetDrillShape (   self,
  aDrillShape 
)
SetDrillShape(PAD_List self, PAD_DRILL_SHAPE_T aDrillShape)

void
D_PAD::SetDrillShape(PAD_DRILL_SHAPE_T aDrillShape) 

Definition at line 19418 of file pcbnew.py.

def pcbnew.PAD_List.SetDrillSize (   self,
  aSize 
)
SetDrillSize(PAD_List self, wxSize aSize)

void
D_PAD::SetDrillSize(const wxSize &aSize) 

Definition at line 19296 of file pcbnew.py.

def pcbnew.PAD_List.SetFlags (   self,
  aMask 
)
SetFlags(PAD_List self, STATUS_FLAGS aMask)

void
EDA_ITEM::SetFlags(STATUS_FLAGS aMask) 

Definition at line 21032 of file pcbnew.py.

def pcbnew.PAD_List.SetForceVisible (   self,
  aEnable 
)
SetForceVisible(PAD_List self, bool aEnable)

void
EDA_ITEM::SetForceVisible(bool aEnable)

Function SetForceVisible is used to set and cleag force visible flag
used to force the item to be drawn even if it's draw attribute is set
to not visible.

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

aEnable:  True forces the item to be drawn. False uses the item's
visibility setting to determine if the item is to be drawn. 

Definition at line 21063 of file pcbnew.py.

def pcbnew.PAD_List.SetHighlighted (   self)
SetHighlighted(PAD_List self)

void
EDA_ITEM::SetHighlighted() 

Definition at line 20932 of file pcbnew.py.

def pcbnew.PAD_List.SetLayer (   self,
  aLayer 
)
SetLayer(PAD_List self, PCB_LAYER_ID aLayer)

virtual void
BOARD_ITEM::SetLayer(PCB_LAYER_ID aLayer)

Function SetLayer sets the layer this item is on.

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

aLayer:  The layer number. is virtual because some items (in fact:
class DIMENSION) have a slightly different initialization 

Definition at line 20602 of file pcbnew.py.

def pcbnew.PAD_List.SetLayerSet (   self,
  aLayerMask 
)
SetLayerSet(PAD_List self, LSET aLayerMask)

void
D_PAD::SetLayerSet(LSET aLayerMask) 

Definition at line 19465 of file pcbnew.py.

def pcbnew.PAD_List.SetList (   self,
  aList 
)
SetList(PAD_List self, DHEAD aList)

void
EDA_ITEM::SetList(DHEAD *aList) 

Definition at line 20812 of file pcbnew.py.

def pcbnew.PAD_List.SetLocalClearance (   self,
  aClearance 
)
SetLocalClearance(PAD_List self, int aClearance)

void
D_PAD::SetLocalClearance(int aClearance) 

Definition at line 19560 of file pcbnew.py.

def pcbnew.PAD_List.SetLocalCoord (   self)
SetLocalCoord(PAD_List self)

void
D_PAD::SetLocalCoord()

Set relative coordinates. 

Definition at line 20143 of file pcbnew.py.

def pcbnew.PAD_List.SetLocalSolderMaskMargin (   self,
  aMargin 
)
SetLocalSolderMaskMargin(PAD_List self, int aMargin)

void
D_PAD::SetLocalSolderMaskMargin(int aMargin) 

Definition at line 19540 of file pcbnew.py.

def pcbnew.PAD_List.SetLocalSolderPasteMargin (   self,
  aMargin 
)
SetLocalSolderPasteMargin(PAD_List self, int aMargin)

void
D_PAD::SetLocalSolderPasteMargin(int aMargin) 

Definition at line 19580 of file pcbnew.py.

def pcbnew.PAD_List.SetLocalSolderPasteMarginRatio (   self,
  aRatio 
)
SetLocalSolderPasteMarginRatio(PAD_List self, double aRatio)

void
D_PAD::SetLocalSolderPasteMarginRatio(double aRatio) 

Definition at line 19600 of file pcbnew.py.

def pcbnew.PAD_List.SetLocked (   self,
  aLocked 
)
SetLocked(PAD_List self, bool aLocked)

virtual void
BOARD_ITEM::SetLocked(bool aLocked)

Function SetLocked modifies 'lock' status for of the item. 

Definition at line 20671 of file pcbnew.py.

def pcbnew.PAD_List.SetModified (   self)
SetModified(PAD_List self)

void
EDA_ITEM::SetModified() 

Definition at line 20982 of file pcbnew.py.

def pcbnew.PAD_List.SetNet (   self,
  aNetInfo 
)
SetNet(PAD_List self, NETINFO_ITEM aNetInfo)

void
BOARD_CONNECTED_ITEM::SetNet(NETINFO_ITEM *aNetInfo)

Function SetNet Sets a NET_INFO object for the item. 

Definition at line 20409 of file pcbnew.py.

def pcbnew.PAD_List.SetNetCode (   self,
  aNetCode,
  aNoAssert = False 
)
SetNetCode(PAD_List self, int aNetCode, bool aNoAssert=False) -> bool
SetNetCode(PAD_List self, int aNetCode) -> bool

bool
BOARD_CONNECTED_ITEM::SetNetCode(int aNetCode, bool aNoAssert=false)

Function SetNetCode sets net using a net code.

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

aNetCode:  is a net code for the new net. It has to exist in
NETINFO_LIST held by BOARD.

aNoAssert:  if true, do not assert that the net exists. Otherwise,
item is assigned to the unconnected net.

true on success, false if the net did not exist 

Definition at line 20435 of file pcbnew.py.

def pcbnew.PAD_List.SetOffset (   self,
  aOffset 
)
SetOffset(PAD_List self, wxPoint aOffset)

void D_PAD::SetOffset(const
wxPoint &aOffset) 

Definition at line 19316 of file pcbnew.py.

def pcbnew.PAD_List.SetOrientation (   self,
  aAngle 
)
SetOrientation(PAD_List self, double aAngle)

void
D_PAD::SetOrientation(double aAngle)

Function SetOrientation sets the rotation angle of the pad.

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

aAngle:  is tenths of degrees, but will soon be degrees. If it is
outside of 0 - 3600, then it will be normalized before being saved. 

Definition at line 19355 of file pcbnew.py.

def pcbnew.PAD_List.SetOrientationDegrees (   self,
  aOrientation 
)
SetOrientationDegrees(PAD_List self, double aOrientation)

void
D_PAD::SetOrientationDegrees(double aOrientation)

Set orientation in degrees. 

Definition at line 19373 of file pcbnew.py.

def pcbnew.PAD_List.SetPadName (   self,
  name 
)
SetPadName(PAD_List self, wxString name)

void
D_PAD::SetPadName(const wxString &name)

Set the pad name (sometimes called pad number, although it can be an
array ref like AA12 the pad name is limited to 4 ASCII chars. 

Definition at line 19081 of file pcbnew.py.

def pcbnew.PAD_List.SetPadToDieLength (   self,
  aLength 
)
SetPadToDieLength(PAD_List self, int aLength)

void
D_PAD::SetPadToDieLength(int aLength) 

Definition at line 19510 of file pcbnew.py.

def pcbnew.PAD_List.SetParent (   self,
  aParent 
)
SetParent(PAD_List self, EDA_ITEM aParent)

void
EDA_ITEM::SetParent(EDA_ITEM *aParent) 

Definition at line 20802 of file pcbnew.py.

def pcbnew.PAD_List.SetPos0 (   self,
  aPos 
)
SetPos0(PAD_List self, wxPoint aPos)

void D_PAD::SetPos0(const
wxPoint &aPos) 

Definition at line 19218 of file pcbnew.py.

def pcbnew.PAD_List.SetPosition (   self,
  aPos 
)
SetPosition(PAD_List self, wxPoint aPos)

void
D_PAD::SetPosition(const wxPoint &aPos) override 

Definition at line 19180 of file pcbnew.py.

def pcbnew.PAD_List.SetRoundRectRadiusRatio (   self,
  aRadiusScale 
)
SetRoundRectRadiusRatio(PAD_List self, double aRadiusScale)

void
D_PAD::SetRoundRectRadiusRatio(double aRadiusScale)

has meaning only for rounded rect pads Set the scaling factor between
the smaller Y or Y size and the radius of the rounded corners.

Cannot be < 0.5 and obviously must be > 0 the normalized IPC-7351C
value is 0.25 

Definition at line 19990 of file pcbnew.py.

def pcbnew.PAD_List.SetSelected (   self)
SetSelected(PAD_List self)

void
EDA_ITEM::SetSelected() 

Definition at line 20922 of file pcbnew.py.

def pcbnew.PAD_List.SetShape (   self,
  aShape 
)
SetShape(PAD_List self, PAD_SHAPE_T aShape)

void
D_PAD::SetShape(PAD_SHAPE_T aShape) 

Definition at line 19170 of file pcbnew.py.

def pcbnew.PAD_List.SetSize (   self,
  aSize 
)
SetSize(PAD_List self, wxSize aSize)

void D_PAD::SetSize(const
wxSize &aSize) 

Definition at line 19256 of file pcbnew.py.

def pcbnew.PAD_List.SetState (   self,
  type,
  state 
)
SetState(PAD_List self, int type, int state)

void
EDA_ITEM::SetState(int type, int state) 

Definition at line 21002 of file pcbnew.py.

def pcbnew.PAD_List.SetStatus (   self,
  aStatus 
)
SetStatus(PAD_List self, STATUS_FLAGS aStatus)

void
EDA_ITEM::SetStatus(STATUS_FLAGS aStatus) 

Definition at line 21022 of file pcbnew.py.

def pcbnew.PAD_List.SetSubNet (   self,
  aSubNetCode 
)
SetSubNet(PAD_List self, int aSubNetCode)

void
BOARD_CONNECTED_ITEM::SetSubNet(int aSubNetCode) 

Definition at line 20473 of file pcbnew.py.

def pcbnew.PAD_List.SetSubRatsnest (   self,
  aSubRatsnest 
)
SetSubRatsnest(PAD_List self, int aSubRatsnest)

void
D_PAD::SetSubRatsnest(int aSubRatsnest) 

Definition at line 20020 of file pcbnew.py.

def pcbnew.PAD_List.SetThermalGap (   self,
  aGap 
)
SetThermalGap(PAD_List self, int aGap)

void
D_PAD::SetThermalGap(int aGap) 

Definition at line 19736 of file pcbnew.py.

def pcbnew.PAD_List.SetThermalWidth (   self,
  aWidth 
)
SetThermalWidth(PAD_List self, int aWidth)

void
D_PAD::SetThermalWidth(int aWidth) 

Definition at line 19716 of file pcbnew.py.

def pcbnew.PAD_List.SetTimeStamp (   self,
  aNewTimeStamp 
)
SetTimeStamp(PAD_List self, time_t aNewTimeStamp)

void
EDA_ITEM::SetTimeStamp(time_t aNewTimeStamp) 

Definition at line 20772 of file pcbnew.py.

def pcbnew.PAD_List.SetWireImage (   self)
SetWireImage(PAD_List self)

void
EDA_ITEM::SetWireImage() 

Definition at line 20912 of file pcbnew.py.

def pcbnew.PAD_List.SetX (   self,
  x 
)
SetX(PAD_List self, int x)

void D_PAD::SetX(int x) 

Definition at line 19209 of file pcbnew.py.

def pcbnew.PAD_List.SetX0 (   self,
  x 
)
SetX0(PAD_List self, int x)

void D_PAD::SetX0(int x) 

Definition at line 19247 of file pcbnew.py.

def pcbnew.PAD_List.SetY (   self,
  y 
)
SetY(PAD_List self, int y)

void D_PAD::SetY(int y) 

Definition at line 19200 of file pcbnew.py.

def pcbnew.PAD_List.SetY0 (   self,
  y 
)
SetY0(PAD_List self, int y)

void D_PAD::SetY0(int y) 

Definition at line 19238 of file pcbnew.py.

def pcbnew.PAD_List.SetZoneConnection (   self,
  aType 
)
SetZoneConnection(PAD_List self, ZoneConnection aType)

void
D_PAD::SetZoneConnection(ZoneConnection aType) 

Definition at line 19696 of file pcbnew.py.

def pcbnew.PAD_List.SetZoneSubNet (   self,
  aSubNetCode 
)
SetZoneSubNet(PAD_List self, int aSubNetCode)

void
BOARD_CONNECTED_ITEM::SetZoneSubNet(int aSubNetCode) 

Definition at line 20497 of file pcbnew.py.

def pcbnew.PAD_List.ShapePos (   self)
ShapePos(PAD_List self) -> wxPoint

wxPoint D_PAD::ShapePos()
const 

Definition at line 19964 of file pcbnew.py.

def pcbnew.PAD_List.ShowPadAttr (   self)
ShowPadAttr(PAD_List self) -> wxString

wxString
D_PAD::ShowPadAttr() const

Function ShowPadAttr.

the name of the pad type (attribute) : STD, SMD ... 

Definition at line 20247 of file pcbnew.py.

def pcbnew.PAD_List.ShowPadShape (   self)
ShowPadShape(PAD_List self) -> wxString

wxString
D_PAD::ShowPadShape() const

Function ShowPadShape.

the name of the shape 

Definition at line 20233 of file pcbnew.py.

def pcbnew.PAD_List.ShowShape (   self,
  aShape 
)
ShowShape(PAD_List self, STROKE_T aShape) -> wxString

Definition at line 20710 of file pcbnew.py.

def pcbnew.PAD_List.SMDMask (   self)
SMDMask(PAD_List self) -> LSET

Definition at line 19009 of file pcbnew.py.

def pcbnew.PAD_List.Sort (   self,
  aLeft,
  aRight 
)
Sort(PAD_List self, EDA_ITEM aLeft, EDA_ITEM aRight) -> bool

Definition at line 21201 of file pcbnew.py.

def pcbnew.PAD_List.StandardMask (   self)
StandardMask(PAD_List self) -> LSET

Definition at line 19004 of file pcbnew.py.

def pcbnew.PAD_List.StringPadName (   self,
  text 
)
StringPadName(PAD_List self, wxString text)

void
D_PAD::StringPadName(wxString &text) const 

Definition at line 19939 of file pcbnew.py.

def pcbnew.PAD_List.SwapData (   self,
  aImage 
)
SwapData(PAD_List self, BOARD_ITEM aImage)

void
BOARD_ITEM::SwapData(BOARD_ITEM *aImage)

Swap data between aItem and aImage.

aItem and aImage should have the same type Used in undo redo command
to swap values between an item and its copy Only values like layer,
size .. which are modified by edition are swapped, not the pointers
like Pnext and Pback because aItem is not changed in the linked list

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

aImage:  = the item image which contains data to swap 

Definition at line 20620 of file pcbnew.py.

def pcbnew.PAD_List.TransformShapeWithClearanceToPolygon (   self,
  aCornerBuffer,
  aClearanceValue,
  aCircleToSegmentsCount,
  aCorrectionFactor 
)
TransformShapeWithClearanceToPolygon(PAD_List self, SHAPE_POLY_SET aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor)

void D_PAD::TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET
&aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount,
double aCorrectionFactor) const

Function TransformShapeWithClearanceToPolygon Convert the pad shape to
a closed polygon Used in filling zones calculations Circles and arcs
are approximated by segments.

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

aCornerBuffer:  = a buffer to store the polygon

aClearanceValue:  = the clearance around the pad

aCircleToSegmentsCount:  = the number of segments to approximate a
circle

aCorrectionFactor:  = the correction to apply to circles radius to
keep clearance when the circle is approximated by segment bigger or
equal to the real clearance value (usually near from 1.0) 

Definition at line 19610 of file pcbnew.py.

def pcbnew.PAD_List.Type (   self)
Type(PAD_List self) -> KICAD_T

KICAD_T EDA_ITEM::Type() const

Function Type()

returns the type of object. This attribute should never be changed
after a constructor sets it, so there is no public "setter" method.
KICAD_T - the type of object. 

Definition at line 20757 of file pcbnew.py.

def pcbnew.PAD_List.UnLink (   self)
UnLink(PAD_List self)

void BOARD_ITEM::UnLink()

Function UnLink detaches this object from its owner.

This base class implementation should work for all derived classes
which are held in a DLIST<>. 

Definition at line 20683 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.PAD_List.UnplatedHoleMask (   self)
UnplatedHoleMask(PAD_List self) -> LSET

Definition at line 19019 of file pcbnew.py.

def pcbnew.PAD_List.ViewBBox (   self)
ViewBBox(PAD_List self) -> BOX2I const

const BOX2I D_PAD::ViewBBox()
const override 

Definition at line 20333 of file pcbnew.py.

def pcbnew.PAD_List.ViewGetLayers (   self,
  aLayers,
  aCount 
)
ViewGetLayers(PAD_List self, int [] aLayers, int & aCount)

void
D_PAD::ViewGetLayers(int aLayers[], int &aCount) const override 

Definition at line 20313 of file pcbnew.py.

def pcbnew.PAD_List.ViewGetLOD (   self,
  aLayer,
  aView 
)
ViewGetLOD(PAD_List self, int aLayer, KIGFX::VIEW * aView) -> unsigned int

unsigned int
D_PAD::ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override 

Definition at line 20323 of file pcbnew.py.

def pcbnew.PAD_List.Visit (   self,
  inspector,
  testData,
  scanTypes 
)
Visit(PAD_List self, INSPECTOR inspector, void * testData, KICAD_T const [] scanTypes) -> SEARCH_RESULT

SEARCH_RESULT
EDA_ITEM::Visit(INSPECTOR inspector, void *testData, const KICAD_T
scanTypes[])

Function Visit may be re-implemented for each derived class in order
to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in
scanTypes[], and may use IterateForward() to do so on lists of such
data.

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

inspector:  An INSPECTOR instance to use in the inspection.

testData:  Arbitrary data used by the inspector.

scanTypes:  Which KICAD_T types are of interest and the order is
significant too, terminated by EOT.

SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else
SCAN_CONTINUE, and determined by the inspector. 

Definition at line 21088 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.PAD_List.m_PadsConnected = _swig_property(_pcbnew.PAD_List_m_PadsConnected_get, _pcbnew.PAD_List_m_PadsConnected_set)
static

Definition at line 20379 of file pcbnew.py.

tuple pcbnew.PAD_List.m_TracksConnected = _swig_property(_pcbnew.PAD_List_m_TracksConnected_get, _pcbnew.PAD_List_m_TracksConnected_set)
static

Definition at line 20375 of file pcbnew.py.

tuple pcbnew.PAD_List.ret = self.last.Get()
static

Definition at line 18976 of file pcbnew.py.

pcbnew.PAD_List.ret = self.last
static

Definition at line 18978 of file pcbnew.py.

pcbnew.PAD_List.this

Definition at line 19000 of file pcbnew.py.


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