KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.BOARD Class Reference
Inheritance diagram for pcbnew.BOARD:

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 SetBoardUse (self, aUse)
 
 GetBoardUse (self)
 
 IncrementTimeStamp (self)
 
 GetTimeStamp (self)
 
 IsFootprintHolder (self)
 
 SetFileName (self, aFileName)
 
 GetFileName (self)
 
 Footprints (self)
 
 Zones (self)
 
 Generators (self)
 
 BoardOutline (self, *args)
 
 UpdateBoardOutline (self)
 
 Markers (self)
 
 Points (self)
 
 Drawings (self, *args)
 
 Tracks (self, *args)
 
 GetItemSet (self)
 
 Groups (self)
 
 AllConnectedItems (self)
 
 GetProperties (self)
 
 SetProperties (self, aProps)
 
 GetContextualTextVars (self, aVars)
 
 ResolveTextVar (self, token, aDepth)
 
 IsEmpty (self)
 
 SetFileFormatVersionAtLoad (self, aVersion)
 
 GetFileFormatVersionAtLoad (self)
 
 SetGenerator (self, aGenerator)
 
 GetGenerator (self)
 
 AddNative (self, *args)
 
 RemoveNative (self, *args)
 
 RemoveAll (self, *args)
 
 BulkRemoveStaleTeardrops (self, aCommit)
 
 FinalizeBulkAdd (self, aNewItems)
 
 FinalizeBulkRemove (self, aRemovedItems)
 
 FixupEmbeddedData (self)
 
 RunOnNestedEmbeddedFiles (self, aFunction)
 
 CacheTriangulation (self, *args)
 
 GetFirstFootprint (self)
 
 DeleteAllFootprints (self)
 
 DetachAllFootprints (self)
 
 ResolveItem (self, aID, aAllowNullptrReturn=False)
 
 FillItemMap (self, aMap)
 
 ConvertCrossReferencesToKIIDs (self, aSource)
 
 ConvertKIIDsToCrossReferences (self, aSource)
 
 GetConnectivity (self)
 
 BuildConnectivity (self, aReporter=None)
 
 DeleteMARKERs (self, *args)
 
 GetProject (self)
 
 SetProject (self, aProject, aReferenceOnly=False)
 
 ClearProject (self)
 
 ResolveDRCExclusions (self, aCreateMarkers)
 
 RecordDRCExclusions (self)
 
 UpdateRatsnestExclusions (self)
 
 ResetNetHighLight (self)
 
 GetHighLightNetCodes (self)
 
 SetHighLightNet (self, aNetCode, aMulti=False)
 
 IsHighLightNetON (self)
 
 HighLightON (self, aValue=True)
 
 HighLightOFF (self)
 
 GetCopperLayerCount (self)
 
 SetCopperLayerCount (self, aCount)
 
 GetUserDefinedLayerCount (self)
 
 SetUserDefinedLayerCount (self, aCount)
 
 GetCopperLayerStackMaxId (self)
 
 FlipLayer (self, aLayer)
 
 LayerDepth (self, aStartLayer, aEndLayer)
 
 GetEnabledLayers (self)
 
 SetEnabledLayers (self, aLayerMask)
 
 IsLayerEnabled (self, aLayer)
 
 IsLayerVisible (self, aLayer)
 
 GetVisibleLayers (self)
 
 SetVisibleLayers (self, aLayerMask)
 
 GetVisibleElements (self)
 
 SetVisibleElements (self, aMask)
 
 SetVisibleAlls (self)
 
 IsElementVisible (self, aLayer)
 
 SetElementVisibility (self, aLayer, aNewState)
 
 IsFootprintLayerVisible (self, aLayer)
 
 GetDesignSettings (self)
 
 SetDesignSettings (self, aSettings)
 
 GetStackupOrDefault (self)
 
 GetPageSettings (self)
 
 SetPageSettings (self, aPageSettings)
 
 GetPlotOptions (self)
 
 SetPlotOptions (self, aOptions)
 
 GetTitleBlock (self, *args)
 
 SetTitleBlock (self, aTitleBlock)
 
 GetUserUnits (self)
 
 SetUserUnits (self, aUnits)
 
 UpdateUserUnits (self, aItem, aView)
 
 GetBoardPolygonOutlines (self, aOutlines, aErrorHandler=None, aAllowUseArcsInPolygons=False, aIncludeNPTHAsOutlines=False)
 
 GetOutlinesChainingEpsilon (self)
 
 SetOutlinesChainingEpsilon (self, aValue)
 
 ConvertBrdLayerToPolygonalContours (self, aLayer, aOutlines)
 
 GetLayerID (self, aLayerName)
 
 GetLayerName (self, aLayer)
 
 SetLayerName (self, aLayer, aLayerName)
 
 SetLayerDescr (self, aIndex, aLayer)
 
 IsFrontLayer (self, aLayer)
 
 IsBackLayer (self, aLayer)
 
 GetLayerType (self, aLayer)
 
 SetLayerType (self, aLayer, aLayerType)
 
 GetNodesCount (self, aNet=-1)
 
 GetPads (self)
 
 BuildListOfNets (self)
 
 FindNet (self, *args)
 
 MatchDpSuffix (self, aNetName, aComplementNet)
 
 DpCoupledNet (self, aNet)
 
 GetNetInfo (self)
 
 RemoveUnusedNets (self, aCommit)
 
 GetNetCount (self)
 
 GetPadWithPressFitAttrCount (self)
 
 GetPadWithCastellatedAttrCount (self)
 
 ComputeBoundingBox (self, aBoardEdgesOnly=False)
 
 GetBoardEdgesBoundingBox (self)
 
 FindFootprintByReference (self, aReference)
 
 FindFootprintByPath (self, aPath)
 
 GetNetClassAssignmentCandidates (self)
 
 SynchronizeNetsAndNetClasses (self, aResetTrackAndViaSizes)
 
 SynchronizeComponentClasses (self, aNewSheetPaths)
 
 SynchronizeProperties (self)
 
 SynchronizeTimeDomainProperties (self)
 
 GetClass (self)
 
 SetAreasNetCodesFromNetNames (self)
 
 GetArea (self, index)
 
 GetZoneList (self, aIncludeZonesInFootprints=False)
 
 GetAreaCount (self)
 
 AddArea (self, aNewZonesList, aNetcode, aLayer, aStartPointPosition, aHatch)
 
 TestZoneIntersection (self, aZone1, aZone2)
 
 GetPad (self, *args)
 
 GetSortedPadListByXthenYCoord (self, aVector, aNetCode=-1)
 
 GetTrackLength (self, aTrack)
 
 TracksInNet (self, aNetCode)
 
 GetFootprint (self, aPosition, aActiveLayer, aVisibleOnly, aIgnoreLocked=False)
 
 GetMaxClearanceValue (self)
 
 MapNets (self, aDestBoard)
 
 SanitizeNetcodes (self)
 
 AddListener (self, aListener)
 
 RemoveListener (self, aListener)
 
 RemoveAllListeners (self)
 
 OnItemChanged (self, aItem)
 
 OnItemsChanged (self, aItems)
 
 OnItemsCompositeUpdate (self, aAddedItems, aRemovedItems, aChangedItems)
 
 OnRatsnestChanged (self)
 
 GroupsSanityCheck (self, repair=False)
 
 GroupsSanityCheckInternal (self, repair)
 
 LegacyTeardrops (self)
 
 SetLegacyTeardrops (self, aFlag)
 
 GetEmbeddedFiles (self, *args)
 
 SetEmbeddedFilesDelegate (self, aDelegate)
 
 GetFonts (self)
 
 EmbedFonts (self)
 
 GetLengthCalculation (self)
 
 GetComponentClassManager (self)
 
 ProjectElementType (self)
 
 GetItemByIdCache (self)
 
 __init__ (self, *args)
 
 GetFootprints (self)
 
 GetDrawings (self)
 
 GetTracks (self)
 
 Save (self, filename)
 
 GetNetClasses (self)
 
 GetCurrentNetClassName (self)
 
 GetViasDimensionsList (self)
 
 GetTrackWidthList (self)
 
 GetNetsByName (self)
 
 GetNetsByNetcode (self)
 
 GetNetcodeFromNetname (self, netname)
 
 GetAllNetClasses (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
 __init__ (self, *args, **kwargs)
 
 DeleteNative (self, aItem)
 
 Add (self, item)
 
 Remove (self, item)
 
 Delete (self, item)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
 __init__ (self, *args, **kwargs)
 
 CopyFrom (self, aOther)
 
 IsGroupableType (self)
 
 GetX (self)
 
 GetY (self)
 
 GetCenter (self)
 
 SetX (self, aX)
 
 SetY (self, aY)
 
 IsConnected (self)
 
 Similarity (self, aItem)
 
 __eq__ (self, aItem)
 
 IsOnCopperLayer (self)
 
 HasHole (self)
 
 HasDrilledHole (self)
 
 IsTented (self, aLayer)
 
 GetEffectiveShape (self, *args)
 
 GetEffectiveHoleShape (self)
 
 RunOnChildren (self, aFunction, aMode)
 
 GetParent (self)
 
 GetParentFootprint (self)
 
 GetFPRelativePosition (self)
 
 SetFPRelativePosition (self, aPos)
 
 HasLineStroke (self)
 
 GetStroke (self)
 
 SetStroke (self, aStroke)
 
 GetFontMetrics (self)
 
 GetLayer (self)
 
 BoardLayerCount (self)
 
 BoardCopperLayerCount (self)
 
 BoardLayerSet (self)
 
 GetLayerSet (self)
 
 SetLayerSet (self, aLayers)
 
 IsSideSpecific (self)
 
 SetLayer (self, aLayer)
 
 Duplicate (self, addToParentGroup, aCommit=None)
 
 SwapItemData (self, aImage)
 
 IsOnLayer (self, aLayer)
 
 IsKnockout (self)
 
 SetIsKnockout (self, aKnockout)
 
 GetMaxError (self)
 
 StyleFromSettings (self, settings)
 
 DeleteStructure (self)
 
 Move (self, aMoveVector)
 
 Rotate (self, aRotCentre, aAngle)
 
 Flip (self, aCentre, aFlipDirection)
 
 Mirror (self, aCentre, aFlipDirection)
 
 Normalize (self)
 
 NormalizeForCompare (self)
 
 GetBoard (self, *args)
 
 GetParentAsString (self)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
 Cast (self)
 
 Duplicate (self)
 
 SetPos (self, p)
 
 SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
 __init__ (self, *args, **kwargs)
 
 Type (self)
 
 SetParent (self, aParent)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 IsLocked (self)
 
 SetLocked (self, aLocked)
 
 IsModified (self)
 
 IsNew (self)
 
 IsMoving (self)
 
 IsSelected (self)
 
 IsEntered (self)
 
 IsBrightened (self)
 
 IsRollover (self)
 
 SetIsRollover (self, aIsRollover)
 
 SetSelected (self)
 
 SetBrightened (self)
 
 ClearSelected (self)
 
 ClearBrightened (self)
 
 SetModified (self)
 
 SetFlags (self, aMask)
 
 XorFlags (self, aMask)
 
 ClearFlags (self, *args)
 
 GetFlags (self)
 
 HasFlag (self, aFlag)
 
 GetEditFlags (self)
 
 ClearEditFlags (self)
 
 GetTempFlags (self)
 
 ClearTempFlags (self)
 
 RenderAsBitmap (self, aWorldScale)
 
 SetIsShownAsBitmap (self, aBitmap)
 
 IsShownAsBitmap (self)
 
 IsType (self, aScanTypes)
 
 SetForceVisible (self, aEnable)
 
 IsForceVisible (self)
 
 GetMsgPanelInfo (self, aFrame, aList)
 
 GetFriendlyName (self)
 
 HitTest (self, *args)
 
 GetBoundingBox (self)
 
 GetPosition (self)
 
 SetPosition (self, aPos)
 
 GetFocusPosition (self)
 
 GetSortPosition (self)
 
 Clone (self)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (self, aUnitsProvider, aFull)
 
 GetMenuImage (self)
 
 Matches (self, aSearchData, aAuxData)
 
 Replace (self, *args)
 
 IsReplaceable (self)
 
 __lt__ (self, aItem)
 
 ViewBBox (self)
 
 ViewGetLayers (self)
 
 GetEmbeddedFonts (self)
 
 PyGetClass (self)
 

Static Public Member Functions

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

Public Attributes

 this = this
 

Static Public Attributes

dict netclassmap = {k:v for k,v in self.GetNetClasses().items()}
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 DRC = _pcbnew.BOARD_ITEM_DRC
 
 INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Properties

 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_maxClearanceValue = property(_pcbnew.BOARD_m_maxClearanceValue_get, _pcbnew.BOARD_m_maxClearanceValue_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 20450 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__() [1/2]

pcbnew.BOARD.__init__ ( self,
* args,
** kwargs )

Definition at line 20455 of file pcbnew.py.

◆ __init__() [2/2]

pcbnew.BOARD.__init__ ( self,
* args )

Definition at line 21134 of file pcbnew.py.

Member Function Documentation

◆ AddArea()

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

Definition at line 21006 of file pcbnew.py.

◆ AddListener()

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

Definition at line 21051 of file pcbnew.py.

◆ AddNative()

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

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 20591 of file pcbnew.py.

◆ AllConnectedItems()

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

Definition at line 20545 of file pcbnew.py.

◆ BoardOutline()

pcbnew.BOARD.BoardOutline ( self,
* args )
    BoardOutline(BOARD self) -> PCB_BOARD_OUTLINE
    BoardOutline(BOARD self) -> PCB_BOARD_OUTLINE const *

Definition at line 20504 of file pcbnew.py.

◆ BuildConnectivity()

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

Definition at line 20664 of file pcbnew.py.

◆ BuildListOfNets()

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

Definition at line 20911 of file pcbnew.py.

◆ BulkRemoveStaleTeardrops()

pcbnew.BOARD.BulkRemoveStaleTeardrops ( self,
aCommit )
BulkRemoveStaleTeardrops(BOARD self, BOARD_COMMIT & aCommit)

Definition at line 20608 of file pcbnew.py.

◆ CacheTriangulation()

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

Definition at line 20628 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 20460 of file pcbnew.py.

◆ ClearProject()

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

Definition at line 20683 of file pcbnew.py.

◆ ComputeBoundingBox()

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

Definition at line 20950 of file pcbnew.py.

◆ ConvertBrdLayerToPolygonalContours()

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

Definition at line 20862 of file pcbnew.py.

◆ ConvertCrossReferencesToKIIDs()

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

Definition at line 20652 of file pcbnew.py.

◆ ConvertKIIDsToCrossReferences()

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

Definition at line 20656 of file pcbnew.py.

◆ DeleteAllFootprints()

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

Definition at line 20636 of file pcbnew.py.

◆ DeleteMARKERs()

pcbnew.BOARD.DeleteMARKERs ( self,
* args )
    DeleteMARKERs(BOARD self)
    DeleteMARKERs(BOARD self, bool aWarningsAndErrors, bool aExclusions)

Definition at line 20668 of file pcbnew.py.

◆ DetachAllFootprints()

pcbnew.BOARD.DetachAllFootprints ( self)
DetachAllFootprints(BOARD self)

Definition at line 20640 of file pcbnew.py.

◆ DpCoupledNet()

pcbnew.BOARD.DpCoupledNet ( self,
aNet )
DpCoupledNet(BOARD self, NETINFO_ITEM aNet) -> NETINFO_ITEM

Definition at line 20926 of file pcbnew.py.

◆ Drawings()

pcbnew.BOARD.Drawings ( self,
* args )
    Drawings(BOARD self) -> DRAWINGS
    Drawings(BOARD self) -> DRAWINGS

Definition at line 20523 of file pcbnew.py.

◆ EmbedFonts()

pcbnew.BOARD.EmbedFonts ( self)
EmbedFonts(BOARD self)

Definition at line 21110 of file pcbnew.py.

◆ FillItemMap()

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

Definition at line 20648 of file pcbnew.py.

◆ FinalizeBulkAdd()

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

Definition at line 20612 of file pcbnew.py.

◆ FinalizeBulkRemove()

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

Definition at line 20616 of file pcbnew.py.

◆ FindFootprintByPath()

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

Definition at line 20962 of file pcbnew.py.

◆ FindFootprintByReference()

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

Definition at line 20958 of file pcbnew.py.

◆ FindNet()

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

Definition at line 20915 of file pcbnew.py.

◆ FixupEmbeddedData()

pcbnew.BOARD.FixupEmbeddedData ( self)
FixupEmbeddedData(BOARD self)

Definition at line 20620 of file pcbnew.py.

◆ FlipLayer()

pcbnew.BOARD.FlipLayer ( self,
aLayer )
FlipLayer(BOARD self, PCB_LAYER_ID aLayer) -> PCB_LAYER_ID

Definition at line 20743 of file pcbnew.py.

◆ Footprints()

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

Definition at line 20492 of file pcbnew.py.

◆ Generators()

pcbnew.BOARD.Generators ( self)
Generators(BOARD self) -> GENERATORS

Definition at line 20500 of file pcbnew.py.

◆ GetAllNetClasses()

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

◆ GetArea()

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

Definition at line 20994 of file pcbnew.py.

◆ GetAreaCount()

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

Definition at line 21002 of file pcbnew.py.

◆ GetBoardEdgesBoundingBox()

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

Definition at line 20954 of file pcbnew.py.

◆ GetBoardPolygonOutlines()

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

Definition at line 20850 of file pcbnew.py.

◆ GetBoardUse()

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

Definition at line 20468 of file pcbnew.py.

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 20986 of file pcbnew.py.

◆ GetComponentClassManager()

pcbnew.BOARD.GetComponentClassManager ( self)
GetComponentClassManager(BOARD self) -> COMPONENT_CLASS_MANAGER &

Definition at line 21118 of file pcbnew.py.

◆ GetConnectivity()

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

Definition at line 20660 of file pcbnew.py.

◆ GetContextualTextVars()

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

Definition at line 20557 of file pcbnew.py.

◆ GetCopperLayerCount()

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

Definition at line 20723 of file pcbnew.py.

◆ GetCopperLayerStackMaxId()

pcbnew.BOARD.GetCopperLayerStackMaxId ( self)
GetCopperLayerStackMaxId(BOARD self) -> PCB_LAYER_ID

Definition at line 20739 of file pcbnew.py.

◆ GetCurrentNetClassName()

pcbnew.BOARD.GetCurrentNetClassName ( self)

Definition at line 21154 of file pcbnew.py.

◆ GetDesignSettings()

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

Definition at line 20799 of file pcbnew.py.

◆ GetDrawings()

pcbnew.BOARD.GetDrawings ( self)

Definition at line 21145 of file pcbnew.py.

◆ GetEmbeddedFiles()

pcbnew.BOARD.GetEmbeddedFiles ( self,
* args )
    GetEmbeddedFiles(BOARD self) -> EMBEDDED_FILES
    GetEmbeddedFiles(BOARD self) -> EMBEDDED_FILES const *

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 21095 of file pcbnew.py.

◆ GetEnabledLayers()

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

Definition at line 20751 of file pcbnew.py.

◆ GetFileFormatVersionAtLoad()

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

Definition at line 20579 of file pcbnew.py.

◆ GetFileName()

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

Definition at line 20488 of file pcbnew.py.

◆ GetFirstFootprint()

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

Definition at line 20632 of file pcbnew.py.

◆ GetFonts()

pcbnew.BOARD.GetFonts ( self)
GetFonts(BOARD self) -> std::set< KIFONT::OUTLINE_FONT *,std::less< KIFONT::OUTLINE_FONT * >,std::allocator< KIFONT::OUTLINE_FONT * > >

Definition at line 21106 of file pcbnew.py.

◆ GetFootprint()

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

Definition at line 21035 of file pcbnew.py.

◆ GetFootprints()

pcbnew.BOARD.GetFootprints ( self)

Definition at line 21144 of file pcbnew.py.

◆ GetGenerator()

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

Definition at line 20587 of file pcbnew.py.

◆ GetHighLightNetCodes()

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

Definition at line 20703 of file pcbnew.py.

◆ GetItemByIdCache()

pcbnew.BOARD.GetItemByIdCache ( self)
GetItemByIdCache(BOARD self) -> std::unordered_map< KIID,BOARD_ITEM * > const &

Definition at line 21126 of file pcbnew.py.

◆ GetItemSet()

pcbnew.BOARD.GetItemSet ( self)
GetItemSet(BOARD self) -> BOARD_ITEM_SET const

Definition at line 20537 of file pcbnew.py.

◆ GetLayerID()

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

Definition at line 20866 of file pcbnew.py.

◆ GetLayerName()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 20870 of file pcbnew.py.

◆ GetLayerType()

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

Definition at line 20895 of file pcbnew.py.

◆ GetLengthCalculation()

pcbnew.BOARD.GetLengthCalculation ( self)
GetLengthCalculation(BOARD self) -> LENGTH_DELAY_CALCULATION *

Definition at line 21114 of file pcbnew.py.

◆ GetMaxClearanceValue()

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

Definition at line 21039 of file pcbnew.py.

◆ GetNetClassAssignmentCandidates()

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

Definition at line 20966 of file pcbnew.py.

◆ GetNetClasses()

pcbnew.BOARD.GetNetClasses ( self)

Definition at line 21151 of file pcbnew.py.

◆ GetNetcodeFromNetname()

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

Definition at line 21175 of file pcbnew.py.

◆ GetNetCount()

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

Definition at line 20938 of file pcbnew.py.

◆ GetNetInfo()

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

Definition at line 20930 of file pcbnew.py.

◆ GetNetsByName()

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

Definition at line 21163 of file pcbnew.py.

◆ GetNetsByNetcode()

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

Definition at line 21169 of file pcbnew.py.

◆ GetNodesCount()

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

Definition at line 20903 of file pcbnew.py.

◆ GetOutlinesChainingEpsilon()

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

Definition at line 20854 of file pcbnew.py.

◆ GetPad()

pcbnew.BOARD.GetPad ( self,
* args )
    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 21014 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetPads()

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

Definition at line 20907 of file pcbnew.py.

◆ GetPadWithCastellatedAttrCount()

pcbnew.BOARD.GetPadWithCastellatedAttrCount ( self)
GetPadWithCastellatedAttrCount(BOARD self) -> int

Definition at line 20946 of file pcbnew.py.

◆ GetPadWithPressFitAttrCount()

pcbnew.BOARD.GetPadWithPressFitAttrCount ( self)
GetPadWithPressFitAttrCount(BOARD self) -> int

Definition at line 20942 of file pcbnew.py.

◆ GetPageSettings()

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

Definition at line 20811 of file pcbnew.py.

◆ GetPlotOptions()

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

Definition at line 20819 of file pcbnew.py.

◆ GetProject()

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

Definition at line 20675 of file pcbnew.py.

◆ GetProperties()

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

Definition at line 20549 of file pcbnew.py.

◆ GetSortedPadListByXthenYCoord()

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

Definition at line 21023 of file pcbnew.py.

◆ GetStackupOrDefault()

pcbnew.BOARD.GetStackupOrDefault ( self)
GetStackupOrDefault(BOARD self) -> BOARD_STACKUP

Definition at line 20807 of file pcbnew.py.

◆ GetStandardLayerName()

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

Definition at line 20879 of file pcbnew.py.

◆ GetTimeStamp()

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

Definition at line 20476 of file pcbnew.py.

◆ GetTitleBlock()

pcbnew.BOARD.GetTitleBlock ( self,
* args )
    GetTitleBlock(BOARD self) -> TITLE_BLOCK
    GetTitleBlock(BOARD self) -> TITLE_BLOCK

Definition at line 20827 of file pcbnew.py.

◆ GetTrackLength()

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

Definition at line 21027 of file pcbnew.py.

◆ GetTracks()

pcbnew.BOARD.GetTracks ( self)

Definition at line 21146 of file pcbnew.py.

◆ GetTrackWidthList()

pcbnew.BOARD.GetTrackWidthList ( self)

Definition at line 21160 of file pcbnew.py.

◆ GetUserDefinedLayerCount()

pcbnew.BOARD.GetUserDefinedLayerCount ( self)
GetUserDefinedLayerCount(BOARD self) -> int

Definition at line 20731 of file pcbnew.py.

◆ GetUserUnits()

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

Definition at line 20838 of file pcbnew.py.

◆ GetViasDimensionsList()

pcbnew.BOARD.GetViasDimensionsList ( self)

Definition at line 21157 of file pcbnew.py.

◆ GetVisibleElements()

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

Definition at line 20775 of file pcbnew.py.

◆ GetVisibleLayers()

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

Definition at line 20767 of file pcbnew.py.

◆ GetZoneList()

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

Definition at line 20998 of file pcbnew.py.

◆ Groups()

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

Definition at line 20541 of file pcbnew.py.

◆ GroupsSanityCheck()

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

Definition at line 21079 of file pcbnew.py.

◆ GroupsSanityCheckInternal()

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

Definition at line 21083 of file pcbnew.py.

◆ HighLightOFF()

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

Definition at line 20719 of file pcbnew.py.

◆ HighLightON()

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

Definition at line 20715 of file pcbnew.py.

◆ IncrementTimeStamp()

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

Definition at line 20472 of file pcbnew.py.

◆ IsBackLayer()

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

Definition at line 20891 of file pcbnew.py.

◆ IsElementVisible()

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

Definition at line 20787 of file pcbnew.py.

◆ IsEmpty()

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

Definition at line 20571 of file pcbnew.py.

◆ IsFootprintHolder()

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

Definition at line 20480 of file pcbnew.py.

◆ IsFootprintLayerVisible()

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

Definition at line 20795 of file pcbnew.py.

◆ IsFrontLayer()

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

Definition at line 20887 of file pcbnew.py.

◆ IsHighLightNetON()

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

Definition at line 20711 of file pcbnew.py.

◆ IsLayerEnabled()

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

Definition at line 20759 of file pcbnew.py.

◆ IsLayerVisible()

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

Definition at line 20763 of file pcbnew.py.

◆ LayerDepth()

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

Definition at line 20747 of file pcbnew.py.

◆ LegacyTeardrops()

pcbnew.BOARD.LegacyTeardrops ( self)
LegacyTeardrops(BOARD self) -> bool

Definition at line 21087 of file pcbnew.py.

◆ MapNets()

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

Definition at line 21043 of file pcbnew.py.

◆ Markers()

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

Definition at line 20515 of file pcbnew.py.

◆ MatchDpSuffix()

pcbnew.BOARD.MatchDpSuffix ( self,
aNetName,
aComplementNet )
MatchDpSuffix(BOARD self, wxString aNetName, wxString aComplementNet) -> int

Definition at line 20922 of file pcbnew.py.

◆ OnItemChanged()

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

Definition at line 21063 of file pcbnew.py.

◆ OnItemsChanged()

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

Definition at line 21067 of file pcbnew.py.

◆ OnItemsCompositeUpdate()

pcbnew.BOARD.OnItemsCompositeUpdate ( self,
aAddedItems,
aRemovedItems,
aChangedItems )
OnItemsCompositeUpdate(BOARD self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aAddedItems, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aRemovedItems, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aChangedItems)

Definition at line 21071 of file pcbnew.py.

◆ OnRatsnestChanged()

pcbnew.BOARD.OnRatsnestChanged ( self)
OnRatsnestChanged(BOARD self)

Definition at line 21075 of file pcbnew.py.

◆ Points()

pcbnew.BOARD.Points ( self)
Points(BOARD self) -> PCB_POINTS

Definition at line 20519 of file pcbnew.py.

◆ ProjectElementType()

pcbnew.BOARD.ProjectElementType ( self)
ProjectElementType(BOARD self) -> PROJECT::ELEM

Definition at line 21122 of file pcbnew.py.

◆ RecordDRCExclusions()

pcbnew.BOARD.RecordDRCExclusions ( self)
RecordDRCExclusions(BOARD self)

Definition at line 20691 of file pcbnew.py.

◆ RemoveAll()

pcbnew.BOARD.RemoveAll ( self,
* args )
    RemoveAll(BOARD self, std::initializer_list< KICAD_T > aTypes={ PCB_NETINFO_T, PCB_MARKER_T,
                                                                  PCB_GROUP_T, PCB_ZONE_T,
                                                                  PCB_GENERATOR_T, PCB_FOOTPRINT_T,
                                                                  PCB_TRACE_T, PCB_SHAPE_T })

Definition at line 20599 of file pcbnew.py.

◆ RemoveAllListeners()

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

Definition at line 21059 of file pcbnew.py.

◆ RemoveListener()

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

Definition at line 21055 of file pcbnew.py.

◆ RemoveNative()

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

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 20595 of file pcbnew.py.

◆ RemoveUnusedNets()

pcbnew.BOARD.RemoveUnusedNets ( self,
aCommit )
RemoveUnusedNets(BOARD self, BOARD_COMMIT * aCommit)

Definition at line 20934 of file pcbnew.py.

◆ ResetNetHighLight()

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

Definition at line 20699 of file pcbnew.py.

◆ ResolveDRCExclusions()

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

Definition at line 20687 of file pcbnew.py.

◆ ResolveItem()

pcbnew.BOARD.ResolveItem ( self,
aID,
aAllowNullptrReturn = False )
ResolveItem(BOARD self, KIID aID, bool aAllowNullptrReturn=False) -> BOARD_ITEM

Definition at line 20644 of file pcbnew.py.

◆ ResolveTextVar()

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

Definition at line 20561 of file pcbnew.py.

◆ RunOnNestedEmbeddedFiles()

pcbnew.BOARD.RunOnNestedEmbeddedFiles ( self,
aFunction )
RunOnNestedEmbeddedFiles(BOARD self, std::function< void (EMBEDDED_FILES *) > const & aFunction)

Definition at line 20624 of file pcbnew.py.

◆ SanitizeNetcodes()

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

Definition at line 21047 of file pcbnew.py.

◆ Save()

pcbnew.BOARD.Save ( self,
filename )

Definition at line 21148 of file pcbnew.py.

◆ SetAreasNetCodesFromNetNames()

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

Definition at line 20990 of file pcbnew.py.

◆ SetBoardUse()

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

Definition at line 20464 of file pcbnew.py.

◆ SetCopperLayerCount()

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

Definition at line 20727 of file pcbnew.py.

◆ SetDesignSettings()

pcbnew.BOARD.SetDesignSettings ( self,
aSettings )
SetDesignSettings(BOARD self, BOARD_DESIGN_SETTINGS aSettings)

Definition at line 20803 of file pcbnew.py.

◆ SetElementVisibility()

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

Definition at line 20791 of file pcbnew.py.

◆ SetEmbeddedFilesDelegate()

pcbnew.BOARD.SetEmbeddedFilesDelegate ( self,
aDelegate )
SetEmbeddedFilesDelegate(BOARD self, EMBEDDED_FILES * aDelegate)

Definition at line 21102 of file pcbnew.py.

◆ SetEnabledLayers()

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

Definition at line 20755 of file pcbnew.py.

◆ SetFileFormatVersionAtLoad()

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

Definition at line 20575 of file pcbnew.py.

◆ SetFileName()

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

Definition at line 20484 of file pcbnew.py.

◆ SetGenerator()

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

Definition at line 20583 of file pcbnew.py.

◆ SetHighLightNet()

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

Definition at line 20707 of file pcbnew.py.

◆ SetLayerDescr()

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

Definition at line 20883 of file pcbnew.py.

◆ SetLayerName()

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

Definition at line 20874 of file pcbnew.py.

◆ SetLayerType()

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

Definition at line 20899 of file pcbnew.py.

◆ SetLegacyTeardrops()

pcbnew.BOARD.SetLegacyTeardrops ( self,
aFlag )
SetLegacyTeardrops(BOARD self, bool aFlag)

Definition at line 21091 of file pcbnew.py.

◆ SetOutlinesChainingEpsilon()

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

Definition at line 20858 of file pcbnew.py.

◆ SetPageSettings()

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

Definition at line 20815 of file pcbnew.py.

◆ SetPlotOptions()

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

Definition at line 20823 of file pcbnew.py.

◆ SetProject()

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

Definition at line 20679 of file pcbnew.py.

◆ SetProperties()

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

Definition at line 20553 of file pcbnew.py.

◆ SetTitleBlock()

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

Definition at line 20834 of file pcbnew.py.

◆ SetUserDefinedLayerCount()

pcbnew.BOARD.SetUserDefinedLayerCount ( self,
aCount )
SetUserDefinedLayerCount(BOARD self, int aCount)

Definition at line 20735 of file pcbnew.py.

◆ SetUserUnits()

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

Definition at line 20842 of file pcbnew.py.

◆ SetVisibleAlls()

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

Definition at line 20783 of file pcbnew.py.

◆ SetVisibleElements()

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

Definition at line 20779 of file pcbnew.py.

◆ SetVisibleLayers()

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

Definition at line 20771 of file pcbnew.py.

◆ SynchronizeComponentClasses()

pcbnew.BOARD.SynchronizeComponentClasses ( self,
aNewSheetPaths )
SynchronizeComponentClasses(BOARD self, std::unordered_set< wxString > const & aNewSheetPaths) -> bool

Definition at line 20974 of file pcbnew.py.

◆ SynchronizeNetsAndNetClasses()

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

Definition at line 20970 of file pcbnew.py.

◆ SynchronizeProperties()

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

Definition at line 20978 of file pcbnew.py.

◆ SynchronizeTimeDomainProperties()

pcbnew.BOARD.SynchronizeTimeDomainProperties ( self)
SynchronizeTimeDomainProperties(BOARD self)

Definition at line 20982 of file pcbnew.py.

◆ TestZoneIntersection()

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

Definition at line 21010 of file pcbnew.py.

◆ Tracks()

pcbnew.BOARD.Tracks ( self,
* args )
    Tracks(BOARD self) -> TRACKS
    Tracks(BOARD self) -> TRACKS

Definition at line 20530 of file pcbnew.py.

◆ TracksInNet()

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

Definition at line 21031 of file pcbnew.py.

◆ UpdateBoardOutline()

pcbnew.BOARD.UpdateBoardOutline ( self)
UpdateBoardOutline(BOARD self)

Definition at line 20511 of file pcbnew.py.

◆ UpdateRatsnestExclusions()

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

Definition at line 20695 of file pcbnew.py.

◆ UpdateUserUnits()

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

Definition at line 20846 of file pcbnew.py.

◆ Zones()

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

Definition at line 20496 of file pcbnew.py.

Member Data Documentation

◆ netclassmap

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

Definition at line 21191 of file pcbnew.py.

◆ this

pcbnew.BOARD.this = this

Definition at line 21140 of file pcbnew.py.

Property Documentation

◆ m_LegacyCopperEdgeClearanceLoaded

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

Definition at line 20567 of file pcbnew.py.

◆ m_LegacyDesignSettingsLoaded

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

Definition at line 20566 of file pcbnew.py.

◆ m_LegacyNetclassesLoaded

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

Definition at line 20568 of file pcbnew.py.

◆ m_LegacyVisibleItems

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

Definition at line 20565 of file pcbnew.py.

◆ m_LegacyVisibleLayers

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

Definition at line 20564 of file pcbnew.py.

◆ m_maxClearanceValue

pcbnew.BOARD.m_maxClearanceValue = property(_pcbnew.BOARD_m_maxClearanceValue_get, _pcbnew.BOARD_m_maxClearanceValue_set, doc=)
static

Definition at line 21130 of file pcbnew.py.

◆ m_SolderMaskBridges

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

Definition at line 21131 of file pcbnew.py.

◆ m_ZoneBBoxCache

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

Definition at line 21129 of file pcbnew.py.

◆ m_ZoneIsolatedIslandsMap

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

Definition at line 21132 of file pcbnew.py.

◆ thisown

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

Definition at line 20453 of file pcbnew.py.


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