KiCad Pcbnew Python Scripting
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
pcbnew.BOARD Class Reference
Inheritance diagram for pcbnew.BOARD:
Inheritance graph

Public Member Functions

def __init__ (self, *args, **kwargs)
def SetBoardUse (self, aUse)
def GetBoardUse (self)
def IncrementTimeStamp (self)
def GetTimeStamp (self)
def IsFootprintHolder (self)
def SetFileName (self, aFileName)
def GetFileName (self)
def Tracks (self, *args)
def Footprints (self, *args)
def Drawings (self, *args)
def Zones (self, *args)
def Markers (self, *args)
def GetItemSet (self)
def Groups (self, *args)
def AllConnectedItems (self)
def GetProperties (self)
def SetProperties (self, aProps)
def GetContextualTextVars (self, aVars)
def ResolveTextVar (self, token, aDepth)
def IsEmpty (self)
def SetFileFormatVersionAtLoad (self, aVersion)
def GetFileFormatVersionAtLoad (self)
def SetGenerator (self, aGenerator)
def GetGenerator (self)
def AddNative (self, *args)
def RemoveNative (self, *args)
def FinalizeBulkAdd (self, aNewItems)
def FinalizeBulkRemove (self, aRemovedItems)
def CacheTriangulation (self, *args)
def GetFirstFootprint (self)
def DeleteAllFootprints (self)
def GetItem (self, aID)
def FillItemMap (self, aMap)
def ConvertCrossReferencesToKIIDs (self, aSource)
def ConvertKIIDsToCrossReferences (self, aSource)
def GetConnectivity (self)
def BuildConnectivity (self, aReporter=None)
def DeleteMARKERs (self, *args)
def GetProject (self)
def SetProject (self, aProject, aReferenceOnly=False)
def ClearProject (self)
def ResolveDRCExclusions (self, aCreateMarkers)
def UpdateRatsnestExclusions (self)
def ResetNetHighLight (self)
def GetHighLightNetCodes (self)
def SetHighLightNet (self, aNetCode, aMulti=False)
def IsHighLightNetON (self)
def HighLightON (self, aValue=True)
def HighLightOFF (self)
def GetCopperLayerCount (self)
def SetCopperLayerCount (self, aCount)
def LayerDepth (self, aStartLayer, aEndLayer)
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, aLayer)
def SetElementVisibility (self, aLayer, aNewState)
def IsFootprintLayerVisible (self, aLayer)
def GetDesignSettings (self)
def GetTentVias (self)
def SetTentVias (self, aFlag)
def GetPageSettings (self)
def SetPageSettings (self, aPageSettings)
def GetPlotOptions (self)
def SetPlotOptions (self, aOptions)
def GetTitleBlock (self, *args)
def SetTitleBlock (self, aTitleBlock)
def GetUserUnits (self)
def SetUserUnits (self, aUnits)
def UpdateUserUnits (self, aItem, aView)
def GetBoardPolygonOutlines (self, aOutlines, aErrorHandler=None, aAllowUseArcsInPolygons=False)
def GetOutlinesChainingEpsilon (self)
def SetOutlinesChainingEpsilon (self, aValue)
def ConvertBrdLayerToPolygonalContours (self, aLayer, aOutlines)
def GetLayerID (self, aLayerName)
def GetLayerName (self, aLayer)
def SetLayerName (self, aLayer, aLayerName)
def SetLayerDescr (self, aIndex, aLayer)
def GetLayerType (self, aLayer)
def SetLayerType (self, aLayer, aLayerType)
def GetNodesCount (self, aNet=-1)
def GetPads (self)
def BuildListOfNets (self)
def FindNet (self, *args)
def GetNetInfo (self, *args)
def GetNetCount (self)
def ComputeBoundingBox (self, aBoardEdgesOnly=False)
def GetBoardEdgesBoundingBox (self)
def FindFootprintByReference (self, aReference)
def FindFootprintByPath (self, aPath)
def GetNetClassAssignmentCandidates (self)
def SynchronizeNetsAndNetClasses (self, aResetTrackAndViaSizes)
def SynchronizeProperties (self)
def SetAreasNetCodesFromNetNames (self)
def GetArea (self, index)
def GetZoneList (self, aIncludeZonesInFootprints=False)
def GetAreaCount (self)
def AddArea (self, aNewZonesList, aNetcode, aLayer, aStartPointPosition, aHatch)
def TestZoneIntersection (self, aZone1, aZone2)
def GetPadFast (self, aPosition, aLayerMask)
def GetPad (self, *args)
def GetSortedPadListByXthenYCoord (self, aVector, aNetCode=-1)
def GetTrackLength (self, aTrack)
def TracksInNet (self, aNetCode)
def GetFootprint (self, aPosition, aActiveLayer, aVisibleOnly, aIgnoreLocked=False)
def GetMaxClearanceValue (self)
def MapNets (self, aDestBoard)
def SanitizeNetcodes (self)
def AddListener (self, aListener)
def RemoveListener (self, aListener)
def RemoveAllListeners (self)
def OnItemChanged (self, aItem)
def OnItemsChanged (self, aItems)
def GroupsSanityCheck (self, repair=False)
def GroupsSanityCheckInternal (self, repair)
def GroupLegalOps (self, selection)
def __init__ (self, *args)
def GetFootprints (self)
def GetDrawings (self)
def GetTracks (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 (self, *args)
def RemoveNative (self, *args)
def DeleteNative (self, aItem)
def GetZoneSettings (self)
def SetZoneSettings (self, aSettings)
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 SetParentGroup (self, aGroup)
def GetParentGroup (self)
def GetX (self)
def GetY (self)
def GetCenter (self)
def SetX (self, aX)
def SetY (self, aY)
def IsConnected (self)
def IsOnCopperLayer (self)
def HasHole (self)
def IsTented (self)
def GetEffectiveShape (self, *args)
def GetEffectiveHoleShape (self)
def GetParent (self)
def GetParentFootprint (self)
def HasLineStroke (self)
def GetStroke (self)
def SetStroke (self, aStroke)
def GetLayer (self)
def GetLayerSet (self)
def SetLayerSet (self, aLayers)
def SetLayer (self, aLayer)
def Duplicate (self)
def SwapItemData (self, aImage)
def IsOnLayer (self, aLayer)
def IsKnockout (self)
def SetIsKnockout (self, aKnockout)
def IsLocked (self)
def SetLocked (self, aLocked)
def DeleteStructure (self)
def Move (self, aMoveVector)
def Rotate (self, aRotCentre, aAngle)
def Flip (self, aCentre, aFlipLeftRight)
def GetBoard (self, *args)
def GetLayerName (self)
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
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 GetParent (self)
def SetParent (self, aParent)
def IsModified (self)
def IsNew (self)
def IsMoving (self)
def IsSelected (self)
def IsEntered (self)
def IsBrightened (self)
def IsRollover (self)
def SetSelected (self)
def SetBrightened (self)
def ClearSelected (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 XorFlags (self, aMask)
def ClearFlags (self, *args)
def GetFlags (self)
def HasFlag (self, aFlag)
def GetEditFlags (self)
def ClearTempFlags (self)
def ClearEditFlags (self)
def RenderAsBitmap (self, aWorldScale)
def SetIsShownAsBitmap (self, aBitmap)
def IsShownAsBitmap (self)
def IsType (self, aScanTypes)
def SetForceVisible (self, aEnable)
def IsForceVisible (self)
def GetMsgPanelInfo (self, aFrame, aList)
def GetFriendlyName (self)
def HitTest (self, *args)
def GetBoundingBox (self)
def GetPosition (self)
def SetPosition (self, aPos)
def GetFocusPosition (self)
def GetSortPosition (self)
def Clone (self)
def Visit (self, inspector, testData, aScanTypes)
def GetClass (self)
def GetTypeDesc (self)
def GetItemDescription (self, aUnitsProvider)
def GetMenuImage (self)
def Matches (self, aSearchData, aAuxData)
def Replace (self, *args)
def IsReplaceable (self)
def __lt__ (self, aItem)
def ViewBBox (self)
def ViewGetLayers (self, aLayers, aCount)

Static Public Member Functions

def ClassOf (aItem)
def GetStandardLayerName (aLayerId)
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, aRight)

Public Attributes


Static Public Attributes

dictionary netclassmap = {k:v for k,v in self.GetNetClasses().items()}


 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 m_LegacyVisibleLayers = property(_pcbnew.BOARD_m_LegacyVisibleLayers_get, _pcbnew.BOARD_m_LegacyVisibleLayers_set, doc=)
 m_LegacyVisibleItems = property(_pcbnew.BOARD_m_LegacyVisibleItems_get, _pcbnew.BOARD_m_LegacyVisibleItems_set, doc=)
 m_LegacyDesignSettingsLoaded = property(_pcbnew.BOARD_m_LegacyDesignSettingsLoaded_get, _pcbnew.BOARD_m_LegacyDesignSettingsLoaded_set, doc=)
 m_LegacyCopperEdgeClearanceLoaded = property(_pcbnew.BOARD_m_LegacyCopperEdgeClearanceLoaded_get, _pcbnew.BOARD_m_LegacyCopperEdgeClearanceLoaded_set, doc=)
 m_LegacyNetclassesLoaded = property(_pcbnew.BOARD_m_LegacyNetclassesLoaded_get, _pcbnew.BOARD_m_LegacyNetclassesLoaded_set, doc=)
 m_ZoneBBoxCache = property(_pcbnew.BOARD_m_ZoneBBoxCache_get, _pcbnew.BOARD_m_ZoneBBoxCache_set, doc=)
 m_SolderMaskBridges = property(_pcbnew.BOARD_m_SolderMaskBridges_get, _pcbnew.BOARD_m_SolderMaskBridges_set, doc=)
 m_ZoneIsolatedIslandsMap = property(_pcbnew.BOARD_m_ZoneIsolatedIslandsMap_get, _pcbnew.BOARD_m_ZoneIsolatedIslandsMap_set, doc=)
- Properties inherited from pcbnew.BOARD_ITEM_CONTAINER
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
- Properties inherited from pcbnew.BOARD_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
- Properties inherited from pcbnew.EDA_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)

