KiCAD pcbnew scripting
Classes | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.MODULE_List Class Reference
Inheritance diagram for pcbnew.MODULE_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 ClassOf (self, aItem)
 
def Next (self)
 
def Back (self)
 
def AddNative
 
def RemoveNative (self, aItem)
 
def ClearAllNets (self)
 
def CalculateBoundingBox (self)
 
def GetFootprintRect (self)
 
def GetBoundingBox (self)
 
def PadsList (self, args)
 
def GraphicalItemsList (self, args)
 
def Pads (self)
 
def GraphicalItems (self)
 
def Models (self, args)
 
def SetPosition (self, aPos)
 
def GetPosition (self)
 
def SetOrientation (self, newangle)
 
def SetOrientationDegrees (self, aOrientation)
 
def GetOrientation (self)
 
def GetOrientationDegrees (self)
 
def GetOrientationRadians (self)
 
def GetFPID (self)
 
def SetFPID (self, aFPID)
 
def GetDescription (self)
 
def SetDescription (self, aDoc)
 
def GetKeywords (self)
 
def SetKeywords (self, aKeywords)
 
def GetPath (self)
 
def SetPath (self, aPath)
 
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 SetZoneConnection (self, aType)
 
def GetZoneConnection (self)
 
def SetThermalWidth (self, aWidth)
 
def GetThermalWidth (self)
 
def SetThermalGap (self, aGap)
 
def GetThermalGap (self)
 
def GetAttributes (self)
 
def SetAttributes (self, aAttributes)
 
def SetFlag (self, aFlag)
 
def IncrementFlag (self)
 
