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

Public Member Functions

def ClassOf (aItem)
 
def SetFileName (self, aFileName)
 
def GetFileName (self)
 
def __init__ (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def IsEmpty (self)
 
def Move (self, aMoveVector)
 
def SetFileFormatVersionAtLoad (self, aVersion)
 
def GetFileFormatVersionAtLoad (self)
 
def AddNative
 
def RemoveNative (self, aBoardItem)
 
def Duplicate
 
def GetRatsnest (self)
 
def DeleteMARKERs (self)
 
def DeleteZONEOutlines (self)
 
def GetMARKER (self, index)
 
def GetMARKERCount (self)
 
def SetAuxOrigin (self, aPoint)
 
def GetAuxOrigin (self)
 
def SetGridOrigin (self, aPoint)
 
def GetGridOrigin (self)
 
def ResetHighLight (self)
 
def GetHighLightNetCode (self)
 
def SetHighLightNet (self, aNetCode)
 
def IsHighLightNetON (self)
 
def HighLightOFF (self)
 
def HighLightON (self)
 
def PushHighLight (self)
 
def PopHighLight (self)
 
def GetCopperLayerCount (self)
 
def SetCopperLayerCount (self, aCount)
 
def GetEnabledLayers (self)
 
def SetEnabledLayers (self, aLayerMask)
 
def IsLayerEnabled (self, aLayer)
 
def IsLayerVisible (self, aLayer)
 
def GetVisibleLayers (self)
 
def SetVisibleLayers (self, aLayerMask)
 
def GetVisibleElements (self)
 
def SetVisibleElements (self, aMask)
 
def SetVisibleAlls (self)
 
def IsElementVisible (self, LAYER_aPCB)
 
def SetElementVisibility (self, LAYER_aPCB, aNewState)
 
def IsModuleLayerVisible (self, layer)
 
def GetVisibleElementColor (self, LAYER_aPCB)
 
def SetVisibleElementColor (self, LAYER_aPCB, aColor)
 
def GetDesignSettings (self)
 
def SetDesignSettings (self, aDesignSettings)
 
def GetPageSettings (self)
 
def SetPageSettings (self, aPageSettings)
 
def GetPlotOptions (self)
 
def SetPlotOptions (self, aOptions)
 
def GetTitleBlock (self)
 
def SetTitleBlock (self, aTitleBlock)
 
def GetZoneSettings (self)
 
def SetZoneSettings (self, aSettings)
 
def GetColorsSettings (self)
 
def SetColorsSettings (self, aColorsSettings)
 
def GetBoardPolygonOutlines
 
def ConvertBrdLayerToPolygonalContours (self, aLayer, aOutlines)
 
def GetLayerID (self, aLayerName)
 
def GetLayerName (self, aLayer)
 
def SetLayerName (self, aLayer, aLayerName)
 
def GetStandardLayerName (aLayerId)
 
def SetLayerDescr (self, aIndex, aLayer)
 
def GetLayerType (self, aLayer)
 
def SetLayerType (self, aLayer, aLayerType)
 
def SetLayerColor (self, aLayer, aColor)
 
def GetLayerColor (self, aLayer)
 
def GetNumSegmTrack (self)
 
def GetNumSegmZone (self)
 
def GetRatsnestsCount (self)
 
def GetNodesCount (self)
 
def SetNodeCount (self, aCount)
 
def GetUnconnectedNetCount (self)
 
def SetUnconnectedNetCount (self, aCount)
 
def GetPadCount (self)
 
def GetPads (self)
 
def BuildListOfNets (self)
 
def FindNet (self, args)
 
def GetNetInfo (self)
 
def GetNetCount (self)
 
def ComputeBoundingBox
 
def GetBoundingBox (self)
 
def GetBoardEdgesBoundingBox (self)
 
def GetMsgPanelInfo (self, aList)
 
def Draw (self, args)
 
def DrawHighLight (self, aDrawPanel, aDC, aNetCode)
 
def Visit (self, inspector, testData, scanTypes)
 
def FindModuleByReference (self, aReference)
 
def FindModule
 
def ReplaceNetlist
 
def SortedNetnamesList (self, aNames, aSortbyPadsCount)
 
def SynchronizeNetsAndNetClasses (self)
 
def GetClass (self)
 
def HitTestForAnyFilledArea (self, aRefPos, aStartLayer, aEndLayer, aNetCode)
 
def RedrawAreasOutlines (self, aPanel, aDC, aDrawMode, aLayer)
 
def RedrawFilledAreas (self, aPanel, aDC, aDrawMode, aLayer)
 
def SetAreasNetCodesFromNetNames (self)
 
def GetArea (self, index)
 
def GetAreaIndex (self, aArea)
 
def GetAreaCount (self)
 
def AddArea (self, aNewZonesList, aNetcode, aLayer, aStartPointPosition, aHatch)
 
def InsertArea (self, netcode, iarea, layer, x, y, hatch)
 
def NormalizeAreaPolygon (self, aNewZonesList, aCurrArea)
 
def OnAreaPolygonModified (self, aModifiedZonesList, modified_area)
 
def CombineAllAreasInNet (self, aDeletedList, aNetCode, aUseLocalFlags)
 
def RemoveArea (self, aDeletedList, area_to_remove)
 
def TestAreaIntersections (self, area_to_test)
 
def TestAreaIntersection (self, area_ref, area_to_test)
 
def CombineAreas (self, aDeletedList, area_ref, area_to_combine)
 
def Test_Drc_Areas_Outlines_To_Areas_Outlines (self, aArea_To_Examine, aCreate_Markers)
 
def Test_Connections_To_Copper_Areas
 
def GetViaByPosition (self, args)
 
def GetPadFast (self, aPosition, aLayerMask)
 
def GetPad (self, args)
 
def PadDelete (self, aPad)
 
def GetSortedPadListByXthenYCoord
 
def GetVisibleTrack (self, aStartingTrace, aPosition, aLayerSet)
 
def MarkTrace (self, aTrace, aCount, aTraceLength, aInPackageLength, aReorder)
 
def TracksInNet (self, aNetCode)
 
def TracksInNetBetweenPoints (self, aStartPos, aGoalPos, aNetCode)
 
def GetFootprint
 
def GetLockPoint (self, aPosition, aLayerMask)
 
def CreateLockPoint (self, aPosition, aSegment, aList)
 
def GetModules (self)
 
def GetDrawings (self)
 
def GetTracks (self)
 
def GetFullRatsnest (self)
 
def Save (self, filename)
 
def GetNetClasses (self)
 
def GetCurrentNetClassName (self)
 
def GetViasDimensionsList (self)
 
def GetTrackWidthList (self)
 
def GetNetsByName (self)
 
def GetNetsByNetcode (self)
 
def GetNetcodeFromNetname (self, netname)
 
def GetAllNetClasses (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
def __init__ (self, args, kwargs)
 
def AddNative
 
def RemoveNative (self, aItem)
 
def DeleteNative (self, aItem)
 
def Add (self, item)
 
def Remove (self, item)
 
def Delete (self, item)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, args, kwargs)
 
def GetPosition (self)
 
def GetCenter (self)
 
def SetPosition (self, aPos)
 
def IsConnected (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def Draw (self, args)
 
def SwapData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (aShape)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
def Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
def __init__ (self, args, kwargs)
 
def Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (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 GetMsgPanelInfo (self, aList)
 
def HitTest (self, aPosition)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (aLeft, aRight)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Public Attributes

 this
 

Static Public Attributes

tuple ClassOf = staticmethod(ClassOf)
 
tuple m_Status_Pcb = _swig_property(_pcbnew.BOARD_m_Status_Pcb_get, _pcbnew.BOARD_m_Status_Pcb_set)
 
tuple m_Drawings = _swig_property(_pcbnew.BOARD_m_Drawings_get, _pcbnew.BOARD_m_Drawings_set)
 
tuple m_Modules = _swig_property(_pcbnew.BOARD_m_Modules_get, _pcbnew.BOARD_m_Modules_set)
 
tuple m_Track = _swig_property(_pcbnew.BOARD_m_Track_get, _pcbnew.BOARD_m_Track_set)
 
tuple m_Zone = _swig_property(_pcbnew.BOARD_m_Zone_get, _pcbnew.BOARD_m_Zone_set)
 
tuple m_FullRatsnest = _swig_property(_pcbnew.BOARD_m_FullRatsnest_get, _pcbnew.BOARD_m_FullRatsnest_set)
 
tuple m_LocalRatsnest = _swig_property(_pcbnew.BOARD_m_LocalRatsnest_get, _pcbnew.BOARD_m_LocalRatsnest_set)
 
tuple m_CurrentZoneContour = _swig_property(_pcbnew.BOARD_m_CurrentZoneContour_get, _pcbnew.BOARD_m_CurrentZoneContour_set)
 
tuple GetStandardLayerName = staticmethod(GetStandardLayerName)
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
tuple ShowShape = staticmethod(ShowShape)
 
tuple FormatAngle = staticmethod(FormatAngle)
 
tuple FormatInternalUnits = staticmethod(FormatInternalUnits)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
tuple IterateForward = staticmethod(IterateForward)
 
tuple Sort = staticmethod(Sort)
 

Detailed Description

Class BOARD holds information pertinent to a Pcbnew printed circuit
board.

C++ includes: class_board.h 

Definition at line 33263 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.BOARD.__init__ (   self)
__init__(BOARD self) -> BOARD

BOARD::BOARD() 

Definition at line 33342 of file pcbnew.py.

Member Function Documentation

def pcbnew.BOARD.AddArea (   self,
  aNewZonesList,
  aNetcode,
  aLayer,
  aStartPointPosition,
  aHatch 
)
AddArea(BOARD self, PICKED_ITEMS_LIST * aNewZonesList, int aNetcode, PCB_LAYER_ID aLayer, wxPoint aStartPointPosition, int aHatch) -> ZONE_CONTAINER

ZONE_CONTAINER *
BOARD::AddArea(PICKED_ITEMS_LIST *aNewZonesList, int aNetcode,
PCB_LAYER_ID aLayer, wxPoint aStartPointPosition, int aHatch)

Function AddArea Add an empty copper area to board areas list.

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

aNewZonesList:  = a PICKED_ITEMS_LIST * where to store new areas
pickers (useful in undo commands) can be NULL

aNetcode:  = the netcode of the copper area (0 = no net)

aLayer:  = the layer of area

aStartPointPosition:  = position of the first point of the polygon
outline of this area

aHatch:  = hatch option

a reference to the new area 

Definition at line 34973 of file pcbnew.py.

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

void BOARD::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 33422 of file pcbnew.py.

def pcbnew.BOARD.BuildListOfNets (   self)
BuildListOfNets(BOARD self)

void
BOARD::BuildListOfNets() 

Definition at line 34467 of file pcbnew.py.

def pcbnew.BOARD.ClassOf (   aItem)
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 33282 of file pcbnew.py.

def pcbnew.BOARD.CombineAllAreasInNet (   self,
  aDeletedList,
  aNetCode,
  aUseLocalFlags 
)
CombineAllAreasInNet(BOARD self, PICKED_ITEMS_LIST * aDeletedList, int aNetCode, bool aUseLocalFlags) -> bool

bool
BOARD::CombineAllAreasInNet(PICKED_ITEMS_LIST *aDeletedList, int
aNetCode, bool aUseLocalFlags)

Function CombineAllAreasInNet Checks all copper areas in net for
intersections, combining them if found.

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

aDeletedList:  = a PICKED_ITEMS_LIST * where to store deleted areas
(useful in undo commands can be NULL

aNetCode:  = net to consider

aUseLocalFlags:  : if true, don't check areas if both local flags are
0 Sets local flag = 1 for any areas modified

true if some areas modified 

Definition at line 35074 of file pcbnew.py.

def pcbnew.BOARD.CombineAreas (   self,
  aDeletedList,
  area_ref,
  area_to_combine 
)
CombineAreas(BOARD self, PICKED_ITEMS_LIST * aDeletedList, ZONE_CONTAINER area_ref, ZONE_CONTAINER area_to_combine) -> bool

bool
BOARD::CombineAreas(PICKED_ITEMS_LIST *aDeletedList, ZONE_CONTAINER
*area_ref, ZONE_CONTAINER *area_to_combine)

Function CombineAreas If possible, combine 2 copper areas.

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

aDeletedList:  = a PICKED_ITEMS_LIST * where to store deleted areas
(useful for undo).

area_ref:  = the main area (zone)

area_to_combine:  = the zone that can be merged with area_ref area_ref
must be BEFORE area_to_combine area_to_combine will be deleted, if
areas are combined

: true if area_to_combine is combined with area_ref (and therefore be
deleted) 

Definition at line 35164 of file pcbnew.py.

def pcbnew.BOARD.ComputeBoundingBox (   self,
  aBoardEdgesOnly = False 
)
ComputeBoundingBox(BOARD self, bool aBoardEdgesOnly=False) -> EDA_RECT
ComputeBoundingBox(BOARD self) -> EDA_RECT

EDA_RECT
BOARD::ComputeBoundingBox(bool aBoardEdgesOnly=false) const

Function ComputeBoundingBox calculates the bounding box containing all
board items (or board edge segments).

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

aBoardEdgesOnly:  is true if we are interested in board edge segments
only.

EDA_RECT - the board's bounding box 

Definition at line 34521 of file pcbnew.py.

def pcbnew.BOARD.ConvertBrdLayerToPolygonalContours (   self,
  aLayer,
  aOutlines 
)
ConvertBrdLayerToPolygonalContours(BOARD self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aOutlines)

void BOARD::ConvertBrdLayerToPolygonalContours(PCB_LAYER_ID aLayer,
SHAPE_POLY_SET &aOutlines)

Function ConvertBrdLayerToPolygonalContours Build a set of polygons
which are the outlines of copper items (pads, tracks, vias, texts,
zones) Holes in vias or pads are ignored Usefull to export the shape
of copper layers to dxf polygons or 3D viewer the polygons are not
merged.

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

aLayer:  = A copper layer, like B_Cu, etc.

aOutlines:  The SHAPE_POLY_SET to fill in with items outline. 

Definition at line 34154 of file pcbnew.py.

def pcbnew.BOARD.CreateLockPoint (   self,
  aPosition,
  aSegment,
  aList 
)
CreateLockPoint(BOARD self, wxPoint aPosition, TRACK aSegment, PICKED_ITEMS_LIST * aList) -> TRACK

TRACK *
BOARD::CreateLockPoint(wxPoint &aPosition, TRACK *aSegment,
PICKED_ITEMS_LIST *aList)

Function CreateLockPoint creates an intermediate point on aSegment and
break it into two segments at aPosition.

The new segment starts from aPosition and ends at the end point of
aSegment. The original segment now ends at aPosition.

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

aPosition:  A wxPoint object containing the position to test and the
new segment start position if the return value is not NULL.

aSegment:  The trace segment to create the lock point on.

aList:  The pick list to add the created items to.

NULL if no new point was created or a pointer to a TRACK object of the
created segment. If aSegment points to a via the exact value of
aPosition and a pointer to the via are returned. 

Definition at line 35566 of file pcbnew.py.

def pcbnew.BOARD.DeleteMARKERs (   self)
DeleteMARKERs(BOARD self)

void
BOARD::DeleteMARKERs()

Function DeleteMARKERs deletes ALL MARKERS from the board. 

Definition at line 33491 of file pcbnew.py.

def pcbnew.BOARD.DeleteZONEOutlines (   self)
DeleteZONEOutlines(BOARD self)

void
BOARD::DeleteZONEOutlines()

Function DeleteZONEOutlines deletes ALL zone outlines from the board.

Definition at line 33503 of file pcbnew.py.

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

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

Function Draw.

Redraw the BOARD items but not cursors, axis or grid.

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

aPanel:  = the panel relative to the board

aDC:  = the current device context

aDrawMode:  = GR_COPY, GR_OR ... (not always used)

aOffset:  = an draw offset value (default = 0,0) 

Definition at line 34600 of file pcbnew.py.

def pcbnew.BOARD.DrawHighLight (   self,
  aDrawPanel,
  aDC,
  aNetCode 
)
DrawHighLight(BOARD self, EDA_DRAW_PANEL * aDrawPanel, wxDC * aDC, int aNetCode)

void
BOARD::DrawHighLight(EDA_DRAW_PANEL *aDrawPanel, wxDC *aDC, int
aNetCode)

Function DrawHighLight redraws the objects in the board that are
associated with the given aNetCode and turns on or off the brilliance
associated with that net according to the current value of global
g_HighLight_Status.

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

aDrawPanel:  is needed for the clipping support.

aDC:  = the current device context

aNetCode:  is the net number to highlight or to dim. 

Definition at line 34627 of file pcbnew.py.

def pcbnew.BOARD.Duplicate (   self,
  aItem,
  aAddToBoard = False 
)
Duplicate(BOARD self, BOARD_ITEM aItem, bool aAddToBoard=False) -> BOARD_ITEM
Duplicate(BOARD self, BOARD_ITEM aItem) -> BOARD_ITEM

BOARD_ITEM *
BOARD::Duplicate(const BOARD_ITEM *aItem, bool aAddToBoard=false) 

Definition at line 33464 of file pcbnew.py.

def pcbnew.BOARD.FindModule (   self,
  aRefOrTimeStamp,
  aSearchByTimeStamp = False 
)
FindModule(BOARD self, wxString aRefOrTimeStamp, bool aSearchByTimeStamp=False) -> MODULE
FindModule(BOARD self, wxString aRefOrTimeStamp) -> MODULE

MODULE *
BOARD::FindModule(const wxString &aRefOrTimeStamp, bool
aSearchByTimeStamp=false) const

Function FindModule searches for a module matching aRefOrTimeStamp
depending on the state of aSearchByTimeStamp.

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

aRefOrTimeStamp:  is the search string.

aSearchByTimeStamp:  searches by the module time stamp value if true.
Otherwise search by reference designator.

MODULE* - If found, the module meeting the search criteria, else NULL.

Definition at line 34706 of file pcbnew.py.

def pcbnew.BOARD.FindModuleByReference (   self,
  aReference 
)
FindModuleByReference(BOARD self, wxString aReference) -> MODULE

MODULE *
BOARD::FindModuleByReference(const wxString &aReference) const

Function FindModuleByReference searches for a MODULE within this board
with the given reference designator.

Finds only the first one, if there is more than one such MODULE.

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

aReference:  The reference designator of the MODULE to find.

MODULE* - If found, the MODULE having the given reference designator,
else NULL. 

Definition at line 34683 of file pcbnew.py.

def pcbnew.BOARD.FindNet (   self,
  args 
)
FindNet(BOARD self, int aNetcode) -> NETINFO_ITEM
FindNet(BOARD self, wxString aNetname) -> NETINFO_ITEM

NETINFO_ITEM *
BOARD::FindNet(const wxString &aNetname) const

Function FindNet overloaded searches for a net with the given name.

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

aNetname:  A Netname to search for.

NETINFO_ITEM* - the net or NULL if not found. 

Definition at line 34477 of file pcbnew.py.

def pcbnew.BOARD.GetAllNetClasses (   self)
Return a dictionary like object with net_class_name as key and NETCLASSPTR as value
GetNetClasses(BOARD self) -> { wxString net_class_name : NETCLASSPTR }
Include the "Default" netclass also.

Definition at line 35637 of file pcbnew.py.

def pcbnew.BOARD.GetArea (   self,
  index 
)
GetArea(BOARD self, int index) -> ZONE_CONTAINER

ZONE_CONTAINER*
BOARD::GetArea(int index) const

Function GetArea returns the Area (Zone Container) at a given index.

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

index:  The array type index into a collection of ZONE_CONTAINER *.

ZONE_CONTAINER* - a pointer to the Area or NULL if index out of range.

Definition at line 34919 of file pcbnew.py.

def pcbnew.BOARD.GetAreaCount (   self)
GetAreaCount(BOARD self) -> int

int BOARD::GetAreaCount()
const

Function GetAreaCount.

int - The number of Areas or ZONE_CONTAINER. 

Definition at line 34959 of file pcbnew.py.

def pcbnew.BOARD.GetAreaIndex (   self,
  aArea 
)
GetAreaIndex(BOARD self, ZONE_CONTAINER aArea) -> int

int
BOARD::GetAreaIndex(const ZONE_CONTAINER *aArea) const

Function GetAreaIndex returns the Area Index for the given Zone
Container.

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

aArea:  :The ZONE_CONTAINER to find.

an Area Index in m_ZoneDescriptorList or -1 if non found. 

Definition at line 34939 of file pcbnew.py.

def pcbnew.BOARD.GetAuxOrigin (   self)
GetAuxOrigin(BOARD self) -> wxPoint

const wxPoint&
BOARD::GetAuxOrigin() const 

Definition at line 33562 of file pcbnew.py.

def pcbnew.BOARD.GetBoardEdgesBoundingBox (   self)
GetBoardEdgesBoundingBox(BOARD self) -> EDA_RECT

const
EDA_RECT BOARD::GetBoardEdgesBoundingBox() const

Function GetBoardEdgesBoundingBox Returns the board bounding box
calculated using exclusively the board edges (graphics on Edge.Cuts
layer).

If there are items outside of the area limited by Edge.Cuts graphics,
the items will not be taken into account. bounding box calculated
using exclusively the board edges. 

Definition at line 34561 of file pcbnew.py.

def pcbnew.BOARD.GetBoardPolygonOutlines (   self,
  aOutlines,
  aErrorText = None 
)
GetBoardPolygonOutlines(BOARD self, SHAPE_POLY_SET aOutlines, wxString aErrorText=None) -> bool
GetBoardPolygonOutlines(BOARD self, SHAPE_POLY_SET aOutlines) -> bool

bool
BOARD::GetBoardPolygonOutlines(SHAPE_POLY_SET &aOutlines, wxString
*aErrorText=NULL)

Function GetBoardPolygonOutlines Extracts the board outlines and build
a closed polygon from lines, arcs and circle items on edge cut layer
Any closed outline inside the main outline is a hole All contours
should be closed, i.e.

have valid vertices to build a closed polygon

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

aOutlines:  The SHAPE_POLY_SET to fill in with outlines/holes.

aErrorText:  = a wxString reference to display an error message with
the coordinate of the point which creates the error (default = NULL ,
no message returned on error)

true if success, false if a contour is not valid 

Definition at line 34124 of file pcbnew.py.

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

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

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

wxString BOARD::GetClass()
const override

Function GetClass returns the class name.

wxString 

Definition at line 34826 of file pcbnew.py.

def pcbnew.BOARD.GetColorsSettings (   self)
GetColorsSettings(BOARD self) -> COLORS_DESIGN_SETTINGS

COLORS_DESIGN_SETTINGS* BOARD::GetColorsSettings() const

Function GetColorSettings.

the current COLORS_DESIGN_SETTINGS in use 

Definition at line 34094 of file pcbnew.py.

def pcbnew.BOARD.GetCopperLayerCount (   self)
GetCopperLayerCount(BOARD self) -> int

int
BOARD::GetCopperLayerCount() const

Function GetCopperLayerCount.

int - The number of copper layers in the BOARD. 

Definition at line 33701 of file pcbnew.py.

def pcbnew.BOARD.GetCurrentNetClassName (   self)

Definition at line 35609 of file pcbnew.py.

def pcbnew.BOARD.GetDesignSettings (   self)
GetDesignSettings(BOARD self) -> BOARD_DESIGN_SETTINGS

BOARD_DESIGN_SETTINGS& BOARD::GetDesignSettings() const

Function GetDesignSettings.

the BOARD_DESIGN_SETTINGS for this BOARD 

Definition at line 33984 of file pcbnew.py.

def pcbnew.BOARD.GetDrawings (   self)

Definition at line 35599 of file pcbnew.py.

def pcbnew.BOARD.GetEnabledLayers (   self)
GetEnabledLayers(BOARD self) -> LSET

LSET
BOARD::GetEnabledLayers() const

Function GetEnabledLayers is a proxy function that calls the
corresponding function in m_BoardSettings Returns a bit-mask of all
the layers that are enabled.

int - the enabled layers in bit-mapped form. 

Definition at line 33725 of file pcbnew.py.

def pcbnew.BOARD.GetFileFormatVersionAtLoad (   self)
GetFileFormatVersionAtLoad(BOARD self) -> int

int
BOARD::GetFileFormatVersionAtLoad() const 

Definition at line 33412 of file pcbnew.py.

def pcbnew.BOARD.GetFileName (   self)
GetFileName(BOARD self) -> wxString

const wxString&
BOARD::GetFileName() const 

Definition at line 33300 of file pcbnew.py.

def pcbnew.BOARD.GetFootprint (   self,
  aPosition,
  aActiveLayer,
  aVisibleOnly,
  aIgnoreLocked = False 
)
GetFootprint(BOARD self, wxPoint aPosition, PCB_LAYER_ID aActiveLayer, bool aVisibleOnly, bool aIgnoreLocked=False) -> MODULE
GetFootprint(BOARD self, wxPoint aPosition, PCB_LAYER_ID aActiveLayer, bool aVisibleOnly) -> MODULE

MODULE *
BOARD::GetFootprint(const wxPoint &aPosition, PCB_LAYER_ID
aActiveLayer, bool aVisibleOnly, bool aIgnoreLocked=false)

Function GetFootprint get a footprint by its bounding rectangle at
aPosition on aLayer.

If more than one footprint is at aPosition, then the closest footprint
on the active layer is returned. The distance is calculated via
manhattan distance from the center of the bounding rectangle to
aPosition.

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

aPosition:  A wxPoint object containing the position to test.

aActiveLayer:  Layer to test.

aVisibleOnly:  Search only the visible layers if true.

aIgnoreLocked:  Ignore locked modules when true.

MODULE* The best module or NULL if none. 

Definition at line 35508 of file pcbnew.py.

def pcbnew.BOARD.GetFullRatsnest (   self)

Definition at line 35601 of file pcbnew.py.

def pcbnew.BOARD.GetGridOrigin (   self)
GetGridOrigin(BOARD self) -> wxPoint

const wxPoint&
BOARD::GetGridOrigin() const 

Definition at line 33584 of file pcbnew.py.

def pcbnew.BOARD.GetHighLightNetCode (   self)
GetHighLightNetCode(BOARD self) -> int

int
BOARD::GetHighLightNetCode() const

Function GetHighLightNetCode.

netcode of net to highlight (-1 when no net selected) 

Definition at line 33607 of file pcbnew.py.

def pcbnew.BOARD.GetLayerColor (   self,
  aLayer 
)
GetLayerColor(BOARD self, PCB_LAYER_ID aLayer) -> COLOR4D

COLOR4D
BOARD::GetLayerColor(PCB_LAYER_ID aLayer) const

Function GetLayerColor gets a layer color for any valid layer,
including non-copper ones. 

Definition at line 34322 of file pcbnew.py.

def pcbnew.BOARD.GetLayerID (   self,
  aLayerName 
)
GetLayerID(BOARD self, wxString aLayerName) -> PCB_LAYER_ID const

const PCB_LAYER_ID
BOARD::GetLayerID(const wxString &aLayerName) const

Function GetLayerID returns the ID of a layer given by aLayerName.

Copper layers may have custom names.

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

aLayerName:  = A layer name, like wxT("B.Cu"), etc.

PCB_LAYER_ID - the layer id, which for copper layers may be custom,
else standard. 

Definition at line 34177 of file pcbnew.py.

def pcbnew.BOARD.GetLayerName (   self,
  aLayer 
)
GetLayerName(BOARD self, PCB_LAYER_ID aLayer) -> 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 34199 of file pcbnew.py.

def pcbnew.BOARD.GetLayerType (   self,
  aLayer 
)
GetLayerType(BOARD self, PCB_LAYER_ID aLayer) -> LAYER_T

LAYER_T
BOARD::GetLayerType(PCB_LAYER_ID aLayer) const

Function GetLayerType returns the type of the copper layer given by
aLayer.

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

aLayer:  A layer index, like B_Cu, etc.

LAYER_T - the layer type, or LAYER_T(-1) if the index was out of
range. 

Definition at line 34266 of file pcbnew.py.

def pcbnew.BOARD.GetLockPoint (   self,
  aPosition,
  aLayerMask 
)
GetLockPoint(BOARD self, wxPoint aPosition, LSET aLayerMask) -> BOARD_CONNECTED_ITEM

BOARD_CONNECTED_ITEM *
BOARD::GetLockPoint(const wxPoint &aPosition, LSET aLayerMask)

Function GetLockPoint returns the item at the "attachment" point at
the end of a trace at aPosition on aLayerMask.

This may be a PAD or another trace segment.

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

aPosition:  A wxPoint object containing the position to test.

aLayerMask:  A layer or layers to mask the hit test. Use -1 to ignore
layer mask.

A pointer to a BOARD_ITEM object if found otherwise NULL. 

Definition at line 35541 of file pcbnew.py.

def pcbnew.BOARD.GetMARKER (   self,
  index 
)
GetMARKER(BOARD self, int index) -> MARKER_PCB

MARKER_PCB*
BOARD::GetMARKER(int index) const

Function GetMARKER returns the MARKER at a given index.

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

index:  The array type index into a collection of MARKER_PCBS.

MARKER_PCB* - a pointer to the MARKER_PCB or NULL if index out of
range. 

Definition at line 33516 of file pcbnew.py.

def pcbnew.BOARD.GetMARKERCount (   self)
GetMARKERCount(BOARD self) -> int

int
BOARD::GetMARKERCount() const

Function GetMARKERCount.

int - The number of MARKER_PCBS. 

Definition at line 33536 of file pcbnew.py.

def pcbnew.BOARD.GetModules (   self)

Definition at line 35598 of file pcbnew.py.

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

void
BOARD::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 34579 of file pcbnew.py.

def pcbnew.BOARD.GetNetClasses (   self)

Definition at line 35606 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.BOARD.GetNetcodeFromNetname (   self,
  netname 
)
Given a netname, return its netcode

Definition at line 35630 of file pcbnew.py.

def pcbnew.BOARD.GetNetCount (   self)
GetNetCount(BOARD self) -> unsigned int

unsigned
BOARD::GetNetCount() const

Function GetNetCount.

the number of nets ( NETINFO_ITEM) 

Definition at line 34507 of file pcbnew.py.

def pcbnew.BOARD.GetNetInfo (   self)
GetNetInfo(BOARD self) -> NETINFO_LIST

NETINFO_LIST&
BOARD::GetNetInfo() 

Definition at line 34497 of file pcbnew.py.

def pcbnew.BOARD.GetNetsByName (   self)
Return a dictionary like object with key:wxString netname and value:NETINFO_ITEM

Definition at line 35618 of file pcbnew.py.

def pcbnew.BOARD.GetNetsByNetcode (   self)
Return a dictionary like object with key:int netcode and value:NETINFO_ITEM

Definition at line 35624 of file pcbnew.py.

def pcbnew.BOARD.GetNodesCount (   self)
GetNodesCount(BOARD self) -> unsigned int

unsigned
BOARD::GetNodesCount() const

Function GetNodesCount.

the number of pads members of nets (i.e. with netcode > 0) 

Definition at line 34373 of file pcbnew.py.

def pcbnew.BOARD.GetNumSegmTrack (   self)
GetNumSegmTrack(BOARD self) -> int

int
BOARD::GetNumSegmTrack() const

Functions to get some items count. 

Definition at line 34335 of file pcbnew.py.

def pcbnew.BOARD.GetNumSegmZone (   self)
GetNumSegmZone(BOARD self) -> int

int
BOARD::GetNumSegmZone() const

Calculate the zone segment count. 

Definition at line 34347 of file pcbnew.py.

def pcbnew.BOARD.GetPad (   self,
  args 
)
GetPad(BOARD self, unsigned int aIndex) -> D_PAD
GetPad(BOARD self, wxPoint aPosition, LSET aLayerMask) -> D_PAD
GetPad(BOARD self, wxPoint aPosition) -> D_PAD
GetPad(BOARD self, TRACK aTrace, ENDPOINT_T aEndPoint) -> D_PAD
GetPad(BOARD self, D_PADS aPadList, wxPoint aPosition, LSET aLayerMask) -> D_PAD

D_PAD *
BOARD::GetPad(std::vector< D_PAD * > &aPadList, const wxPoint
&aPosition, LSET aLayerMask)

Function GetPad locates the pad connected at aPosition on aLayer
starting at list position aPad.

This function uses a fast search in this sorted pad list and it is
faster than GetPadFast(). This list is a sorted pad list must be built
before calling this function.

The normal pad list is sorted by increasing netcodes.

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

aPadList:  = the list of pads candidates (a std::vector<D_PAD*>)

aPosition:  A wxPoint object containing the position to test.

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

a D_PAD object pointer to the connected pad. 

Definition at line 35293 of file pcbnew.py.

def pcbnew.BOARD.GetPadCount (   self)
GetPadCount(BOARD self) -> unsigned int

unsigned
BOARD::GetPadCount() const

Function GetPadCount.

the number of pads in board 

Definition at line 34438 of file pcbnew.py.

def pcbnew.BOARD.GetPadFast (   self,
  aPosition,
  aLayerMask 
)
GetPadFast(BOARD self, wxPoint aPosition, LSET aLayerMask) -> D_PAD

D_PAD *
BOARD::GetPadFast(const wxPoint &aPosition, LSET aLayerMask)

Function GetPadFast return pad found at aPosition on aLayerMask using
the fast search method.

The fast search method only works if the pad list has already been
built.

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 or NULL if not found. 

Definition at line 35268 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.BOARD.GetPads (   self)
GetPads(BOARD self) -> D_PADS

const D_PADS& BOARD::GetPads()

Function GetPads returns a reference to a list of all the pads.

The returned list is not sorted and contains pointers to PADS, but
those pointers do not convey ownership of the respective PADs. D_PADS
- a full list of pads 

Definition at line 34452 of file pcbnew.py.

def pcbnew.BOARD.GetPageSettings (   self)
GetPageSettings(BOARD self) -> PAGE_INFO const &

const PAGE_INFO&
BOARD::GetPageSettings() const 

Definition at line 34014 of file pcbnew.py.

def pcbnew.BOARD.GetPlotOptions (   self)
GetPlotOptions(BOARD self) -> PCB_PLOT_PARAMS

const PCB_PLOT_PARAMS&
BOARD::GetPlotOptions() const 

Definition at line 34034 of file pcbnew.py.

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

const wxPoint &
BOARD::GetPosition() const override 

Definition at line 33356 of file pcbnew.py.

def pcbnew.BOARD.GetRatsnest (   self)
GetRatsnest(BOARD self) -> RN_DATA *

RN_DATA*
BOARD::GetRatsnest() const

Function GetRatsnest() returns list of missing connections between
components/tracks.

RATSNEST* is an object that contains informations about missing
connections. 

Definition at line 33475 of file pcbnew.py.

def pcbnew.BOARD.GetRatsnestsCount (   self)
GetRatsnestsCount(BOARD self) -> unsigned int

unsigned
BOARD::GetRatsnestsCount() const

Function GetNumRatsnests.

int - The number of rats 

Definition at line 34359 of file pcbnew.py.

def pcbnew.BOARD.GetSortedPadListByXthenYCoord (   self,
  aVector,
  aNetCode = -1 
)
GetSortedPadListByXthenYCoord(BOARD self, D_PADS aVector, int aNetCode=-1)
GetSortedPadListByXthenYCoord(BOARD self, D_PADS aVector)

void
BOARD::GetSortedPadListByXthenYCoord(std::vector< D_PAD * > &aVector,
int aNetCode=-1)

Function GetSortedPadListByXthenYCoord first empties then fills the
vector with all pads and sorts them by increasing x coordinate, and
for increasing y coordinate for same values of x coordinates.

The vector only holds pointers to the pads and those pointers are only
references to pads which are owned by the BOARD through other links.

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

aVector:  Where to put the pad pointers.

aNetCode:  = the netcode filter: = -1 to build the full pad list. = a
given netcode to build the pad list relative to the given net 

Definition at line 35348 of file pcbnew.py.

def pcbnew.BOARD.GetStandardLayerName (   aLayerId)
GetStandardLayerName(PCB_LAYER_ID aLayerId) -> wxString

Definition at line 34236 of file pcbnew.py.

def pcbnew.BOARD.GetTitleBlock (   self)
GetTitleBlock(BOARD self) -> TITLE_BLOCK

TITLE_BLOCK&
BOARD::GetTitleBlock() 

Definition at line 34054 of file pcbnew.py.

def pcbnew.BOARD.GetTracks (   self)

Definition at line 35600 of file pcbnew.py.

def pcbnew.BOARD.GetTrackWidthList (   self)

Definition at line 35615 of file pcbnew.py.

def pcbnew.BOARD.GetUnconnectedNetCount (   self)
GetUnconnectedNetCount(BOARD self) -> unsigned int

unsigned
BOARD::GetUnconnectedNetCount() const

Function GetUnconnectedNetCount.

the number of unconnected nets in the current rats nest. 

Definition at line 34405 of file pcbnew.py.

def pcbnew.BOARD.GetViaByPosition (   self,
  args 
)
GetViaByPosition(BOARD self, wxPoint aPosition, PCB_LAYER_ID aLayer) -> VIA
GetViaByPosition(BOARD self, wxPoint aPosition) -> VIA

VIA *
BOARD::GetViaByPosition(const wxPoint &aPosition, PCB_LAYER_ID
aLayer=PCB_LAYER_ID(-1)) const

Function GetViaByPosition finds the first via at aPosition on aLayer.

This function does not use the normal hit test to locate a via which
which tests if a position is within the via's bounding box. It tests
for the actual locate of the via.

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

aPosition:  The wxPoint to HitTest() against.

aLayer:  The layer to search. Use -1 (<PCB_LAYER_ID> UNDEFINED_LAYER)
for a don't care.

VIA* A point a to the VIA object if found, else NULL. 

Definition at line 35240 of file pcbnew.py.

def pcbnew.BOARD.GetViasDimensionsList (   self)

Definition at line 35612 of file pcbnew.py.

def pcbnew.BOARD.GetVisibleElementColor (   self,
  LAYER_aPCB 
)
GetVisibleElementColor(BOARD self, GAL_LAYER_ID LAYER_aPCB) -> COLOR4D

COLOR4D
BOARD::GetVisibleElementColor(GAL_LAYER_ID LAYER_aPCB)

Function GetVisibleElementColor returns the color of a pcb visible
element.

See:  enum GAL_LAYER_ID 

Definition at line 33958 of file pcbnew.py.

def pcbnew.BOARD.GetVisibleElements (   self)
GetVisibleElements(BOARD self) -> int

int
BOARD::GetVisibleElements() const

Function GetVisibleElements is a proxy function that calls the
correspondent function in m_BoardSettings returns a bit-mask of all
the element categories that are visible.

int - the visible element bitmap or-ed from enum GAL_LAYER_ID

See:  enum GAL_LAYER_ID 

Definition at line 33837 of file pcbnew.py.

def pcbnew.BOARD.GetVisibleLayers (   self)
GetVisibleLayers(BOARD self) -> LSET

LSET
BOARD::GetVisibleLayers() const

Function GetVisibleLayers is a proxy function that calls the
correspondent function in m_BoardSettings Returns a bit-mask of all
the layers that are visible.

int - the visible layers in bit-mapped form. 

Definition at line 33802 of file pcbnew.py.

def pcbnew.BOARD.GetVisibleTrack (   self,
  aStartingTrace,
  aPosition,
  aLayerSet 
)
GetVisibleTrack(BOARD self, TRACK aStartingTrace, wxPoint aPosition, LSET aLayerSet) -> TRACK

TRACK *
BOARD::GetVisibleTrack(TRACK *aStartingTrace, const wxPoint
&aPosition, LSET aLayerSet) const

Function GetVisibleTrack finds the neighboring visible segment of
aTrace at aPosition that is on a layer in aLayerSet.

Traces that are flagged as deleted or busy are ignored.

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

aStartingTrace:  is the first TRACK to test, testing continues to end
of m_Track list from this starting point.

aPosition:  A wxPoint object containing the position to test.

aLayerSet:  A set of layers; returned TRACK must be on one of these.
May pass a full set to request any layer.

A TRACK object pointer if found otherwise NULL. 

Definition at line 35375 of file pcbnew.py.

def pcbnew.BOARD.GetZoneSettings (   self)
GetZoneSettings(BOARD self) -> ZONE_SETTINGS

const ZONE_SETTINGS&
BOARD::GetZoneSettings() const 

Definition at line 34074 of file pcbnew.py.

def pcbnew.BOARD.HighLightOFF (   self)
HighLightOFF(BOARD self)

void
BOARD::HighLightOFF()

Function HighLightOFF Disable highlight. 

Definition at line 33652 of file pcbnew.py.

def pcbnew.BOARD.HighLightON (   self)
HighLightON(BOARD self)

void BOARD::HighLightON()

Function HighLightON Enable highlight.

if m_highLight_NetCode >= 0, this net will be highlighted 

Definition at line 33664 of file pcbnew.py.

def pcbnew.BOARD.HitTestForAnyFilledArea (   self,
  aRefPos,
  aStartLayer,
  aEndLayer,
  aNetCode 
)
HitTestForAnyFilledArea(BOARD self, wxPoint aRefPos, PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer, int aNetCode) -> ZONE_CONTAINER

ZONE_CONTAINER
* BOARD::HitTestForAnyFilledArea(const wxPoint &aRefPos, PCB_LAYER_ID
aStartLayer, PCB_LAYER_ID aEndLayer, int aNetCode)

Function HitTestForAnyFilledArea tests if the given wxPoint is within
the bounds of a filled area of this zone.

the test is made on zones on layer from aStartLayer to aEndLayer Note:
if a zone has its flag BUSY (in .m_State) is set, it is ignored.

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

aRefPos:  A wxPoint to test

aStartLayer:  the first layer to test

aEndLayer:  the last layer to test

aNetCode:  = the netcode used to filter zones (-1 to to test all
zones)

ZONE_CONTAINER* return a pointer to the ZONE_CONTAINER found, else
NULL 

Definition at line 34840 of file pcbnew.py.

def pcbnew.BOARD.InsertArea (   self,
  netcode,
  iarea,
  layer,
  x,
  y,
  hatch 
)
InsertArea(BOARD self, int netcode, int iarea, PCB_LAYER_ID layer, int x, int y, int hatch) -> ZONE_CONTAINER

ZONE_CONTAINER *
BOARD::InsertArea(int netcode, int iarea, PCB_LAYER_ID layer, int x,
int y, int hatch)

Function InsertArea add empty copper area to net, inserting after
m_ZoneDescriptorList[iarea].

pointer to the new area 

Definition at line 35003 of file pcbnew.py.

def pcbnew.BOARD.IsElementVisible (   self,
  LAYER_aPCB 
)
IsElementVisible(BOARD self, GAL_LAYER_ID LAYER_aPCB) -> bool

bool
BOARD::IsElementVisible(GAL_LAYER_ID LAYER_aPCB) const

Function IsElementVisible tests whether a given element category is
visible.

Keep this as an inline function.

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

LAYER_aPCB:  is from the enum by the same name

bool - true if the element is visible.

See:  enum GAL_LAYER_ID 

Definition at line 33892 of file pcbnew.py.

def pcbnew.BOARD.IsEmpty (   self)
IsEmpty(BOARD self) -> bool

bool BOARD::IsEmpty() const 

Definition at line 33376 of file pcbnew.py.

def pcbnew.BOARD.IsHighLightNetON (   self)
IsHighLightNetON(BOARD self) -> bool

bool
BOARD::IsHighLightNetON() const

Function IsHighLightNetON.

true if a net is currently highlighted 

Definition at line 33638 of file pcbnew.py.

def pcbnew.BOARD.IsLayerEnabled (   self,
  aLayer 
)
IsLayerEnabled(BOARD self, PCB_LAYER_ID aLayer) -> bool

bool
BOARD::IsLayerEnabled(PCB_LAYER_ID aLayer) const

Function IsLayerEnabled is a proxy function that calls the
correspondent function in m_BoardSettings tests whether a given layer
is enabled.

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

aLayer:  = The layer to be tested

bool - true if the layer is visible. 

Definition at line 33760 of file pcbnew.py.

def pcbnew.BOARD.IsLayerVisible (   self,
  aLayer 
)
IsLayerVisible(BOARD self, PCB_LAYER_ID aLayer) -> bool

bool
BOARD::IsLayerVisible(PCB_LAYER_ID aLayer) const

Function IsLayerVisible is a proxy function that calls the
correspondent function in m_BoardSettings tests whether a given layer
is visible.

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

aLayer:  = The layer to be tested

bool - true if the layer is visible. 

Definition at line 33781 of file pcbnew.py.

def pcbnew.BOARD.IsModuleLayerVisible (   self,
  layer 
)
IsModuleLayerVisible(BOARD self, PCB_LAYER_ID layer) -> bool

bool
BOARD::IsModuleLayerVisible(PCB_LAYER_ID layer)

Function IsModuleLayerVisible expects either of the two layers on
which a module can reside, and returns whether that layer is visible.

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

layer:  One of the two allowed layers for modules: F_Cu or B_Cu

bool - true if the layer is visible, else false. 

Definition at line 33938 of file pcbnew.py.

def pcbnew.BOARD.MarkTrace (   self,
  aTrace,
  aCount,
  aTraceLength,
  aInPackageLength,
  aReorder 
)
MarkTrace(BOARD self, TRACK aTrace, int * aCount, double * aTraceLength, double * aInPackageLength, bool aReorder) -> TRACK

TRACK *
BOARD::MarkTrace(TRACK *aTrace, int *aCount, double *aTraceLength,
double *aInPackageLength, bool aReorder)

Function MarkTrace marks a chain of trace segments, connected to
aTrace.

Each segment is marked by setting the BUSY bit into m_Flags.
Electrical continuity is detected by walking each segment, and finally
the segments are rearranged into a contiguous chain within the given
list.

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

aTrace:  The segment within a list of trace segments to test.

aCount:  A pointer to an integer where to return the number of marked
segments (can be NULL).

aTraceLength:  A pointer to an double where to return the length of
the trace (can be NULL).

aInPackageLength:  A pointer to an double where to return the extra
lengths inside integrated circuits from the pads connected to this
track to the die (if any) (can be NULL).

aReorder:  true for reorder the interesting segments (useful for track
edition/deletion) in this case the flag BUSY is set (the user is
responsible of flag clearing). False for no reorder : useful when we
want just calculate the track length in this case, flags are reset

TRACK* - The first in the chain of interesting segments. 

Definition at line 35404 of file pcbnew.py.

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

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

Function Move move this object.

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

aMoveVector:  - the move vector for this object. 

Definition at line 33385 of file pcbnew.py.

def pcbnew.BOARD.NormalizeAreaPolygon (   self,
  aNewZonesList,
  aCurrArea 
)
NormalizeAreaPolygon(BOARD self, PICKED_ITEMS_LIST * aNewZonesList, ZONE_CONTAINER aCurrArea) -> bool

bool
BOARD::NormalizeAreaPolygon(PICKED_ITEMS_LIST *aNewZonesList,
ZONE_CONTAINER *aCurrArea)

Function NormalizeAreaPolygon Process an area that has been modified,
by normalizing its polygon against itself.

i.e. convert a self-intersecting polygon to one (or more) non self-
intersecting polygon(s) This may change the number and order of copper
areas in the net.

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

aNewZonesList:  = a PICKED_ITEMS_LIST * where to store new created
areas pickers

aCurrArea:  = the zone to process

true if changes are made 

Definition at line 35019 of file pcbnew.py.

def pcbnew.BOARD.OnAreaPolygonModified (   self,
  aModifiedZonesList,
  modified_area 
)
OnAreaPolygonModified(BOARD self, PICKED_ITEMS_LIST * aModifiedZonesList, ZONE_CONTAINER modified_area) -> bool

bool
BOARD::OnAreaPolygonModified(PICKED_ITEMS_LIST *aModifiedZonesList,
ZONE_CONTAINER *modified_area)

Function OnAreaPolygonModified Process an area that has been modified,
by normalizing its polygon and merging the intersecting polygons for
any other areas on the same net.

This may change the number and order of copper areas in the net.

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

aModifiedZonesList:  = a PICKED_ITEMS_LIST * where to store deleted or
added areas (useful in undo commands can be NULL

modified_area:  = area to test

true if some areas modified 

Definition at line 35047 of file pcbnew.py.

def pcbnew.BOARD.PadDelete (   self,
  aPad 
)
PadDelete(BOARD self, D_PAD aPad)

void BOARD::PadDelete(D_PAD
*aPad)

Function PadDelete deletes a given bad from the BOARD by removing it
from its module and from the m_NetInfo.

Makes no UI calls.

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

aPad:  is the pad to delete. 

Definition at line 35328 of file pcbnew.py.

def pcbnew.BOARD.PopHighLight (   self)
PopHighLight(BOARD self)

void
BOARD::PopHighLight()

Function PopHighLight retrieve a previously saved high light info. 

Definition at line 33689 of file pcbnew.py.

def pcbnew.BOARD.PushHighLight (   self)
PushHighLight(BOARD self)

void
BOARD::PushHighLight()

Function PushHighLight save current high light info for later use. 

Definition at line 33677 of file pcbnew.py.

def pcbnew.BOARD.RedrawAreasOutlines (   self,
  aPanel,
  aDC,
  aDrawMode,
  aLayer 
)
RedrawAreasOutlines(BOARD self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, PCB_LAYER_ID aLayer)

void
BOARD::RedrawAreasOutlines(EDA_DRAW_PANEL *aPanel, wxDC *aDC,
GR_DRAWMODE aDrawMode, PCB_LAYER_ID aLayer)

Function RedrawAreasOutlines Redraw all areas outlines on layer aLayer
( redraw all if aLayer < 0 ) 

Definition at line 34872 of file pcbnew.py.

def pcbnew.BOARD.RedrawFilledAreas (   self,
  aPanel,
  aDC,
  aDrawMode,
  aLayer 
)
RedrawFilledAreas(BOARD self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, PCB_LAYER_ID aLayer)

void
BOARD::RedrawFilledAreas(EDA_DRAW_PANEL *aPanel, wxDC *aDC,
GR_DRAWMODE aDrawMode, PCB_LAYER_ID aLayer)

Function RedrawFilledAreas Redraw all filled areas on layer aLayer (
redraw all if aLayer < 0 ) 

Definition at line 34886 of file pcbnew.py.

def pcbnew.BOARD.RemoveArea (   self,
  aDeletedList,
  area_to_remove 
)
RemoveArea(BOARD self, PICKED_ITEMS_LIST * aDeletedList, ZONE_CONTAINER area_to_remove)

void
BOARD::RemoveArea(PICKED_ITEMS_LIST *aDeletedList, ZONE_CONTAINER
*area_to_remove)

Function RemoveArea remove copper area from net, and put it in a
deleted list (if exists)

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

aDeletedList:  = a PICKED_ITEMS_LIST * where to store deleted areas
(useful in undo commands can be NULL

area_to_remove:  = area to delete or put in deleted list 

Definition at line 35101 of file pcbnew.py.

def pcbnew.BOARD.RemoveNative (   self,
  aBoardItem 
)
RemoveNative(BOARD self, BOARD_ITEM aBoardItem)

void BOARD::Remove(BOARD_ITEM
*aBoardItem) override

>

Removes an item from the container.

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

aItem:  is an item to be removed. 

Definition at line 33445 of file pcbnew.py.

def pcbnew.BOARD.ReplaceNetlist (   self,
  aNetlist,
  aDeleteSinglePadNets,
  aNewFootprints,
  aReporter = None 
)
ReplaceNetlist(BOARD self, NETLIST & aNetlist, bool aDeleteSinglePadNets, std::vector< MODULE *,std::allocator< MODULE * > > * aNewFootprints, REPORTER * aReporter=None)
ReplaceNetlist(BOARD self, NETLIST & aNetlist, bool aDeleteSinglePadNets, std::vector< MODULE *,std::allocator< MODULE * > > * aNewFootprints)

void
BOARD::ReplaceNetlist(NETLIST &aNetlist, bool aDeleteSinglePadNets,
std::vector< MODULE * > *aNewFootprints, REPORTER *aReporter=NULL)

Function ReplaceNetlist updates the BOARD according to aNetlist.

The changes are made to the board are as follows they are not disabled
in the status settings in the NETLIST: If a new component is found in
the NETLIST and not in the BOARD, it is added to the BOARD.

If a the component in the NETLIST is already on the BOARD, then one or
more of the following actions can occur: If the footprint name in the
NETLIST does not match the footprint name on the BOARD, the footprint
on the BOARD is replaced with the footprint specified in the NETLIST
and the proper parameters are copied from the existing footprint.

If the reference designator in the NETLIST does not match the
reference designator on the BOARD, the reference designator is updated
from the NETLIST.

If the value field in the NETLIST does not match the value field on
the BOARD, the value field is updated from the NETLIST.

If the time stamp in the NETLIST does not match the time stamp on the
BOARD, the time stamp is updated from the NETLIST.

After each footprint is added or update as described above, each
footprint pad net name is compared and updated to the value defined in
the NETLIST.

After all of the footprints have been added, updated, and net names
properly set, any extra unlock footprints are removed from the BOARD.

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

aNetlist:  is the new netlist to revise the contents of the BOARD
with.

aDeleteSinglePadNets:  if true, remove nets counting only one pad and
set net code to 0 for these pads

aReporter:  is a REPORTER object to report the changes aNetlist makes
to the BOARD. If NULL, no change reporting occurs. 

Definition at line 34732 of file pcbnew.py.

def pcbnew.BOARD.ResetHighLight (   self)
ResetHighLight(BOARD self)

void
BOARD::ResetHighLight()

Function ResetHighLight Reset all high light data to the init state.

Definition at line 33594 of file pcbnew.py.

def pcbnew.BOARD.Save (   self,
  filename 
)

Definition at line 35603 of file pcbnew.py.

def pcbnew.BOARD.SetAreasNetCodesFromNetNames (   self)
SetAreasNetCodesFromNetNames(BOARD self) -> int

int
BOARD::SetAreasNetCodesFromNetNames(void)

Function SetAreasNetCodesFromNetNames Set the .m_NetCode member of all
copper areas, according to the area Net Name The
SetNetCodesFromNetNames is an equivalent to net name, for fast
comparisons.

However the Netcode is an arbitrary equivalence, it must be set after
each netlist read or net change Must be called after pad netcodes are
calculated : error count For non copper areas, netcode is set to 0 

Definition at line 34900 of file pcbnew.py.

def pcbnew.BOARD.SetAuxOrigin (   self,
  aPoint 
)
SetAuxOrigin(BOARD self, wxPoint aPoint)

void
BOARD::SetAuxOrigin(const wxPoint &aPoint)

Function SetAuxOrigin sets the origin point used for plotting. 

Definition at line 33550 of file pcbnew.py.

def pcbnew.BOARD.SetColorsSettings (   self,
  aColorsSettings 
)
SetColorsSettings(BOARD self, COLORS_DESIGN_SETTINGS aColorsSettings)

void
BOARD::SetColorsSettings(COLORS_DESIGN_SETTINGS *aColorsSettings)

Function SetColorsSettings.

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

aColorsSettings:  = the new COLORS_DESIGN_SETTINGS to use 

Definition at line 34107 of file pcbnew.py.

def pcbnew.BOARD.SetCopperLayerCount (   self,
  aCount 
)
SetCopperLayerCount(BOARD self, int aCount)

void
BOARD::SetCopperLayerCount(int aCount) 

Definition at line 33715 of file pcbnew.py.

def pcbnew.BOARD.SetDesignSettings (   self,
  aDesignSettings 
)
SetDesignSettings(BOARD self, BOARD_DESIGN_SETTINGS aDesignSettings)

void
BOARD::SetDesignSettings(const BOARD_DESIGN_SETTINGS &aDesignSettings)

Function SetDesignSettings.

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

aDesignSettings:  the new BOARD_DESIGN_SETTINGS to use 

Definition at line 33997 of file pcbnew.py.

def pcbnew.BOARD.SetElementVisibility (   self,
  LAYER_aPCB,
  aNewState 
)
SetElementVisibility(BOARD self, GAL_LAYER_ID LAYER_aPCB, bool aNewState)

void
BOARD::SetElementVisibility(GAL_LAYER_ID LAYER_aPCB, bool aNewState)

Function SetElementVisibility changes the visibility of an element
category.

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

LAYER_aPCB:  is from the enum by the same name

aNewState:  = The new visibility state of the element category

See:  enum GAL_LAYER_ID 

Definition at line 33916 of file pcbnew.py.

def pcbnew.BOARD.SetEnabledLayers (   self,
  aLayerMask 
)
SetEnabledLayers(BOARD self, LSET aLayerMask)

void
BOARD::SetEnabledLayers(LSET aLayerMask)

Function SetEnabledLayers is a proxy function that calls the
correspondent function in m_BoardSettings Changes the bit-mask of
enabled layers.

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

aLayerMask:  = The new bit-mask of enabled layers 

Definition at line 33741 of file pcbnew.py.

def pcbnew.BOARD.SetFileFormatVersionAtLoad (   self,
  aVersion 
)
SetFileFormatVersionAtLoad(BOARD self, int aVersion)

void
BOARD::SetFileFormatVersionAtLoad(int aVersion) 

Definition at line 33402 of file pcbnew.py.

def pcbnew.BOARD.SetFileName (   self,
  aFileName 
)
SetFileName(BOARD self, wxString aFileName)

void
BOARD::SetFileName(const wxString &aFileName) 

Definition at line 33290 of file pcbnew.py.

def pcbnew.BOARD.SetGridOrigin (   self,
  aPoint 
)
SetGridOrigin(BOARD self, wxPoint aPoint)

void
BOARD::SetGridOrigin(const wxPoint &aPoint)

Function SetGridOrigin sets the origin point of the grid. 

Definition at line 33572 of file pcbnew.py.

def pcbnew.BOARD.SetHighLightNet (   self,
  aNetCode 
)
SetHighLightNet(BOARD self, int aNetCode)

void
BOARD::SetHighLightNet(int aNetCode)

Function SetHighLightNet.

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

aNetCode:  = netcode of net to highlight 

Definition at line 33621 of file pcbnew.py.

def pcbnew.BOARD.SetLayerColor (   self,
  aLayer,
  aColor 
)
SetLayerColor(BOARD self, PCB_LAYER_ID aLayer, COLOR4D aColor)

void
BOARD::SetLayerColor(PCB_LAYER_ID aLayer, COLOR4D aColor)

Function SetLayerColor changes a layer color for any valid layer,
including non-copper ones. 

Definition at line 34309 of file pcbnew.py.

def pcbnew.BOARD.SetLayerDescr (   self,
  aIndex,
  aLayer 
)
SetLayerDescr(BOARD self, PCB_LAYER_ID aIndex, LAYER aLayer) -> bool

bool
BOARD::SetLayerDescr(PCB_LAYER_ID aIndex, const LAYER &aLayer)

Function SetLayerDescr returns the type of the copper layer given by
aLayer.

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

aIndex:  A layer index in m_Layer

aLayer:  A reference to a LAYER description.

false if the index was out of range. 

Definition at line 34244 of file pcbnew.py.

def pcbnew.BOARD.SetLayerName (   self,
  aLayer,
  aLayerName 
)
SetLayerName(BOARD self, PCB_LAYER_ID aLayer, wxString aLayerName) -> bool

bool
BOARD::SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)

Function SetLayerName changes the name of the layer given by aLayer.

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

aLayer:  A layer, like B_Cu, etc.

aLayerName:  The new layer name

bool - true if aLayerName was legal and unique among other layer names
at other layer indices and aLayer was within range, else false. 

Definition at line 34214 of file pcbnew.py.

def pcbnew.BOARD.SetLayerType (   self,
  aLayer,
  aLayerType 
)
SetLayerType(BOARD self, PCB_LAYER_ID aLayer, LAYER_T aLayerType) -> bool

bool
BOARD::SetLayerType(PCB_LAYER_ID aLayer, LAYER_T aLayerType)

Function SetLayerType changes the type of the layer given by aLayer.

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

aLayer:  A layer index, like B_Cu, etc.

aLayerType:  The new layer type.

bool - true if aLayerType was legal and aLayer was within range, else
false. 

Definition at line 34287 of file pcbnew.py.

def pcbnew.BOARD.SetNodeCount (   self,
  aCount 
)
SetNodeCount(BOARD self, unsigned int aCount)

void
BOARD::SetNodeCount(unsigned aCount)

Function SetNodeCount set the number of nodes of the current net to
aCount.

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

aCount:  is the number of nodes attached to the current net. 

Definition at line 34387 of file pcbnew.py.

def pcbnew.BOARD.SetPageSettings (   self,
  aPageSettings 
)
SetPageSettings(BOARD self, PAGE_INFO const & aPageSettings)

void
BOARD::SetPageSettings(const PAGE_INFO &aPageSettings) 

Definition at line 34024 of file pcbnew.py.

def pcbnew.BOARD.SetPlotOptions (   self,
  aOptions 
)
SetPlotOptions(BOARD self, PCB_PLOT_PARAMS aOptions)

void
BOARD::SetPlotOptions(const PCB_PLOT_PARAMS &aOptions) 

Definition at line 34044 of file pcbnew.py.

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

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

Definition at line 33366 of file pcbnew.py.

def pcbnew.BOARD.SetTitleBlock (   self,
  aTitleBlock 
)
SetTitleBlock(BOARD self, TITLE_BLOCK aTitleBlock)

void
BOARD::SetTitleBlock(const TITLE_BLOCK &aTitleBlock) 

Definition at line 34064 of file pcbnew.py.

def pcbnew.BOARD.SetUnconnectedNetCount (   self,
  aCount 
)
SetUnconnectedNetCount(BOARD self, unsigned int aCount)

void
BOARD::SetUnconnectedNetCount(unsigned aCount)

Function SetUnconnectedNetCount sets the number of unconnected nets in
the current rats nest to aCount.

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

aCount:  is the number of unconneceted nets in the current rats nest.

Definition at line 34419 of file pcbnew.py.

def pcbnew.BOARD.SetVisibleAlls (   self)
SetVisibleAlls(BOARD self)

void
BOARD::SetVisibleAlls()

Function SetVisibleAlls changes the bit-mask of visible element
categories and layers.

See:  enum GAL_LAYER_ID 

Definition at line 33877 of file pcbnew.py.

def pcbnew.BOARD.SetVisibleElementColor (   self,
  LAYER_aPCB,
  aColor 
)
SetVisibleElementColor(BOARD self, GAL_LAYER_ID LAYER_aPCB, COLOR4D aColor)

void
BOARD::SetVisibleElementColor(GAL_LAYER_ID LAYER_aPCB, COLOR4D aColor)

Definition at line 33973 of file pcbnew.py.

def pcbnew.BOARD.SetVisibleElements (   self,
  aMask 
)
SetVisibleElements(BOARD self, int aMask)

void
BOARD::SetVisibleElements(int aMask)

Function SetVisibleElements is a proxy function that calls the
correspondent function in m_BoardSettings changes the bit-mask of
visible element categories.

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

aMask:  = The new bit-mask of visible element bitmap or-ed from enum
GAL_LAYER_ID

See:  enum GAL_LAYER_ID 

Definition at line 33855 of file pcbnew.py.

def pcbnew.BOARD.SetVisibleLayers (   self,
  aLayerMask 
)
SetVisibleLayers(BOARD self, LSET aLayerMask)

void
BOARD::SetVisibleLayers(LSET aLayerMask)

Function SetVisibleLayers is a proxy function that calls the
correspondent function in m_BoardSettings changes the bit-mask of
visible layers.

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

aLayerMask:  = The new bit-mask of visible layers 

Definition at line 33818 of file pcbnew.py.

def pcbnew.BOARD.SetZoneSettings (   self,
  aSettings 
)
SetZoneSettings(BOARD self, ZONE_SETTINGS aSettings)

void
BOARD::SetZoneSettings(const ZONE_SETTINGS &aSettings) 

Definition at line 34084 of file pcbnew.py.

def pcbnew.BOARD.SortedNetnamesList (   self,
  aNames,
  aSortbyPadsCount 
)
SortedNetnamesList(BOARD self, wxArrayString & aNames, bool aSortbyPadsCount) -> int

int
BOARD::SortedNetnamesList(wxArrayString &aNames, bool
aSortbyPadsCount)

Function SortedNetnamesList.

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

aNames:  An array string to fill with net names.

aSortbyPadsCount:  true = sort by active pads count, false = no sort
(i.e. leave the sort by net names)

int - net names count. 

Definition at line 34785 of file pcbnew.py.

def pcbnew.BOARD.SynchronizeNetsAndNetClasses (   self)
SynchronizeNetsAndNetClasses(BOARD self)

void
BOARD::SynchronizeNetsAndNetClasses()

Function SynchronizeNetsAndNetClasses copies NETCLASS info to each
NET, based on NET membership in a NETCLASS.

Must be called after a Design Rules edition, or after reading a
netlist (or editing the list of nets) Also this function removes the
non existing nets in netclasses and add net nets in default netclass
(this happens after reading a netlist) 

Definition at line 34808 of file pcbnew.py.

def pcbnew.BOARD.Test_Connections_To_Copper_Areas (   self,
  aNetcode = -1 
)
Test_Connections_To_Copper_Areas(BOARD self, int aNetcode=-1)
Test_Connections_To_Copper_Areas(BOARD self)

void
BOARD::Test_Connections_To_Copper_Areas(int aNetcode=-1)

Function Test_Connection_To_Copper_Areas init .m_ZoneSubnet parameter
in tracks and pads according to the connections to areas found.

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

aNetcode:  = netcode to analyze. if -1, analyze all nets

aNetcode:  = netcode to analyse. if -1, analyse all nets 

Definition at line 35219 of file pcbnew.py.

def pcbnew.BOARD.Test_Drc_Areas_Outlines_To_Areas_Outlines (   self,
  aArea_To_Examine,
  aCreate_Markers 
)
Test_Drc_Areas_Outlines_To_Areas_Outlines(BOARD self, ZONE_CONTAINER aArea_To_Examine, bool aCreate_Markers) -> int

int
BOARD::Test_Drc_Areas_Outlines_To_Areas_Outlines(ZONE_CONTAINER
*aArea_To_Examine, bool aCreate_Markers)

Function Test_Drc_Areas_Outlines_To_Areas_Outlines tests area outlines
for DRC: Tests areas inside other areas.

Tests areas too close.

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

aArea_To_Examine:  area to compare with other areas, or if NULL then
all areas are compared to all others.

aCreate_Markers:  if true create DRC markers. False: do not creates
anything

errors count 

Definition at line 35192 of file pcbnew.py.

def pcbnew.BOARD.TestAreaIntersection (   self,
  area_ref,
  area_to_test 
)
TestAreaIntersection(BOARD self, ZONE_CONTAINER area_ref, ZONE_CONTAINER area_to_test) -> bool

bool
BOARD::TestAreaIntersection(ZONE_CONTAINER *area_ref, ZONE_CONTAINER
*area_to_test)

Function TestAreaIntersection Test for intersection of 2 copper areas
area_to_test must be after area_ref in m_ZoneDescriptorList.

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

area_ref:  = area reference

area_to_test:  = area to compare for intersection calculations

: false if no intersection, true if intersection 

Definition at line 35141 of file pcbnew.py.

def pcbnew.BOARD.TestAreaIntersections (   self,
  area_to_test 
)
TestAreaIntersections(BOARD self, ZONE_CONTAINER area_to_test) -> bool

bool
BOARD::TestAreaIntersections(ZONE_CONTAINER *area_to_test)

Function TestAreaIntersections Check for intersection of a given
copper area with other areas in same net.

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

area_to_test:  = area to compare to all other areas in the same net 

Definition at line 35123 of file pcbnew.py.

def pcbnew.BOARD.TracksInNet (   self,
  aNetCode 
)
TracksInNet(BOARD self, int aNetCode) -> TRACKS

TRACKS
BOARD::TracksInNet(int aNetCode)

Function TrackInNet collects all the TRACKs and VIAs that are members
of a net given by aNetCode.

Used from python.

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

aNetCode:  gives the id of the net.

TRACKS - which are in the net identified by aNetCode. 

Definition at line 35445 of file pcbnew.py.

def pcbnew.BOARD.TracksInNetBetweenPoints (   self,
  aStartPos,
  aGoalPos,
  aNetCode 
)
TracksInNetBetweenPoints(BOARD self, wxPoint aStartPos, wxPoint aGoalPos, int aNetCode) -> TRACKS

TRACKS
BOARD::TracksInNetBetweenPoints(const wxPoint &aStartPos, const
wxPoint &aGoalPos, int aNetCode)

Function TrackInNetBetweenPoints collects all the TRACKs and VIAs that
are members of a net given by aNetCode and that make up a path between
two end points.

The end points must be carefully chosen, and are typically the
locations of two neighboring pads. The function fails if there is an
intervening pad or a 3 way intersection at a track or via. The seeking
starts at aStartPos and strives to travel to aGoalPos. Used from
python.

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

aStartPos:  must correspond to a point on the BOARD which has a TRACK
end or start, typically the location of either a via or pad.

aGoalPos:  must correspond to a point on the BOARD which has a TRACK
end or start, typically the location of either a via or pad.

aNetCode:  gives the id of the net.

TRACKS - non empty if success, empty if your aStartPos or aEndPos are
bad or the net is interrupted along the way by an intervening D_PAD or
a 3 way path.

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

???:  in order to convey detailed error reason upon failure. 

Definition at line 35467 of file pcbnew.py.

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

SEARCH_RESULT
BOARD::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 34652 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.BOARD.ClassOf = staticmethod(ClassOf)
static

Definition at line 33287 of file pcbnew.py.

tuple pcbnew.BOARD.GetStandardLayerName = staticmethod(GetStandardLayerName)
static

Definition at line 34241 of file pcbnew.py.

tuple pcbnew.BOARD.m_CurrentZoneContour = _swig_property(_pcbnew.BOARD_m_CurrentZoneContour_get, _pcbnew.BOARD_m_CurrentZoneContour_set)
static

Definition at line 33340 of file pcbnew.py.

tuple pcbnew.BOARD.m_Drawings = _swig_property(_pcbnew.BOARD_m_Drawings_get, _pcbnew.BOARD_m_Drawings_set)
static

Definition at line 33316 of file pcbnew.py.

tuple pcbnew.BOARD.m_FullRatsnest = _swig_property(_pcbnew.BOARD_m_FullRatsnest_get, _pcbnew.BOARD_m_FullRatsnest_set)
static

Definition at line 33332 of file pcbnew.py.

tuple pcbnew.BOARD.m_LocalRatsnest = _swig_property(_pcbnew.BOARD_m_LocalRatsnest_get, _pcbnew.BOARD_m_LocalRatsnest_set)
static

Definition at line 33336 of file pcbnew.py.

tuple pcbnew.BOARD.m_Modules = _swig_property(_pcbnew.BOARD_m_Modules_get, _pcbnew.BOARD_m_Modules_set)
static

Definition at line 33320 of file pcbnew.py.

tuple pcbnew.BOARD.m_Status_Pcb = _swig_property(_pcbnew.BOARD_m_Status_Pcb_get, _pcbnew.BOARD_m_Status_Pcb_set)
static

Definition at line 33312 of file pcbnew.py.

tuple pcbnew.BOARD.m_Track = _swig_property(_pcbnew.BOARD_m_Track_get, _pcbnew.BOARD_m_Track_set)
static

Definition at line 33324 of file pcbnew.py.

tuple pcbnew.BOARD.m_Zone = _swig_property(_pcbnew.BOARD_m_Zone_get, _pcbnew.BOARD_m_Zone_set)
static

Definition at line 33328 of file pcbnew.py.

pcbnew.BOARD.this

Definition at line 33352 of file pcbnew.py.


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