Detailed Description

Proxy of C++ BOARD class.

Definition at line 17576 of file

Constructor & Destructor Documentation

◆ __init__() [1/2]

def pcbnew.BOARD.__init__ (   self,
**  kwargs 

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 17581 of file

◆ __init__() [2/2]

def pcbnew.BOARD.__init__ (   self,

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 18127 of file

Member Function Documentation

◆ AddArea()

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

Definition at line 18043 of file

◆ AddListener()

def pcbnew.BOARD.AddListener (   self,
AddListener(BOARD self, BOARD_LISTENER aListener)

Definition at line 18092 of file

◆ AddNative()

def pcbnew.BOARD.AddNative (   self,
AddNative(BOARD self, BOARD_ITEM aItem, ADD_MODE aMode=INSERT, bool aSkipConnectivity=False)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 17710 of file

Here is the caller graph for this function:

◆ AllConnectedItems()

def pcbnew.BOARD.AllConnectedItems (   self)
AllConnectedItems(BOARD self) -> std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const

Definition at line 17664 of file

◆ BuildConnectivity()

def pcbnew.BOARD.BuildConnectivity (   self,
  aReporter = None 
BuildConnectivity(BOARD self, PROGRESS_REPORTER * aReporter=None) -> bool

Definition at line 17758 of file

◆ BuildListOfNets()

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

Definition at line 17977 of file

◆ CacheTriangulation()

def pcbnew.BOARD.CacheTriangulation (   self,
CacheTriangulation(BOARD self, PROGRESS_REPORTER * aReporter=None, ZONES aZones={})

Definition at line 17726 of file

◆ ClassOf()

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

Definition at line 17586 of file

◆ ClearProject()

def pcbnew.BOARD.ClearProject (   self)
ClearProject(BOARD self)

Definition at line 17777 of file

◆ ComputeBoundingBox()

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

Definition at line 17999 of file

◆ ConvertBrdLayerToPolygonalContours()

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

Definition at line 17936 of file

◆ ConvertCrossReferencesToKIIDs()

def pcbnew.BOARD.ConvertCrossReferencesToKIIDs (   self,
ConvertCrossReferencesToKIIDs(BOARD self, wxString aSource) -> wxString

Definition at line 17746 of file

◆ ConvertKIIDsToCrossReferences()

def pcbnew.BOARD.ConvertKIIDsToCrossReferences (   self,
ConvertKIIDsToCrossReferences(BOARD self, wxString aSource) -> wxString

Definition at line 17750 of file

◆ DeleteAllFootprints()

def pcbnew.BOARD.DeleteAllFootprints (   self)
DeleteAllFootprints(BOARD self)

Definition at line 17734 of file

◆ DeleteMARKERs()

def pcbnew.BOARD.DeleteMARKERs (   self,
    DeleteMARKERs(BOARD self)
    DeleteMARKERs(BOARD self, bool aWarningsAndErrors, bool aExclusions)

Definition at line 17762 of file

Here is the caller graph for this function:

◆ Drawings()

def pcbnew.BOARD.Drawings (   self,
    Drawings(BOARD self) -> DRAWINGS
    Drawings(BOARD self) -> DRAWINGS

Definition at line 17632 of file

Here is the caller graph for this function:

◆ FillItemMap()

def pcbnew.BOARD.FillItemMap (   self,
FillItemMap(BOARD self, std::map< KIID,EDA_ITEM *,std::less< KIID >,std::allocator< std::pair< KIID const,EDA_ITEM * > > > & aMap)

Definition at line 17742 of file

◆ FinalizeBulkAdd()

def pcbnew.BOARD.FinalizeBulkAdd (   self,
FinalizeBulkAdd(BOARD self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aNewItems)

Definition at line 17718 of file

◆ FinalizeBulkRemove()

def pcbnew.BOARD.FinalizeBulkRemove (   self,
FinalizeBulkRemove(BOARD self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aRemovedItems)

Definition at line 17722 of file

◆ FindFootprintByPath()

def pcbnew.BOARD.FindFootprintByPath (   self,
FindFootprintByPath(BOARD self, KIID_PATH aPath) -> FOOTPRINT

Definition at line 18011 of file

◆ FindFootprintByReference()

def pcbnew.BOARD.FindFootprintByReference (   self,
FindFootprintByReference(BOARD self, wxString aReference) -> FOOTPRINT

Definition at line 18007 of file

◆ FindNet()

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

Definition at line 17981 of file

Here is the caller graph for this function:

◆ Footprints()

def pcbnew.BOARD.Footprints (   self,
    Footprints(BOARD self) -> FOOTPRINTS
    Footprints(BOARD self) -> FOOTPRINTS

Definition at line 17625 of file

Here is the caller graph for this function:

◆ GetAllNetClasses()

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 18175 of file

◆ GetArea()

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

Definition at line 18031 of file

◆ GetAreaCount()

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

Definition at line 18039 of file

◆ GetBoardEdgesBoundingBox()

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

Definition at line 18003 of file

◆ GetBoardPolygonOutlines()

def pcbnew.BOARD.GetBoardPolygonOutlines (   self,
  aErrorHandler = None,
  aAllowUseArcsInPolygons = False 
GetBoardPolygonOutlines(BOARD self, SHAPE_POLY_SET aOutlines, OUTLINE_ERROR_HANDLER * aErrorHandler=None, bool aAllowUseArcsInPolygons=False) -> bool

Definition at line 17924 of file

◆ GetBoardUse()

def pcbnew.BOARD.GetBoardUse (   self)
GetBoardUse(BOARD self) -> BOARD_USE

Definition at line 17594 of file

◆ GetConnectivity()

def pcbnew.BOARD.GetConnectivity (   self)
GetConnectivity(BOARD self) -> std::shared_ptr< CONNECTIVITY_DATA >

Definition at line 17754 of file

◆ GetContextualTextVars()

def pcbnew.BOARD.GetContextualTextVars (   self,
GetContextualTextVars(BOARD self, wxArrayString * aVars)

Definition at line 17676 of file

◆ GetCopperLayerCount()

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

Definition at line 17813 of file

◆ GetCurrentNetClassName()

def pcbnew.BOARD.GetCurrentNetClassName (   self)

Definition at line 18147 of file

Here is the caller graph for this function:

◆ GetDesignSettings()

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

Definition at line 17873 of file

Here is the caller graph for this function:

◆ GetDrawings()

def pcbnew.BOARD.GetDrawings (   self)

Definition at line 18138 of file

◆ GetEnabledLayers()

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

Definition at line 17825 of file

◆ GetFileFormatVersionAtLoad()

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

Definition at line 17698 of file

◆ GetFileName()

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

Definition at line 17614 of file

◆ GetFirstFootprint()

def pcbnew.BOARD.GetFirstFootprint (   self)
GetFirstFootprint(BOARD self) -> FOOTPRINT

Definition at line 17730 of file

◆ GetFootprint()

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

Definition at line 18076 of file

◆ GetFootprints()

def pcbnew.BOARD.GetFootprints (   self)

Definition at line 18137 of file

◆ GetGenerator()

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

Definition at line 17706 of file

◆ GetHighLightNetCodes()

def pcbnew.BOARD.GetHighLightNetCodes (   self)
GetHighLightNetCodes(BOARD self) -> std::set< int,std::less< int >,std::allocator< int > > const &

Definition at line 17793 of file

◆ GetItem()

def pcbnew.BOARD.GetItem (   self,

Definition at line 17738 of file

◆ GetItemSet()

def pcbnew.BOARD.GetItemSet (   self)
GetItemSet(BOARD self) -> std::set< BOARD_ITEM *,std::less< BOARD_ITEM * >,std::allocator< BOARD_ITEM * > > const

Definition at line 17653 of file

◆ GetLayerID()

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

Definition at line 17940 of file

◆ GetLayerName()

def pcbnew.BOARD.GetLayerName (   self,
GetLayerName(BOARD self, PCB_LAYER_ID aLayer) -> wxString

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17944 of file

◆ GetLayerType()

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

Definition at line 17961 of file

◆ GetMaxClearanceValue()

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

Definition at line 18080 of file

◆ GetNetClassAssignmentCandidates()

def pcbnew.BOARD.GetNetClassAssignmentCandidates (   self)
GetNetClassAssignmentCandidates(BOARD self) -> STRINGSET

Definition at line 18015 of file

◆ GetNetClasses()

def pcbnew.BOARD.GetNetClasses (   self)

Definition at line 18144 of file

Here is the caller graph for this function:

◆ GetNetcodeFromNetname()

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

Definition at line 18168 of file

◆ GetNetCount()

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

Definition at line 17995 of file

◆ GetNetInfo()

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

Definition at line 17988 of file

Here is the caller graph for this function:

◆ GetNetsByName()

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

Definition at line 18156 of file

Here is the caller graph for this function:

◆ GetNetsByNetcode()

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

Definition at line 18162 of file

◆ GetNodesCount()

def pcbnew.BOARD.GetNodesCount (   self,
  aNet = -1 
GetNodesCount(BOARD self, int aNet=-1) -> unsigned int

Definition at line 17969 of file

◆ GetOutlinesChainingEpsilon()

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

Definition at line 17928 of file

◆ GetPad()

def pcbnew.BOARD.GetPad (   self,
    GetPad(BOARD self, VECTOR2I aPosition, LSET aLayerMask) -> PAD
    GetPad(BOARD self, VECTOR2I aPosition) -> PAD
    GetPad(BOARD self, PCB_TRACK aTrace, ENDPOINT_T aEndPoint) -> PAD
    GetPad(BOARD self, PADS_VEC aPadList, VECTOR2I aPosition, LSET aLayerMask) -> PAD

Definition at line 18055 of file

Here is the caller graph for this function:

◆ GetPadFast()

def pcbnew.BOARD.GetPadFast (   self,
GetPadFast(BOARD self, VECTOR2I aPosition, LSET aLayerMask) -> PAD

Definition at line 18051 of file

◆ GetPads()

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

Definition at line 17973 of file

◆ GetPageSettings()

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

Definition at line 17885 of file

◆ GetPlotOptions()

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

Definition at line 17893 of file

◆ GetProject()

def pcbnew.BOARD.GetProject (   self)
GetProject(BOARD self) -> PROJECT *

Definition at line 17769 of file

◆ GetProperties()

def pcbnew.BOARD.GetProperties (   self)
GetProperties(BOARD self) -> MAP_STRING_STRING

Definition at line 17668 of file

◆ GetSortedPadListByXthenYCoord()

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

Definition at line 18064 of file

◆ GetStandardLayerName()

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

Definition at line 17953 of file

◆ GetTentVias()

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

Definition at line 17877 of file

◆ GetTimeStamp()

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

Definition at line 17602 of file

◆ GetTitleBlock()

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

Definition at line 17901 of file

Here is the caller graph for this function:

◆ GetTrackLength()

def pcbnew.BOARD.GetTrackLength (   self,
GetTrackLength(BOARD self, PCB_TRACK aTrack) -> std::tuple< int,double,double >

Definition at line 18068 of file

◆ GetTracks()

def pcbnew.BOARD.GetTracks (   self)

Definition at line 18139 of file

◆ GetTrackWidthList()

def pcbnew.BOARD.GetTrackWidthList (   self)

Definition at line 18153 of file

◆ GetUserUnits()

def pcbnew.BOARD.GetUserUnits (   self)
GetUserUnits(BOARD self) -> EDA_UNITS

Definition at line 17912 of file

◆ GetViasDimensionsList()

def pcbnew.BOARD.GetViasDimensionsList (   self)

Definition at line 18150 of file

◆ GetVisibleElements()

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

Definition at line 17849 of file

◆ GetVisibleLayers()

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

Definition at line 17841 of file

◆ GetZoneList()

def pcbnew.BOARD.GetZoneList (   self,
  aIncludeZonesInFootprints = False 
GetZoneList(BOARD self, bool aIncludeZonesInFootprints=False) -> std::list< ZONE *,std::allocator< ZONE * > >

Definition at line 18035 of file

◆ GroupLegalOps()

def pcbnew.BOARD.GroupLegalOps (   self,
GroupLegalOps(BOARD self, PCB_SELECTION const & selection) -> BOARD::GroupLegalOpsField

Definition at line 18120 of file

◆ Groups()

def pcbnew.BOARD.Groups (   self,
    Groups(BOARD self) -> GROUPS
    Groups(BOARD self) -> GROUPS

Definition at line 17657 of file

Here is the caller graph for this function:

◆ GroupsSanityCheck()

def pcbnew.BOARD.GroupsSanityCheck (   self,
  repair = False 
GroupsSanityCheck(BOARD self, bool repair=False) -> wxString

Definition at line 18112 of file

◆ GroupsSanityCheckInternal()

def pcbnew.BOARD.GroupsSanityCheckInternal (   self,
GroupsSanityCheckInternal(BOARD self, bool repair) -> wxString

Definition at line 18116 of file

◆ HighLightOFF()

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

Definition at line 17809 of file

◆ HighLightON()

def pcbnew.BOARD.HighLightON (   self,
  aValue = True 
HighLightON(BOARD self, bool aValue=True)

Definition at line 17805 of file

◆ IncrementTimeStamp()

def pcbnew.BOARD.IncrementTimeStamp (   self)
IncrementTimeStamp(BOARD self)

Definition at line 17598 of file

◆ IsElementVisible()

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

Definition at line 17861 of file

◆ IsEmpty()

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

Definition at line 17690 of file

◆ IsFootprintHolder()

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

Definition at line 17606 of file

◆ IsFootprintLayerVisible()

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

Definition at line 17869 of file

◆ IsHighLightNetON()

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

Definition at line 17801 of file

◆ IsLayerEnabled()

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

Definition at line 17833 of file

◆ IsLayerVisible()

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

Definition at line 17837 of file

◆ LayerDepth()

def pcbnew.BOARD.LayerDepth (   self,
LayerDepth(BOARD self, PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer) -> int

Definition at line 17821 of file

◆ MapNets()

def pcbnew.BOARD.MapNets (   self,
MapNets(BOARD self, BOARD aDestBoard)

Definition at line 18084 of file

◆ Markers()

def pcbnew.BOARD.Markers (   self,
    Markers(BOARD self) -> MARKERS
    Markers(BOARD self) -> MARKERS

Definition at line 17646 of file

Here is the caller graph for this function:

◆ OnItemChanged()

def pcbnew.BOARD.OnItemChanged (   self,
OnItemChanged(BOARD self, BOARD_ITEM aItem)

Definition at line 18104 of file

◆ OnItemsChanged()

def pcbnew.BOARD.OnItemsChanged (   self,
OnItemsChanged(BOARD self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aItems)

Definition at line 18108 of file

◆ RemoveAllListeners()

def pcbnew.BOARD.RemoveAllListeners (   self)
RemoveAllListeners(BOARD self)

Definition at line 18100 of file

◆ RemoveListener()

def pcbnew.BOARD.RemoveListener (   self,
RemoveListener(BOARD self, BOARD_LISTENER aListener)

Definition at line 18096 of file

◆ RemoveNative()

def pcbnew.BOARD.RemoveNative (   self,
RemoveNative(BOARD self, BOARD_ITEM aBoardItem, REMOVE_MODE aMode=NORMAL)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 17714 of file

Here is the caller graph for this function:

◆ ResetNetHighLight()

def pcbnew.BOARD.ResetNetHighLight (   self)
ResetNetHighLight(BOARD self)

Definition at line 17789 of file

◆ ResolveDRCExclusions()

def pcbnew.BOARD.ResolveDRCExclusions (   self,
ResolveDRCExclusions(BOARD self, bool aCreateMarkers) -> MARKERS

Definition at line 17781 of file

◆ ResolveTextVar()

def pcbnew.BOARD.ResolveTextVar (   self,
ResolveTextVar(BOARD self, wxString token, int aDepth) -> bool

Definition at line 17680 of file

◆ SanitizeNetcodes()

def pcbnew.BOARD.SanitizeNetcodes (   self)
SanitizeNetcodes(BOARD self)

Definition at line 18088 of file

◆ Save()

def pcbnew.BOARD.Save (   self,

Definition at line 18141 of file

◆ SetAreasNetCodesFromNetNames()

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

Definition at line 18027 of file

◆ SetBoardUse()

def pcbnew.BOARD.SetBoardUse (   self,
SetBoardUse(BOARD self, BOARD_USE aUse)

Definition at line 17590 of file

◆ SetCopperLayerCount()

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

Definition at line 17817 of file

◆ SetElementVisibility()

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

Definition at line 17865 of file

◆ SetEnabledLayers()

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

Definition at line 17829 of file

◆ SetFileFormatVersionAtLoad()

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

Definition at line 17694 of file

◆ SetFileName()

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

Definition at line 17610 of file

◆ SetGenerator()

def pcbnew.BOARD.SetGenerator (   self,
SetGenerator(BOARD self, wxString aGenerator)

Definition at line 17702 of file

◆ SetHighLightNet()

def pcbnew.BOARD.SetHighLightNet (   self,
  aMulti = False 
SetHighLightNet(BOARD self, int aNetCode, bool aMulti=False)

Definition at line 17797 of file

◆ SetLayerDescr()

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

Definition at line 17957 of file

◆ SetLayerName()

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

Definition at line 17948 of file

◆ SetLayerType()

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

Definition at line 17965 of file

◆ SetOutlinesChainingEpsilon()

def pcbnew.BOARD.SetOutlinesChainingEpsilon (   self,
SetOutlinesChainingEpsilon(BOARD self, int aValue)

Definition at line 17932 of file

◆ SetPageSettings()

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

Definition at line 17889 of file

◆ SetPlotOptions()

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

Definition at line 17897 of file

◆ SetProject()

def pcbnew.BOARD.SetProject (   self,
  aReferenceOnly = False 
SetProject(BOARD self, PROJECT * aProject, bool aReferenceOnly=False)

Definition at line 17773 of file

◆ SetProperties()

def pcbnew.BOARD.SetProperties (   self,
SetProperties(BOARD self, MAP_STRING_STRING aProps)

Definition at line 17672 of file

◆ SetTentVias()

def pcbnew.BOARD.SetTentVias (   self,
SetTentVias(BOARD self, bool aFlag)

Definition at line 17881 of file

◆ SetTitleBlock()

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

Definition at line 17908 of file

◆ SetUserUnits()

def pcbnew.BOARD.SetUserUnits (   self,
SetUserUnits(BOARD self, EDA_UNITS aUnits)

Definition at line 17916 of file

◆ SetVisibleAlls()

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

Definition at line 17857 of file

◆ SetVisibleElements()

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

Definition at line 17853 of file

◆ SetVisibleLayers()

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

Definition at line 17845 of file

◆ SynchronizeNetsAndNetClasses()

def pcbnew.BOARD.SynchronizeNetsAndNetClasses (   self,
SynchronizeNetsAndNetClasses(BOARD self, bool aResetTrackAndViaSizes)

Definition at line 18019 of file

◆ SynchronizeProperties()

def pcbnew.BOARD.SynchronizeProperties (   self)
SynchronizeProperties(BOARD self)

Definition at line 18023 of file

◆ TestZoneIntersection()

def pcbnew.BOARD.TestZoneIntersection (   self,
TestZoneIntersection(BOARD self, ZONE aZone1, ZONE aZone2) -> bool

Definition at line 18047 of file

◆ Tracks()

def pcbnew.BOARD.Tracks (   self,
    Tracks(BOARD self) -> TRACKS
    Tracks(BOARD self) -> TRACKS

Definition at line 17618 of file

Here is the caller graph for this function:

◆ TracksInNet()

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

Definition at line 18072 of file

◆ UpdateRatsnestExclusions()

def pcbnew.BOARD.UpdateRatsnestExclusions (   self)
UpdateRatsnestExclusions(BOARD self)

Definition at line 17785 of file

◆ UpdateUserUnits()

def pcbnew.BOARD.UpdateUserUnits (   self,
UpdateUserUnits(BOARD self, BOARD_ITEM aItem, KIGFX::VIEW * aView)

Definition at line 17920 of file

◆ Zones()

def pcbnew.BOARD.Zones (   self,
    Zones(BOARD self) -> ZONES
    Zones(BOARD self) -> ZONES

Definition at line 17639 of file

Here is the caller graph for this function:

Member Data Documentation

◆ netclassmap

dictionary pcbnew.BOARD.netclassmap = {k:v for k,v in self.GetNetClasses().items()}

Definition at line 18184 of file

◆ this


Definition at line 18133 of file

Property Documentation

◆ m_LegacyCopperEdgeClearanceLoaded

pcbnew.BOARD.m_LegacyCopperEdgeClearanceLoaded = property(_pcbnew.BOARD_m_LegacyCopperEdgeClearanceLoaded_get, _pcbnew.BOARD_m_LegacyCopperEdgeClearanceLoaded_set, doc=)

Definition at line 17686 of file

◆ m_LegacyDesignSettingsLoaded

pcbnew.BOARD.m_LegacyDesignSettingsLoaded = property(_pcbnew.BOARD_m_LegacyDesignSettingsLoaded_get, _pcbnew.BOARD_m_LegacyDesignSettingsLoaded_set, doc=)

Definition at line 17685 of file

◆ m_LegacyNetclassesLoaded

pcbnew.BOARD.m_LegacyNetclassesLoaded = property(_pcbnew.BOARD_m_LegacyNetclassesLoaded_get, _pcbnew.BOARD_m_LegacyNetclassesLoaded_set, doc=)

Definition at line 17687 of file

◆ m_LegacyVisibleItems

pcbnew.BOARD.m_LegacyVisibleItems = property(_pcbnew.BOARD_m_LegacyVisibleItems_get, _pcbnew.BOARD_m_LegacyVisibleItems_set, doc=)

Definition at line 17684 of file

◆ m_LegacyVisibleLayers

pcbnew.BOARD.m_LegacyVisibleLayers = property(_pcbnew.BOARD_m_LegacyVisibleLayers_get, _pcbnew.BOARD_m_LegacyVisibleLayers_set, doc=)

Definition at line 17683 of file

◆ m_SolderMaskBridges

pcbnew.BOARD.m_SolderMaskBridges = property(_pcbnew.BOARD_m_SolderMaskBridges_get, _pcbnew.BOARD_m_SolderMaskBridges_set, doc=)

Definition at line 18124 of file

◆ m_ZoneBBoxCache

pcbnew.BOARD.m_ZoneBBoxCache = property(_pcbnew.BOARD_m_ZoneBBoxCache_get, _pcbnew.BOARD_m_ZoneBBoxCache_set, doc=)

Definition at line 18123 of file

◆ m_ZoneIsolatedIslandsMap

pcbnew.BOARD.m_ZoneIsolatedIslandsMap = property(_pcbnew.BOARD_m_ZoneIsolatedIslandsMap_get, _pcbnew.BOARD_m_ZoneIsolatedIslandsMap_set, doc=)

Definition at line 18125 of file

◆ thisown

pcbnew.BOARD.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Definition at line 17579 of file

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