def GetFlag (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def MoveAnchorPosition (self, aMoveVector)
 
def IsFlipped (self)
 
def IsLocked (self)
 
def SetLocked (self, isLocked)
 
def IsPlaced (self)
 
def SetIsPlaced (self, isPlaced)
 
def NeedsPlaced (self)
 
def SetNeedsPlaced (self, needsPlaced)
 
def PadsLocked (self)
 
def SetPadsLocked (self, aPadsLocked)
 
def SetLastEditTime (self, args)
 
def GetLastEditTime (self)
 
def Draw (self, args)
 
def DrawOutlinesWhenMoving (self, aPanel, aDC, aMoveVector)
 
def TransformPadsShapesWithClearanceToPolygon
 
def TransformGraphicShapesWithClearanceToPolygonSet
 
def TransformGraphicTextWithClearanceToPolygonSet
 
def DrawEdgesOnly (self, panel, DC, offset, draw_mode)
 
def DrawAncre (self, panel, DC, offset, dim_ancre, draw_mode)
 
def GetMsgPanelInfo (self, aList)
 
def HitTest (self, args)
 
def GetReference (self)
 
def SetReference (self, aReference)
 
def GetReferencePrefix (self)
 
def GetValue (self)
 
def SetValue (self, aValue)
 
def Value (self, args)
 
def Reference (self, args)
 
def FindPadByName (self, aPadName)
 
def GetPad (self, args)
 
def GetTopLeftPad (self)
 
def GetPadCount (self, args)
 
def GetUniquePadCount (self, args)
 
def GetNextPadName (self, aFillSequenceGaps)
 
def GetArea (self)
 
def GetLink (self)
 
def SetLink (self, aLink)
 
def GetPlacementCost180 (self)
 
def SetPlacementCost180 (self, aCost)
 
def GetPlacementCost90 (self)
 
def SetPlacementCost90 (self, aCost)
 
def Duplicate
 
def Add3DModel (self, a3DModel)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Clone (self)
 
def RunOnChildren (self, aFunction)
 
def ViewGetLayers (self, aLayers, aCount)
 
def ViewGetLOD (self, aLayer, aView)
 
def ViewBBox (self)
 
def CopyNetlistSettings (self, aModule, aCopyLocalSettings)
 
def IsLibNameValid (self, aName)
 
def StringLibNameInvalidChars (self, aUserReadable)
 
def SetInitialComments (self, aInitialComments)
 
def PadCoverageRatio (self)
 
def GetInitialComments (self)
 
def GetPolyCourtyardFront (self)
 
def GetPolyCourtyardBack (self)
 
def BuildPolyCourtyard (self)
 
def DeleteNative (self, aItem)
 
def GetCenter (self)
 
def IsConnected (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def SwapData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
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 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
 

Detailed Description

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

Definition at line 37071 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.MODULE_List.__init__ (   self)
__init__(DLIST<(MODULE)> self) -> MODULE_List

Definition at line 37188 of file pcbnew.py.

Member Function Documentation

def pcbnew.MODULE_List.__deref__ (   self)
__deref__(MODULE_List self) -> MODULE

Definition at line 37088 of file pcbnew.py.

def pcbnew.MODULE_List.__iter__ (   self)

Definition at line 37183 of file pcbnew.py.

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

Definition at line 39479 of file pcbnew.py.

def pcbnew.MODULE_List.Add3DModel (   self,
  a3DModel 
)
Add3DModel(MODULE_List self, S3D_INFO * a3DModel)

void
MODULE::Add3DModel(S3D_INFO *a3DModel)

Function Add3DModel adds a3DModel definition to the end of the 3D
model list.

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

a3DModel:  A pointer to a S3D_INFO to add to the list. 

Definition at line 38495 of file pcbnew.py.

def pcbnew.MODULE_List.AddNative (   self,
  aItem,
  aMode = ADD_INSERT 
)
AddNative(MODULE_List self, BOARD_ITEM aItem, ADD_MODE aMode=ADD_INSERT)
AddNative(MODULE_List self, BOARD_ITEM aItem)

void MODULE::Add(BOARD_ITEM
*aItem, ADD_MODE aMode=ADD_INSERT) override

>

Adds an item to the container.

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

aItem:  is an item to be added.

aMode:  decides whether the item is added in the beginning or at the
end of the list. 

Definition at line 37221 of file pcbnew.py.

def pcbnew.MODULE_List.Append (   self,
  args 
)
Append(MODULE_List self, MODULE aNewElement)
Append(MODULE_List self, MODULE_List aList)

Definition at line 37103 of file pcbnew.py.

def pcbnew.MODULE_List.Back (   self)
Back(MODULE_List self) -> MODULE

MODULE* MODULE::Back() const 

Definition at line 37212 of file pcbnew.py.

def pcbnew.MODULE_List.begin (   self)
begin(MODULE_List self) -> MODULE

Definition at line 37121 of file pcbnew.py.

def pcbnew.MODULE_List.BuildPolyCourtyard (   self)
BuildPolyCourtyard(MODULE_List self) -> bool

bool
MODULE::BuildPolyCourtyard()

Used in DRC to build the courtyard area (a complex polygon) from
graphic items put on the courtyard.

true if OK, or no courtyard defined, false only if the polygon cannot
be built due to amalformed courtyard shape The polygon cannot be built
if segments/arcs on courtyard layers cannot be grouped in a polygon.

Definition at line 38815 of file pcbnew.py.

def pcbnew.MODULE_List.CalculateBoundingBox (   self)
CalculateBoundingBox(MODULE_List self)

void
MODULE::CalculateBoundingBox()

Function CalculateBoundingBox calculates the bounding box in board
coordinates. 

Definition at line 37280 of file pcbnew.py.

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

Definition at line 37198 of file pcbnew.py.

def pcbnew.MODULE_List.ClearAllNets (   self)
ClearAllNets(MODULE_List self)

void
MODULE::ClearAllNets()

Function ClearAllNets Clear (i.e.

force the ORPHANED dummy net info) the net info which depends on a
given board for all pads of the footprint. This is needed when a
footprint is copied between the fp editor and the board editor for
instance, because net info become fully broken 

Definition at line 37263 of file pcbnew.py.

def pcbnew.MODULE_List.ClearBrightened (   self)
ClearBrightened(MODULE_List self)

void
EDA_ITEM::ClearBrightened() 

Definition at line 39286 of file pcbnew.py.

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

void
EDA_ITEM::ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS) 

Definition at line 39356 of file pcbnew.py.

def pcbnew.MODULE_List.ClearHighlighted (   self)
ClearHighlighted(MODULE_List self)

void
EDA_ITEM::ClearHighlighted() 

Definition at line 39276 of file pcbnew.py.

def pcbnew.MODULE_List.ClearSelected (   self)
ClearSelected(MODULE_List self)

void
EDA_ITEM::ClearSelected() 

Definition at line 39266 of file pcbnew.py.

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

EDA_ITEM * MODULE::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 38595 of file pcbnew.py.

def pcbnew.MODULE_List.CopyNetlistSettings (   self,
  aModule,
  aCopyLocalSettings 
)
CopyNetlistSettings(MODULE_List self, MODULE aModule, bool aCopyLocalSettings)

void
MODULE::CopyNetlistSettings(MODULE *aModule, bool aCopyLocalSettings)

Function CopyNetlistSettings copies the netlist settings to aModule.

Used to copy some footprint 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 MODULE settings not define by a
MODULE in a netlist. These setting include placement prms (position,
orientation, side) and optionally local prms( clearances, zone
connection type, etc). The reference designator, value, path, and
physical geometry settings are not copied.

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

aModule:  is the MODULE to copy the settings to.

aCopyLocalSettings:  = false to copy only module placement true to
also copy local prms 

Definition at line 38693 of file pcbnew.py.

def pcbnew.MODULE_List.DeleteNative (   self,
  aItem 
)
DeleteNative(MODULE_List self, BOARD_ITEM aItem)

virtual void
BOARD_ITEM_CONTAINER::Delete(BOARD_ITEM *aItem)

Removes an item from the containter and deletes it.

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

aItem:  is an item to be deleted. 

Definition at line 38833 of file pcbnew.py.

def pcbnew.MODULE_List.DeleteStructure (   self)
DeleteStructure(MODULE_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 39011 of file pcbnew.py.

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

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

Function Draw draws the footprint to the aDC.

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

aPanel:  = draw panel, Used to know the clip box

aDC:  = Current Device Context

aDrawMode:  = GR_OR, GR_XOR..

aOffset:  = draw offset (usually wxPoint(0,0) 

Definition at line 37922 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.MODULE_List.DrawAncre (   self,
  panel,
  DC,
  offset,
  dim_ancre,
  draw_mode 
)
DrawAncre(MODULE_List self, EDA_DRAW_PANEL * panel, wxDC * DC, wxPoint offset, int dim_ancre, GR_DRAWMODE draw_mode)

void
MODULE::DrawAncre(EDA_DRAW_PANEL *panel, wxDC *DC, const wxPoint
&offset, int dim_ancre, GR_DRAWMODE draw_mode)

Function DrawAncre Draw the anchor cross (vertical) Must be done after
the pads, because drawing the hole will erase overwrite every thing
already drawn. 

Definition at line 38116 of file pcbnew.py.

def pcbnew.MODULE_List.DrawEdgesOnly (   self,
  panel,
  DC,
  offset,
  draw_mode 
)
DrawEdgesOnly(MODULE_List self, EDA_DRAW_PANEL * panel, wxDC * DC, wxPoint offset, GR_DRAWMODE draw_mode)

void
MODULE::DrawEdgesOnly(EDA_DRAW_PANEL *panel, wxDC *DC, const wxPoint
&offset, GR_DRAWMODE draw_mode)

Function DrawEdgesOnly Draws the footprint edges only to the current
Device Context.

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

panel:  = The active Draw Panel (used to know the clip box)

DC:  = current Device Context

offset:  = draw offset (usually wxPoint(0,0)

draw_mode:  = GR_OR, GR_XOR, GR_AND 

Definition at line 38091 of file pcbnew.py.

def pcbnew.MODULE_List.DrawOutlinesWhenMoving (   self,
  aPanel,
  aDC,
  aMoveVector 
)
DrawOutlinesWhenMoving(MODULE_List self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, wxPoint aMoveVector)

void
MODULE::DrawOutlinesWhenMoving(EDA_DRAW_PANEL *aPanel, wxDC *aDC,
const wxPoint &aMoveVector)

Function DrawOutlinesWhenMoving draws in XOR mode the footprint when
moving it to the aDC.

To speed up the drawing, only a simplified shape is drawn

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

aPanel:  = draw panel, Used to know the clip box

aDC:  = Current Device Context

aMoveVector:  = the offset between the curr position and the draw
position. 

Definition at line 37947 of file pcbnew.py.

def pcbnew.MODULE_List.Duplicate (   self,
  aItem,
  aIncrementPadNumbers,
  aAddToModule = False 
)
Duplicate(MODULE_List self, BOARD_ITEM aItem, bool aIncrementPadNumbers, bool aAddToModule=False) -> BOARD_ITEM
Duplicate(MODULE_List self, BOARD_ITEM aItem, bool aIncrementPadNumbers) -> BOARD_ITEM

BOARD_ITEM *
MODULE::Duplicate(const BOARD_ITEM *aItem, bool aIncrementPadNumbers,
bool aAddToModule=false)

Function Duplicate Duplicate a given item within the module, without
adding to the board.

the new item, or NULL if the item could not be duplicated 

Definition at line 38478 of file pcbnew.py.

def pcbnew.MODULE_List.end (   self)
end(MODULE_List self) -> MODULE

Definition at line 37126 of file pcbnew.py.

def pcbnew.MODULE_List.FindPadByName (   self,
  aPadName 
)
FindPadByName(MODULE_List self, wxString aPadName) -> D_PAD

D_PAD *
MODULE::FindPadByName(const wxString &aPadName) const

Function FindPadByName returns a D_PAD* with a matching name.

Note that names may not be unique, depending on how the foot print was
created.

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

aPadName:  the pad name to find

D_PAD* - The first matching name is returned, or NULL if not found. 

Definition at line 38284 of file pcbnew.py.

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

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

Function Flip Flip this object, i.e.

change the board side for this object

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

aCentre:  - the rotation point.

Mirror the Y position 

Definition at line 37754 of file pcbnew.py.

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

Definition at line 39066 of file pcbnew.py.

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

Definition at line 39057 of file pcbnew.py.

def pcbnew.MODULE_List.Get (   self)
Get(MODULE_List self) -> MODULE

Definition at line 37083 of file pcbnew.py.

def pcbnew.MODULE_List.GetArea (   self)
GetArea(MODULE_List self) -> double

double MODULE::GetArea()
const 

Definition at line 38408 of file pcbnew.py.

def pcbnew.MODULE_List.GetAttributes (   self)
GetAttributes(MODULE_List self) -> int

int
MODULE::GetAttributes() const 

Definition at line 37668 of file pcbnew.py.

def pcbnew.MODULE_List.GetBoard (   self)
GetBoard(MODULE_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 39029 of file pcbnew.py.

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

const EDA_RECT
MODULE::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 37308 of file pcbnew.py.

def pcbnew.MODULE_List.GetCenter (   self)
GetCenter(MODULE_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 38850 of file pcbnew.py.

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

wxString MODULE::GetClass()
const override

Function GetClass returns the class name.

wxString 

Definition at line 38544 of file pcbnew.py.

def pcbnew.MODULE_List.GetDescription (   self)
GetDescription(MODULE_List self) -> wxString

const wxString&
MODULE::GetDescription() const 

Definition at line 37468 of file pcbnew.py.

def pcbnew.MODULE_List.GetFirst (   self)
GetFirst(MODULE_List self) -> MODULE

Definition at line 37093 of file pcbnew.py.

def pcbnew.MODULE_List.GetFlag (   self)
GetFlag(MODULE_List self) -> int

int MODULE::GetFlag() const

Definition at line 37708 of file pcbnew.py.

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

STATUS_FLAGS
EDA_ITEM::GetFlags() const 

Definition at line 39367 of file pcbnew.py.

def pcbnew.MODULE_List.GetFootprintRect (   self)
GetFootprintRect(MODULE_List self) -> EDA_RECT

EDA_RECT
MODULE::GetFootprintRect() const

Function GetFootprintRect() Returns the area of the module footprint
excluding any text.

EDA_RECT - The rectangle containing the footprint. 

Definition at line 37293 of file pcbnew.py.

def pcbnew.MODULE_List.GetFPID (   self)
GetFPID(MODULE_List self) -> LIB_ID

const LIB_ID&
MODULE::GetFPID() const 

Definition at line 37448 of file pcbnew.py.

def pcbnew.MODULE_List.GetInitialComments (   self)
GetInitialComments(MODULE_List self) -> wxArrayString const *

const
wxArrayString* MODULE::GetInitialComments() const

Return the initial comments block or NULL if none, without transfer of
ownership. 

Definition at line 38778 of file pcbnew.py.

def pcbnew.MODULE_List.GetKeywords (   self)
GetKeywords(MODULE_List self) -> wxString

const wxString&
MODULE::GetKeywords() const 

Definition at line 37488 of file pcbnew.py.

def pcbnew.MODULE_List.GetLast (   self)
GetLast(MODULE_List self) -> MODULE

Definition at line 37098 of file pcbnew.py.

def pcbnew.MODULE_List.GetLastEditTime (   self)
GetLastEditTime(MODULE_List self) -> time_t

time_t
MODULE::GetLastEditTime() const 

Definition at line 37912 of file pcbnew.py.

def pcbnew.MODULE_List.GetLayer (   self)
GetLayer(MODULE_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 38893 of file pcbnew.py.

def pcbnew.MODULE_List.GetLayerName (   self)
GetLayerName(MODULE_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 39042 of file pcbnew.py.

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

virtual LSET
BOARD_ITEM::GetLayerSet() const

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 38905 of file pcbnew.py.

def pcbnew.MODULE_List.GetLink (   self)
GetLink(MODULE_List self) -> time_t

time_t MODULE::GetLink()
const 

Definition at line 38418 of file pcbnew.py.

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

DHEAD* EDA_ITEM::GetList()
const 

Definition at line 39106 of file pcbnew.py.

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

int
MODULE::GetLocalClearance() const 

Definition at line 37548 of file pcbnew.py.

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

int
MODULE::GetLocalSolderMaskMargin() const 

Definition at line 37528 of file pcbnew.py.

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

int
MODULE::GetLocalSolderPasteMargin() const 

Definition at line 37568 of file pcbnew.py.

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

double
MODULE::GetLocalSolderPasteMarginRatio() const 

Definition at line 37588 of file pcbnew.py.

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

BITMAP_DEF
MODULE::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 38578 of file pcbnew.py.

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

void
MODULE::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 38131 of file pcbnew.py.

def pcbnew.MODULE_List.GetNextPadName (   self,
  aFillSequenceGaps 
)
GetNextPadName(MODULE_List self, bool aFillSequenceGaps) -> wxString

wxString
MODULE::GetNextPadName(bool aFillSequenceGaps) const

Function GetNextPadName returns the next available pad name in the
module.

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

aFillSequenceGaps:  true if the numbering should "fill in" gaps in
the sequence, else return the highest value + 1

the next available pad name 

Definition at line 38387 of file pcbnew.py.

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

double
MODULE::GetOrientation() const 

Definition at line 37418 of file pcbnew.py.

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

double
MODULE::GetOrientationDegrees() const 

Definition at line 37428 of file pcbnew.py.

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

double
MODULE::GetOrientationRadians() const 

Definition at line 37438 of file pcbnew.py.

def pcbnew.MODULE_List.GetPad (   self,
  args 
)
GetPad(MODULE_List self, wxPoint aPosition, LSET aLayerMask) -> D_PAD
GetPad(MODULE_List self, wxPoint aPosition) -> D_PAD

D_PAD * MODULE::GetPad(const
wxPoint &aPosition, LSET aLayerMask=LSET::AllLayersMask())

Function GetPad get a pad at aPosition on aLayerMask in the footprint.

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

aPosition:  A wxPoint object containing the position to hit test.

aLayerMask:  A layer or layers to mask the hit test.

A pointer to a D_PAD object if found otherwise NULL. 

Definition at line 38306 of file pcbnew.py.

def pcbnew.MODULE_List.GetPadCount (   self,
  args 
)
GetPadCount(MODULE_List self, INCLUDE_NPTH_T aIncludeNPTH) -> unsigned int
GetPadCount(MODULE_List self) -> unsigned int

unsigned
MODULE::GetPadCount(INCLUDE_NPTH_T
aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const

GetPadCount returns the number of pads.

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

aIncludeNPTH:  includes non-plated through holes when true. Does not
include non- plated through holes when false.

the number of pads according to aIncludeNPTH. 

Definition at line 38338 of file pcbnew.py.

def pcbnew.MODULE_List.GetParent (   self)
GetParent(MODULE_List self) -> BOARD_ITEM_CONTAINER

BOARD_ITEM_CONTAINER*
BOARD_ITEM::GetParent() const 

Definition at line 38883 of file pcbnew.py.

def pcbnew.MODULE_List.GetPath (   self)
GetPath(MODULE_List self) -> wxString

const wxString&
MODULE::GetPath() const 

Definition at line 37508 of file pcbnew.py.

def pcbnew.MODULE_List.GetPlacementCost180 (   self)
GetPlacementCost180(MODULE_List self) -> int

int
MODULE::GetPlacementCost180() const 

Definition at line 38438 of file pcbnew.py.

def pcbnew.MODULE_List.GetPlacementCost90 (   self)
GetPlacementCost90(MODULE_List self) -> int

int
MODULE::GetPlacementCost90() const 

Definition at line 38458 of file pcbnew.py.

def pcbnew.MODULE_List.GetPolyCourtyardBack (   self)
GetPolyCourtyardBack(MODULE_List self) -> SHAPE_POLY_SET

SHAPE_POLY_SET&
MODULE::GetPolyCourtyardBack() 

Definition at line 38805 of file pcbnew.py.

def pcbnew.MODULE_List.GetPolyCourtyardFront (   self)
GetPolyCourtyardFront(MODULE_List self) -> SHAPE_POLY_SET

SHAPE_POLY_SET&
MODULE::GetPolyCourtyardFront()

Used in DRC to test the courtyard area (a complex polygon)

the courtyard polygon 

Definition at line 38791 of file pcbnew.py.

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

const wxPoint&
MODULE::GetPosition() const override 

Definition at line 37388 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.MODULE_List.GetReference (   self)
GetReference(MODULE_List self) -> wxString

const wxString&
MODULE::GetReference() const

Function GetReference.

const wxString& - the reference designator text. 

Definition at line 38181 of file pcbnew.py.

def pcbnew.MODULE_List.GetReferencePrefix (   self)
GetReferencePrefix(MODULE_List self) -> wxString

wxString
MODULE::GetReferencePrefix() const

Function GetReference prefix Gets the alphabetic prefix of the module
reference - e.g.

R1 -> R IC34 -> IC the reference prefix (may be empty) 

Definition at line 38213 of file pcbnew.py.

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

wxString
MODULE::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 38558 of file pcbnew.py.

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

int EDA_ITEM::GetState(int
type) const 

Definition at line 39306 of file pcbnew.py.

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

STATUS_FLAGS
EDA_ITEM::GetStatus() const 

Definition at line 39326 of file pcbnew.py.

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

int
MODULE::GetThermalGap() const 

Definition at line 37658 of file pcbnew.py.

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

int
MODULE::GetThermalWidth() const 

Definition at line 37638 of file pcbnew.py.

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

time_t
EDA_ITEM::GetTimeStamp() const 

Definition at line 39096 of file pcbnew.py.

def pcbnew.MODULE_List.GetTopLeftPad (   self)
GetTopLeftPad(MODULE_List self) -> D_PAD

D_PAD *
MODULE::GetTopLeftPad() 

Definition at line 38328 of file pcbnew.py.

def pcbnew.MODULE_List.GetUniquePadCount (   self,
  args 
)
GetUniquePadCount(MODULE_List self, INCLUDE_NPTH_T aIncludeNPTH) -> unsigned int
GetUniquePadCount(MODULE_List self) -> unsigned int

unsigned
MODULE::GetUniquePadCount(INCLUDE_NPTH_T
aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const

GetUniquePadCount returns the number of unique pads.

A complex pad can be built with many pads having the same pad name to
create a complex shape or fragmented solder paste areas.

GetUniquePadCount calculate the count of not blank pad names

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

aIncludeNPTH:  includes non-plated through holes when true. Does not
include non- plated through holes when false.

the number of unique pads according to aIncludeNPTH. 

Definition at line 38360 of file pcbnew.py.

def pcbnew.MODULE_List.GetValue (   self)
GetValue(MODULE_List self) -> wxString

const wxString&
MODULE::GetValue() const

Function GetValue.

const wxString& - the value text. 

Definition at line 38228 of file pcbnew.py.

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

ZoneConnection
MODULE::GetZoneConnection() const 

Definition at line 37618 of file pcbnew.py.

def pcbnew.MODULE_List.GraphicalItems (   self)
GraphicalItems(MODULE_List self) -> DLIST_ITERATOR_WRAPPER< BOARD_ITEM >

DLIST_ITERATOR_WRAPPER<BOARD_ITEM> MODULE::GraphicalItems() 

Definition at line 37358 of file pcbnew.py.

def pcbnew.MODULE_List.GraphicalItemsList (   self,
  args 
)
GraphicalItemsList(MODULE_List self) -> BOARD_ITEM_List
GraphicalItemsList(MODULE_List self) -> BOARD_ITEM_List

const
DLIST<BOARD_ITEM>& MODULE::GraphicalItemsList() const 

Definition at line 37337 of file pcbnew.py.

def pcbnew.MODULE_List.HitTest (   self,
  args 
)
HitTest(MODULE_List self, wxPoint aPosition) -> bool
HitTest(MODULE_List self, EDA_RECT aRect, bool aContained=True, int aAccuracy=0) -> bool
HitTest(MODULE_List self, EDA_RECT aRect, bool aContained=True) -> bool
HitTest(MODULE_List self, EDA_RECT aRect) -> bool

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

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 38153 of file pcbnew.py.

def pcbnew.MODULE_List.IncrementFlag (   self)
IncrementFlag(MODULE_List self)

void
MODULE::IncrementFlag() 

Definition at line 37698 of file pcbnew.py.

def pcbnew.MODULE_List.Insert (   self,
  aNewElement,
  aElementAfterMe 
)
Insert(MODULE_List self, MODULE aNewElement, MODULE aElementAfterMe)

Definition at line 37111 of file pcbnew.py.

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

bool
EDA_ITEM::IsBrightened() const 

Definition at line 39216 of file pcbnew.py.

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

virtual bool
BOARD_ITEM::IsConnected() const

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 38867 of file pcbnew.py.

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

bool
EDA_ITEM::IsDragging() const 

Definition at line 39166 of file pcbnew.py.

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

bool MODULE::IsFlipped()
const

function IsFlipped

true if the module is flipped, i.e. on the back side of the board 

Definition at line 37795 of file pcbnew.py.

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

bool
EDA_ITEM::IsHighlighted() const 

Definition at line 39206 of file pcbnew.py.

def pcbnew.MODULE_List.IsLibNameValid (   self,
  aName 
)
IsLibNameValid(MODULE_List self, wxString aName) -> bool

Definition at line 38723 of file pcbnew.py.

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

bool MODULE::IsLocked()
const override

Function IsLocked.

bool - true if the object is locked, else false 

Definition at line 37809 of file pcbnew.py.

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

bool
EDA_ITEM::IsModified() const 

Definition at line 39146 of file pcbnew.py.

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

bool EDA_ITEM::IsMoving()
const 

Definition at line 39156 of file pcbnew.py.

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

bool EDA_ITEM::IsNew() const

Definition at line 39136 of file pcbnew.py.

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

virtual bool
BOARD_ITEM::IsOnLayer(PCB_LAYER_ID aLayer) const

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 38960 of file pcbnew.py.

def pcbnew.MODULE_List.IsPlaced (   self)
IsPlaced(MODULE_List self) -> bool

bool MODULE::IsPlaced()
const 

Definition at line 37841 of file pcbnew.py.

def pcbnew.MODULE_List.IsReplaceable (   self)
IsReplaceable(MODULE_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 39461 of file pcbnew.py.

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

bool
EDA_ITEM::IsResized() const 

Definition at line 39196 of file pcbnew.py.

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

bool
EDA_ITEM::IsSelected() const 

Definition at line 39186 of file pcbnew.py.

def pcbnew.MODULE_List.IsTrack (   self)
IsTrack(MODULE_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 38982 of file pcbnew.py.

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

bool
EDA_ITEM::IsWireImage() const 

Definition at line 39176 of file pcbnew.py.

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

Definition at line 39397 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.MODULE_List.Matches (   self,
  aSearchData,
  aAuxData,
  aFindLocation 
)
Matches(MODULE_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 39402 of file pcbnew.py.

def pcbnew.MODULE_List.Models (   self,
  args 
)
Models(MODULE_List self) -> std::list< S3D_INFO >
Models(MODULE_List self) -> std::list< S3D_INFO > const &

const std::list<S3D_INFO>&
MODULE::Models() const 

Definition at line 37367 of file pcbnew.py.

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

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

Function Move move this object.

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

aMoveVector:  - the move vector for this object. 

Definition at line 37718 of file pcbnew.py.

def pcbnew.MODULE_List.MoveAnchorPosition (   self,
  aMoveVector 
)
MoveAnchorPosition(MODULE_List self, wxPoint aMoveVector)

void
MODULE::MoveAnchorPosition(const wxPoint &aMoveVector)

Function MoveAnchorPosition Move the reference point of the footprint
It looks like a move footprint: the footprints elements (pads,
outlines, edges .

. ) are moved However: the footprint position is not modified.

the relative (local) coordinates of these items are modified (a move
footprint does not change these local coordinates, but changes the
footprint position) 

Definition at line 37775 of file pcbnew.py.

def pcbnew.MODULE_List.NeedsPlaced (   self)
NeedsPlaced(MODULE_List self) -> bool

bool
MODULE::NeedsPlaced() const 

Definition at line 37861 of file pcbnew.py.

def pcbnew.MODULE_List.Next (   self)
Next(MODULE_List self) -> MODULE

MODULE* MODULE::Next() const 

Definition at line 37203 of file pcbnew.py.

def pcbnew.MODULE_List.PadCoverageRatio (   self)
PadCoverageRatio(MODULE_List self) -> double

double
MODULE::PadCoverageRatio() const

Function PadCoverageRatio Calculates the ratio of total area of the
footprint pads to the area of the footprint.

Used by selection tool heuristics. the ratio 

Definition at line 38763 of file pcbnew.py.

def pcbnew.MODULE_List.Pads (   self)
Pads(MODULE_List self) -> DLIST_ITERATOR_WRAPPER< D_PAD >

DLIST_ITERATOR_WRAPPER<D_PAD>
MODULE::Pads() 

Definition at line 37348 of file pcbnew.py.

def pcbnew.MODULE_List.PadsList (   self,
  args 
)
PadsList(MODULE_List self) -> PAD_List
PadsList(MODULE_List self) -> PAD_List

const DLIST<D_PAD>&
MODULE::PadsList() const 

Definition at line 37326 of file pcbnew.py.

def pcbnew.MODULE_List.PadsLocked (   self)
PadsLocked(MODULE_List self) -> bool

bool MODULE::PadsLocked()
const 

Definition at line 37881 of file pcbnew.py.

def pcbnew.MODULE_List.PopBack (   self)
PopBack(MODULE_List self) -> MODULE

Definition at line 37136 of file pcbnew.py.

def pcbnew.MODULE_List.PopFront (   self)
PopFront(MODULE_List self) -> MODULE

Definition at line 37131 of file pcbnew.py.

def pcbnew.MODULE_List.PushBack (   self,
  aNewElement 
)
PushBack(MODULE_List self, MODULE aNewElement)

Definition at line 37146 of file pcbnew.py.

def pcbnew.MODULE_List.PushFront (   self,
  aNewElement 
)
PushFront(MODULE_List self, MODULE aNewElement)

Definition at line 37141 of file pcbnew.py.

def pcbnew.MODULE_List.Reference (   self,
  args 
)
Reference(MODULE_List self) -> TEXTE_MODULE
Reference(MODULE_List self) -> TEXTE_MODULE

TEXTE_MODULE&
MODULE::Reference() const 

Definition at line 38273 of file pcbnew.py.

def pcbnew.MODULE_List.Remove (   self,
  aElement 
)
Remove(MODULE_List self, MODULE aElement) -> MODULE

Definition at line 37116 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.MODULE_List.RemoveNative (   self,
  aItem 
)
RemoveNative(MODULE_List self, BOARD_ITEM aItem)

void MODULE::Remove(BOARD_ITEM
*aItem) override

>

Removes an item from the container.

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

aItem:  is an item to be removed. 

Definition at line 37244 of file pcbnew.py.

def pcbnew.MODULE_List.Replace (   self,
  args 
)
Replace(MODULE_List self, wxFindReplaceData & aSearchData, wxString aText) -> bool
Replace(MODULE_List self, wxFindReplaceData & aSearchData, void * aAuxData=None) -> bool
Replace(MODULE_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 39433 of file pcbnew.py.

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

void MODULE::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 37735 of file pcbnew.py.

def pcbnew.MODULE_List.RunOnChildren (   self,
  aFunction 
)
RunOnChildren(MODULE_List self, std::function< void (BOARD_ITEM *) > aFunction)

void
MODULE::RunOnChildren(std::function< void(BOARD_ITEM *)> aFunction)

Function RunOnChildren.

Invokes a function on all BOARD_ITEMs that belong to the module (pads,
drawings, texts).

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

aFunction:  is the function to be invoked. 

Definition at line 38618 of file pcbnew.py.

def pcbnew.MODULE_List.SetAttributes (   self,
  aAttributes 
)
SetAttributes(MODULE_List self, int aAttributes)

void
MODULE::SetAttributes(int aAttributes) 

Definition at line 37678 of file pcbnew.py.

def pcbnew.MODULE_List.SetBrightened (   self)
SetBrightened(MODULE_List self)

void
EDA_ITEM::SetBrightened() 

Definition at line 39256 of file pcbnew.py.

def pcbnew.MODULE_List.SetDescription (   self,
  aDoc 
)
SetDescription(MODULE_List self, wxString aDoc)

void
MODULE::SetDescription(const wxString &aDoc) 

Definition at line 37478 of file pcbnew.py.

def pcbnew.MODULE_List.SetFlag (   self,
  aFlag 
)
SetFlag(MODULE_List self, int aFlag)

void MODULE::SetFlag(int
aFlag) 

Definition at line 37688 of file pcbnew.py.

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

void
EDA_ITEM::SetFlags(STATUS_FLAGS aMask) 

Definition at line 39346 of file pcbnew.py.

def pcbnew.MODULE_List.SetForceVisible (   self,
  aEnable 
)
SetForceVisible(MODULE_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 39377 of file pcbnew.py.

def pcbnew.MODULE_List.SetFPID (   self,
  aFPID 
)
SetFPID(MODULE_List self, LIB_ID aFPID)

void MODULE::SetFPID(const
LIB_ID &aFPID) 

Definition at line 37458 of file pcbnew.py.

def pcbnew.MODULE_List.SetHighlighted (   self)
SetHighlighted(MODULE_List self)

void
EDA_ITEM::SetHighlighted() 

Definition at line 39246 of file pcbnew.py.

def pcbnew.MODULE_List.SetInitialComments (   self,
  aInitialComments 
)
SetInitialComments(MODULE_List self, wxArrayString * aInitialComments)

void
MODULE::SetInitialComments(wxArrayString *aInitialComments)

Function SetInitialComments takes ownership of caller's heap allocated
aInitialComments block.

The comments are single line strings already containing the
s-expression comments with optional leading whitespace and then a '#'
character followed by optional single line text (text with no line
endings, not even one). This block of single line comments will be
output upfront of any generated s-expression text in the
PCBIO::Format() function.

Note that a block of single line comments constitutes a multiline
block of single line comments. That is, the block is made of
consecutive single line comments.

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

aInitialComments:  is a heap allocated wxArrayString or NULL, which
the caller gives up ownership of over to this MODULE. 

Definition at line 38733 of file pcbnew.py.

def pcbnew.MODULE_List.SetIsPlaced (   self,
  isPlaced 
)
SetIsPlaced(MODULE_List self, bool isPlaced)

void
MODULE::SetIsPlaced(bool isPlaced) 

Definition at line 37851 of file pcbnew.py.

def pcbnew.MODULE_List.SetKeywords (   self,
  aKeywords 
)
SetKeywords(MODULE_List self, wxString aKeywords)

void
MODULE::SetKeywords(const wxString &aKeywords) 

Definition at line 37498 of file pcbnew.py.

def pcbnew.MODULE_List.SetLastEditTime (   self,
  args 
)
SetLastEditTime(MODULE_List self, time_t aTime)
SetLastEditTime(MODULE_List self)

void
MODULE::SetLastEditTime() 

Definition at line 37901 of file pcbnew.py.

def pcbnew.MODULE_List.SetLayer (   self,
  aLayer 
)
SetLayer(MODULE_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 38920 of file pcbnew.py.

def pcbnew.MODULE_List.SetLink (   self,
  aLink 
)
SetLink(MODULE_List self, time_t aLink)

void MODULE::SetLink(time_t
aLink) 

Definition at line 38428 of file pcbnew.py.

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

void
EDA_ITEM::SetList(DHEAD *aList) 

Definition at line 39126 of file pcbnew.py.

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

void
MODULE::SetLocalClearance(int aClearance) 

Definition at line 37558 of file pcbnew.py.

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

void
MODULE::SetLocalSolderMaskMargin(int aMargin) 

Definition at line 37538 of file pcbnew.py.

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

void
MODULE::SetLocalSolderPasteMargin(int aMargin) 

Definition at line 37578 of file pcbnew.py.

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

void
MODULE::SetLocalSolderPasteMarginRatio(double aRatio) 

Definition at line 37598 of file pcbnew.py.

def pcbnew.MODULE_List.SetLocked (   self,
  isLocked 
)
SetLocked(MODULE_List self, bool isLocked)

void MODULE::SetLocked(bool
isLocked) override

Function SetLocked sets the MODULE_is_LOCKED bit in the
m_ModuleStatus.

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

isLocked:  When true means turn on locked status, else unlock 

Definition at line 37823 of file pcbnew.py.

def pcbnew.MODULE_List.SetModified (   self)
SetModified(MODULE_List self)

void
EDA_ITEM::SetModified() 

Definition at line 39296 of file pcbnew.py.

def pcbnew.MODULE_List.SetNeedsPlaced (   self,
  needsPlaced 
)
SetNeedsPlaced(MODULE_List self, bool needsPlaced)

void
MODULE::SetNeedsPlaced(bool needsPlaced) 

Definition at line 37871 of file pcbnew.py.

def pcbnew.MODULE_List.SetOrientation (   self,
  newangle 
)
SetOrientation(MODULE_List self, double newangle)

void
MODULE::SetOrientation(double newangle) 

Definition at line 37398 of file pcbnew.py.

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

void
MODULE::SetOrientationDegrees(double aOrientation) 

Definition at line 37408 of file pcbnew.py.

def pcbnew.MODULE_List.SetPadsLocked (   self,
  aPadsLocked 
)
SetPadsLocked(MODULE_List self, bool aPadsLocked)

void
MODULE::SetPadsLocked(bool aPadsLocked) 

Definition at line 37891 of file pcbnew.py.

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

void
EDA_ITEM::SetParent(EDA_ITEM *aParent) 

Definition at line 39116 of file pcbnew.py.

def pcbnew.MODULE_List.SetPath (   self,
  aPath 
)
SetPath(MODULE_List self, wxString aPath)

void MODULE::SetPath(const
wxString &aPath) 

Definition at line 37518 of file pcbnew.py.

def pcbnew.MODULE_List.SetPlacementCost180 (   self,
  aCost 
)
SetPlacementCost180(MODULE_List self, int aCost)

void
MODULE::SetPlacementCost180(int aCost) 

Definition at line 38448 of file pcbnew.py.

def pcbnew.MODULE_List.SetPlacementCost90 (   self,
  aCost 
)
SetPlacementCost90(MODULE_List self, int aCost)

void
MODULE::SetPlacementCost90(int aCost) 

Definition at line 38468 of file pcbnew.py.

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

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

Definition at line 37378 of file pcbnew.py.

def pcbnew.MODULE_List.SetReference (   self,
  aReference 
)
SetReference(MODULE_List self, wxString aReference)

void
MODULE::SetReference(const wxString &aReference)

Function SetReference.

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

aReference:  A reference to a wxString object containing the reference
designator text. 

Definition at line 38195 of file pcbnew.py.

def pcbnew.MODULE_List.SetSelected (   self)
SetSelected(MODULE_List self)

void
EDA_ITEM::SetSelected() 

Definition at line 39236 of file pcbnew.py.

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

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

Definition at line 39316 of file pcbnew.py.

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

void
EDA_ITEM::SetStatus(STATUS_FLAGS aStatus) 

Definition at line 39336 of file pcbnew.py.

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

void
MODULE::SetThermalGap(int aGap) 

Definition at line 37648 of file pcbnew.py.

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

void
MODULE::SetThermalWidth(int aWidth) 

Definition at line 37628 of file pcbnew.py.

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

void
EDA_ITEM::SetTimeStamp(time_t aNewTimeStamp) 

Definition at line 39086 of file pcbnew.py.

def pcbnew.MODULE_List.SetValue (   self,
  aValue 
)
SetValue(MODULE_List self, wxString aValue)

void MODULE::SetValue(const
wxString &aValue)

Function SetValue.

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

aValue:  A reference to a wxString object containing the value text.

Definition at line 38242 of file pcbnew.py.

def pcbnew.MODULE_List.SetWireImage (   self)
SetWireImage(MODULE_List self)

void
EDA_ITEM::SetWireImage() 

Definition at line 39226 of file pcbnew.py.

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

void
MODULE::SetZoneConnection(ZoneConnection aType) 

Definition at line 37608 of file pcbnew.py.

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

Definition at line 39024 of file pcbnew.py.

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

Definition at line 39484 of file pcbnew.py.

def pcbnew.MODULE_List.StringLibNameInvalidChars (   self,
  aUserReadable 
)
StringLibNameInvalidChars(MODULE_List self, bool aUserReadable) -> wxChar const *

Definition at line 38728 of file pcbnew.py.

def pcbnew.MODULE_List.SwapData (   self,
  aImage 
)
SwapData(MODULE_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 38938 of file pcbnew.py.

def pcbnew.MODULE_List.TransformGraphicShapesWithClearanceToPolygonSet (   self,
  aLayer,
  aCornerBuffer,
  aInflateValue,
  aCircleToSegmentsCount,
  aCorrectionFactor,
  aCircleToSegmentsCountForTexts = 0 
)
TransformGraphicShapesWithClearanceToPolygonSet(MODULE_List self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor, int aCircleToSegmentsCountForTexts=0)
TransformGraphicShapesWithClearanceToPolygonSet(MODULE_List self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor)

void
MODULE::TransformGraphicShapesWithClearanceToPolygonSet(PCB_LAYER_ID
aLayer, SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int
aCircleToSegmentsCount, double aCorrectionFactor, int
aCircleToSegmentsCountForTexts=0) const

function TransformGraphicShapesWithClearanceToPolygonSet generate
shapes of graphic items (outlines) on layer aLayer as polygons, and
adds these polygons to aCornerBuffer Useful to generate a polygonal
representation of a footprint in 3D view and plot functions, when a
full polygonal approach is needed

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

aLayer:  = the current layer: items on this layer are considered

aCornerBuffer:  = the buffer to store polygons

aInflateValue:  = a value to inflate shapes aInflateValue = 0 to have
the exact shape size

aCircleToSegmentsCount:  = number of segments to generate a circle

aCorrectionFactor:  = the correction to apply to a circle radius to
approximate a circle by the polygon. if aCorrectionFactor = 1.0, the
polygon is inside the circle the radius of circle approximated by
segments is initial radius * aCorrectionFactor

aCircleToSegmentsCountForTexts:  = number of segments to generate a
circle when building the texts polygonal shapes of the stroke font if
0, use the aCircleToSegmentsCount value 

Definition at line 38017 of file pcbnew.py.

def pcbnew.MODULE_List.TransformGraphicTextWithClearanceToPolygonSet (   self,
  aLayer,
  aCornerBuffer,
  aInflateValue,
  aCircleToSegmentsCount,
  aCorrectionFactor,
  aCircleToSegmentsCountForTexts = 0 
)
TransformGraphicTextWithClearanceToPolygonSet(MODULE_List self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor, int aCircleToSegmentsCountForTexts=0)
TransformGraphicTextWithClearanceToPolygonSet(MODULE_List self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor)

void
MODULE::TransformGraphicTextWithClearanceToPolygonSet(PCB_LAYER_ID
aLayer, SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int
aCircleToSegmentsCount, double aCorrectionFactor, int
aCircleToSegmentsCountForTexts=0) const

TransformGraphicTextWithClearanceToPolygonSet This function is the
same as TransformGraphicShapesWithClearanceToPolygonSet but only
generate text.

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

aLayer:

aCornerBuffer:

aInflateValue:

aCircleToSegmentsCount:

aCorrectionFactor:

aCircleToSegmentsCountForTexts:  

Definition at line 38058 of file pcbnew.py.

def pcbnew.MODULE_List.TransformPadsShapesWithClearanceToPolygon (   self,
  aLayer,
  aCornerBuffer,
  aInflateValue,
  aCircleToSegmentsCount,
  aCorrectionFactor,
  aSkipNPTHPadsWihNoCopper = False 
)
TransformPadsShapesWithClearanceToPolygon(MODULE_List self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor, bool aSkipNPTHPadsWihNoCopper=False)
TransformPadsShapesWithClearanceToPolygon(MODULE_List self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor)

void
MODULE::TransformPadsShapesWithClearanceToPolygon(PCB_LAYER_ID aLayer,
SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int
aCircleToSegmentsCount, double aCorrectionFactor, bool
aSkipNPTHPadsWihNoCopper=false) const

function TransformPadsShapesWithClearanceToPolygon generate pads
shapes on layer aLayer as polygons, and adds these polygons to
aCornerBuffer Useful to generate a polygonal representation of a
footprint in 3D view and plot functions, when a full polygonal
approach is needed

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

aLayer:  = the current layer: pads on this layer are considered

aCornerBuffer:  = the buffer to store polygons

aInflateValue:  = an additionnal size to add to pad shapes
aInflateValue = 0 to have the exact pad size

aCircleToSegmentsCount:  = number of segments to generate a circle

aCorrectionFactor:  = the correction to apply to a circle radius to
approximate a circle by the polygon. if aCorrectionFactor = 1.0, the
polygon is inside the circle the radius of circle approximated by
segments is initial radius * aCorrectionFactor

aSkipNPTHPadsWihNoCopper:  = if true, do not add a NPTH pad shape, if
the shape has same size and position as the hole. Usually, these pads
are not drawn on copper layers, because there is actually no copper
Due to diff between layers and holes, these pads must be skipped to be
sure there is no copper left on the board (for instance when creating
Gerber Files or 3D shapes) default = false 

Definition at line 37973 of file pcbnew.py.

def pcbnew.MODULE_List.Type (   self)
Type(MODULE_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 39071 of file pcbnew.py.

def pcbnew.MODULE_List.UnLink (   self)
UnLink(MODULE_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 38997 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.MODULE_List.Value (   self,
  args 
)
Value(MODULE_List self) -> TEXTE_MODULE
Value(MODULE_List self) -> TEXTE_MODULE

TEXTE_MODULE& MODULE::Value()
const

The const versions to keep the compiler happy. 

Definition at line 38260 of file pcbnew.py.

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

const BOX2I
MODULE::ViewBBox() const override

Function ViewBBox() returns the bounding box of the item covering all
its layers.

BOX2I - the current bounding box 

Definition at line 38678 of file pcbnew.py.

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

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

Function ViewGetLayers() Returns the all the layers within the VIEW
the object is painted on.

For instance, a D_PAD spans zero or more copper layers and a few
technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called
for each of the layers returned by ViewGetLayers(), depending on the
rendering order.

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

aLayers[]:  output layer index array

aCount:  number of layer indices in aLayers[] 

Definition at line 38638 of file pcbnew.py.

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

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

Function ViewGetLOD() Returns the level of detail of the item.

A level of detail is the minimal VIEW scale that is sufficient for an
item to be shown on a given layer. 

Definition at line 38663 of file pcbnew.py.

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

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

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 38513 of file pcbnew.py.

Member Data Documentation

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

Definition at line 37170 of file pcbnew.py.

pcbnew.MODULE_List.ret = self.last
static

Definition at line 37172 of file pcbnew.py.

pcbnew.MODULE_List.this

Definition at line 37194 of file pcbnew.py.


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