KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
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
[legend]

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 Footprints (self)
 
def Zones (self)
 
def Generators (self)
 
def BoardOutline (self, *args)
 
def UpdateBoardOutline (self)
 
def Markers (self)
 
def Drawings (self, *args)
 
def Tracks (self, *args)
 
def GetItemSet (self)
 
def Groups (self)
 
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 RemoveAll (self, *args)
 
def BulkRemoveStaleTeardrops (self, aCommit)
 
def FinalizeBulkAdd (self, aNewItems)
 
def FinalizeBulkRemove (self, aRemovedItems)
 
def FixupEmbeddedData (self)
 
def RunOnNestedEmbeddedFiles (self, aFunction)
 
def CacheTriangulation (self, *args)
 
def GetFirstFootprint (self)
 
def DeleteAllFootprints (self)
 
def DetachAllFootprints (self)
 
def ResolveItem (self, aID, aAllowNullptrReturn=False)
 
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 RecordDRCExclusions (self)
 
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 GetUserDefinedLayerCount (self)
 
def SetUserDefinedLayerCount (self, aCount)
 
def GetCopperLayerStackMaxId (self)
 
def FlipLayer (self, aLayer)
 
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 SetDesignSettings (self, aSettings)
 
def GetStackupOrDefault (self)
 
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, aIncludeNPTHAsOutlines=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 IsFrontLayer (self, aLayer)
 
def IsBackLayer (self, 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 MatchDpSuffix (self, aNetName, aComplementNet)
 
def DpCoupledNet (self, aNet)
 
def GetNetInfo (self)
 
def RemoveUnusedNets (self, aCommit)
 
def GetNetCount (self)
 
def GetPadWithPressFitAttrCount (self)
 
def GetPadWithCastellatedAttrCount (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 SynchronizeComponentClasses (self, aNewSheetPaths)
 
def SynchronizeProperties (self)
 
def SynchronizeTimeDomainProperties (self)
 
def GetClass (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 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 OnItemsCompositeUpdate (self, aAddedItems, aRemovedItems, aChangedItems)
 
def OnRatsnestChanged (self)
 
def GroupsSanityCheck (self, repair=False)
 
def GroupsSanityCheckInternal (self, repair)
 
def LegacyTeardrops (self)
 
def SetLegacyTeardrops (self, aFlag)
 
def GetEmbeddedFiles (self, *args)
 
def SetEmbeddedFilesDelegate (self, aDelegate)
 
def GetFonts (self)
 
def EmbedFonts (self)
 
def GetLengthCalculation (self)
 
def GetComponentClassManager (self)
 
def ProjectElementType (self)
 
def GetItemByIdCache (self)
 
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 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 CopyFrom (self, aOther)
 
def IsGroupableType (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def HasDrilledHole (self)
 
def IsTented (self, aLayer)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction, aMode)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
def GetLayer (self)
 
def BoardLayerCount (self)
 
def BoardCopperLayerCount (self)
 
def BoardLayerSet (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def IsSideSpecific (self)
 
def SetLayer (self, aLayer)
 
def Duplicate (self, addToParentGroup, aCommit=None)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def GetMaxError (self)
 
def StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipDirection)
 
def Mirror (self, aCentre, aFlipDirection)
 
def Normalize (self)
 
def NormalizeForCompare (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
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 SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetParentGroupId (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetIsRollover (self, aIsRollover)
 
def SetSelected (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearEditFlags (self)
 
def GetTempFlags (self)
 
def ClearTempFlags (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 GetTypeDesc (self)
 
def GetItemDescription (self, aUnitsProvider, aFull)
 
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)
 
def GetEmbeddedFiles (self)
 
def GetEmbeddedFonts (self)
 
def PyGetClass (self)
 
def GetClass (self)
 

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

 this
 

Static Public Attributes

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

Properties

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

Detailed Description

Proxy of C++ BOARD class.

Definition at line 20238 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__() [1/2]

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

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 20243 of file pcbnew.py.

◆ __init__() [2/2]

def pcbnew.BOARD.__init__ (   self,
args 
)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 20918 of file pcbnew.py.

Member Function Documentation

◆ AddArea()

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

◆ AddListener()

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

Definition at line 20835 of file pcbnew.py.

◆ AddNative()

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

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

◆ BoardOutline()

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

Definition at line 20292 of file pcbnew.py.

Here is the caller graph for this function:

◆ BuildConnectivity()

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

Definition at line 20448 of file pcbnew.py.

◆ BuildListOfNets()

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

Definition at line 20695 of file pcbnew.py.

◆ BulkRemoveStaleTeardrops()

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

Definition at line 20392 of file pcbnew.py.

◆ CacheTriangulation()

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

Definition at line 20412 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 20248 of file pcbnew.py.

◆ ClearProject()

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

Definition at line 20467 of file pcbnew.py.

◆ ComputeBoundingBox()

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

Definition at line 20734 of file pcbnew.py.

◆ ConvertBrdLayerToPolygonalContours()

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

Definition at line 20646 of file pcbnew.py.

◆ ConvertCrossReferencesToKIIDs()

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

Definition at line 20436 of file pcbnew.py.

◆ ConvertKIIDsToCrossReferences()

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

Definition at line 20440 of file pcbnew.py.

◆ DeleteAllFootprints()

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

Definition at line 20420 of file pcbnew.py.

◆ DeleteMARKERs()

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

Definition at line 20452 of file pcbnew.py.

Here is the caller graph for this function:

◆ DetachAllFootprints()

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

Definition at line 20424 of file pcbnew.py.

◆ DpCoupledNet()

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

Definition at line 20710 of file pcbnew.py.

◆ Drawings()

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

Definition at line 20307 of file pcbnew.py.

Here is the caller graph for this function:

◆ EmbedFonts()

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

Definition at line 20894 of file pcbnew.py.

◆ FillItemMap()

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

◆ FinalizeBulkAdd()

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

Definition at line 20396 of file pcbnew.py.

◆ FinalizeBulkRemove()

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

Definition at line 20400 of file pcbnew.py.

◆ FindFootprintByPath()

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

Definition at line 20746 of file pcbnew.py.

◆ FindFootprintByReference()

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

Definition at line 20742 of file pcbnew.py.

◆ FindNet()

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

Definition at line 20699 of file pcbnew.py.

Here is the caller graph for this function:

◆ FixupEmbeddedData()

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

Definition at line 20404 of file pcbnew.py.

◆ FlipLayer()

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

Definition at line 20527 of file pcbnew.py.

◆ Footprints()

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

Definition at line 20280 of file pcbnew.py.

Here is the caller graph for this function:

◆ Generators()

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

Definition at line 20288 of file pcbnew.py.

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

◆ GetArea()

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

Definition at line 20778 of file pcbnew.py.

◆ GetAreaCount()

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

Definition at line 20786 of file pcbnew.py.

◆ GetBoardEdgesBoundingBox()

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

Definition at line 20738 of file pcbnew.py.

◆ GetBoardPolygonOutlines()

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

◆ GetBoardUse()

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

Definition at line 20256 of file pcbnew.py.

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 20770 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetComponentClassManager()

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

Definition at line 20902 of file pcbnew.py.

◆ GetConnectivity()

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

Definition at line 20444 of file pcbnew.py.

◆ GetContextualTextVars()

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

Definition at line 20341 of file pcbnew.py.

◆ GetCopperLayerCount()

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

Definition at line 20507 of file pcbnew.py.

◆ GetCopperLayerStackMaxId()

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

Definition at line 20523 of file pcbnew.py.

◆ GetCurrentNetClassName()

def pcbnew.BOARD.GetCurrentNetClassName (   self)

Definition at line 20938 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetDesignSettings()

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

Definition at line 20583 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetDrawings()

def pcbnew.BOARD.GetDrawings (   self)

Definition at line 20929 of file pcbnew.py.

◆ GetEmbeddedFiles()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 20879 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetEnabledLayers()

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

Definition at line 20535 of file pcbnew.py.

◆ GetFileFormatVersionAtLoad()

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

Definition at line 20363 of file pcbnew.py.

◆ GetFileName()

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

Definition at line 20276 of file pcbnew.py.

◆ GetFirstFootprint()

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

Definition at line 20416 of file pcbnew.py.

◆ GetFonts()

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

◆ GetFootprint()

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

◆ GetFootprints()

def pcbnew.BOARD.GetFootprints (   self)

Definition at line 20928 of file pcbnew.py.

◆ GetGenerator()

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

Definition at line 20371 of file pcbnew.py.

◆ GetHighLightNetCodes()

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

Definition at line 20487 of file pcbnew.py.

◆ GetItemByIdCache()

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

Definition at line 20910 of file pcbnew.py.

◆ GetItemSet()

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

Definition at line 20321 of file pcbnew.py.

◆ GetLayerID()

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

Definition at line 20650 of file pcbnew.py.

◆ GetLayerName()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 20654 of file pcbnew.py.

◆ GetLayerType()

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

Definition at line 20679 of file pcbnew.py.

◆ GetLengthCalculation()

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

Definition at line 20898 of file pcbnew.py.

◆ GetMaxClearanceValue()

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

Definition at line 20823 of file pcbnew.py.

◆ GetNetClassAssignmentCandidates()

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

Definition at line 20750 of file pcbnew.py.

◆ GetNetClasses()

def pcbnew.BOARD.GetNetClasses (   self)

Definition at line 20935 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetNetcodeFromNetname()

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

Definition at line 20959 of file pcbnew.py.

◆ GetNetCount()

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

Definition at line 20722 of file pcbnew.py.

◆ GetNetInfo()

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

Definition at line 20714 of file pcbnew.py.

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

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

◆ GetNodesCount()

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

Definition at line 20687 of file pcbnew.py.

◆ GetOutlinesChainingEpsilon()

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

Definition at line 20638 of file pcbnew.py.

◆ GetPad()

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

Here is the caller graph for this function:

◆ GetPads()

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

Definition at line 20691 of file pcbnew.py.

◆ GetPadWithCastellatedAttrCount()

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

Definition at line 20730 of file pcbnew.py.

◆ GetPadWithPressFitAttrCount()

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

Definition at line 20726 of file pcbnew.py.

◆ GetPageSettings()

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

Definition at line 20595 of file pcbnew.py.

◆ GetPlotOptions()

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

Definition at line 20603 of file pcbnew.py.

◆ GetProject()

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

Definition at line 20459 of file pcbnew.py.

◆ GetProperties()

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

Definition at line 20333 of file pcbnew.py.

◆ GetSortedPadListByXthenYCoord()

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

Definition at line 20807 of file pcbnew.py.

◆ GetStackupOrDefault()

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

Definition at line 20591 of file pcbnew.py.

◆ GetStandardLayerName()

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

Definition at line 20663 of file pcbnew.py.

◆ GetTimeStamp()

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

Definition at line 20264 of file pcbnew.py.

◆ GetTitleBlock()

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

Definition at line 20611 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetTrackLength()

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

Definition at line 20811 of file pcbnew.py.

◆ GetTracks()

def pcbnew.BOARD.GetTracks (   self)

Definition at line 20930 of file pcbnew.py.

◆ GetTrackWidthList()

def pcbnew.BOARD.GetTrackWidthList (   self)

Definition at line 20944 of file pcbnew.py.

◆ GetUserDefinedLayerCount()

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

Definition at line 20515 of file pcbnew.py.

◆ GetUserUnits()

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

Definition at line 20622 of file pcbnew.py.

◆ GetViasDimensionsList()

def pcbnew.BOARD.GetViasDimensionsList (   self)

Definition at line 20941 of file pcbnew.py.

◆ GetVisibleElements()

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

Definition at line 20559 of file pcbnew.py.

◆ GetVisibleLayers()

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

Definition at line 20551 of file pcbnew.py.

◆ GetZoneList()

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

Definition at line 20782 of file pcbnew.py.

◆ Groups()

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

Definition at line 20325 of file pcbnew.py.

◆ GroupsSanityCheck()

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

Definition at line 20863 of file pcbnew.py.

◆ GroupsSanityCheckInternal()

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

Definition at line 20867 of file pcbnew.py.

◆ HighLightOFF()

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

Definition at line 20503 of file pcbnew.py.

◆ HighLightON()

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

Definition at line 20499 of file pcbnew.py.

◆ IncrementTimeStamp()

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

Definition at line 20260 of file pcbnew.py.

◆ IsBackLayer()

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

Definition at line 20675 of file pcbnew.py.

◆ IsElementVisible()

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

Definition at line 20571 of file pcbnew.py.

◆ IsEmpty()

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

Definition at line 20355 of file pcbnew.py.

◆ IsFootprintHolder()

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

Definition at line 20268 of file pcbnew.py.

◆ IsFootprintLayerVisible()

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

Definition at line 20579 of file pcbnew.py.

◆ IsFrontLayer()

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

Definition at line 20671 of file pcbnew.py.

◆ IsHighLightNetON()

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

Definition at line 20495 of file pcbnew.py.

◆ IsLayerEnabled()

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

Definition at line 20543 of file pcbnew.py.

◆ IsLayerVisible()

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

Definition at line 20547 of file pcbnew.py.

◆ LayerDepth()

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

Definition at line 20531 of file pcbnew.py.

◆ LegacyTeardrops()

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

Definition at line 20871 of file pcbnew.py.

◆ MapNets()

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

Definition at line 20827 of file pcbnew.py.

◆ Markers()

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

Definition at line 20303 of file pcbnew.py.

◆ MatchDpSuffix()

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

Definition at line 20706 of file pcbnew.py.

◆ OnItemChanged()

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

Definition at line 20847 of file pcbnew.py.

◆ OnItemsChanged()

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

Definition at line 20851 of file pcbnew.py.

◆ OnItemsCompositeUpdate()

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

◆ OnRatsnestChanged()

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

Definition at line 20859 of file pcbnew.py.

◆ ProjectElementType()

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

Definition at line 20906 of file pcbnew.py.

◆ RecordDRCExclusions()

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

Definition at line 20475 of file pcbnew.py.

◆ RemoveAll()

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

Here is the caller graph for this function:

◆ RemoveAllListeners()

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

Definition at line 20843 of file pcbnew.py.

◆ RemoveListener()

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

Definition at line 20839 of file pcbnew.py.

◆ RemoveNative()

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

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 20379 of file pcbnew.py.

Here is the caller graph for this function:

◆ RemoveUnusedNets()

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

Definition at line 20718 of file pcbnew.py.

◆ ResetNetHighLight()

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

Definition at line 20483 of file pcbnew.py.

◆ ResolveDRCExclusions()

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

Definition at line 20471 of file pcbnew.py.

◆ ResolveItem()

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

Definition at line 20428 of file pcbnew.py.

◆ ResolveTextVar()

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

Definition at line 20345 of file pcbnew.py.

◆ RunOnNestedEmbeddedFiles()

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

Definition at line 20408 of file pcbnew.py.

◆ SanitizeNetcodes()

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

Definition at line 20831 of file pcbnew.py.

◆ Save()

def pcbnew.BOARD.Save (   self,
  filename 
)

Definition at line 20932 of file pcbnew.py.

◆ SetAreasNetCodesFromNetNames()

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

Definition at line 20774 of file pcbnew.py.

◆ SetBoardUse()

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

Definition at line 20252 of file pcbnew.py.

◆ SetCopperLayerCount()

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

Definition at line 20511 of file pcbnew.py.

◆ SetDesignSettings()

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

Definition at line 20587 of file pcbnew.py.

◆ SetElementVisibility()

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

Definition at line 20575 of file pcbnew.py.

◆ SetEmbeddedFilesDelegate()

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

Definition at line 20886 of file pcbnew.py.

◆ SetEnabledLayers()

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

Definition at line 20539 of file pcbnew.py.

◆ SetFileFormatVersionAtLoad()

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

Definition at line 20359 of file pcbnew.py.

◆ SetFileName()

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

Definition at line 20272 of file pcbnew.py.

◆ SetGenerator()

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

Definition at line 20367 of file pcbnew.py.

◆ SetHighLightNet()

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

Definition at line 20491 of file pcbnew.py.

◆ SetLayerDescr()

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

Definition at line 20667 of file pcbnew.py.

◆ SetLayerName()

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

Definition at line 20658 of file pcbnew.py.

◆ SetLayerType()

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

Definition at line 20683 of file pcbnew.py.

◆ SetLegacyTeardrops()

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

Definition at line 20875 of file pcbnew.py.

◆ SetOutlinesChainingEpsilon()

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

Definition at line 20642 of file pcbnew.py.

◆ SetPageSettings()

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

Definition at line 20599 of file pcbnew.py.

◆ SetPlotOptions()

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

Definition at line 20607 of file pcbnew.py.

◆ SetProject()

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

Definition at line 20463 of file pcbnew.py.

◆ SetProperties()

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

Definition at line 20337 of file pcbnew.py.

◆ SetTitleBlock()

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

Definition at line 20618 of file pcbnew.py.

◆ SetUserDefinedLayerCount()

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

Definition at line 20519 of file pcbnew.py.

◆ SetUserUnits()

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

Definition at line 20626 of file pcbnew.py.

◆ SetVisibleAlls()

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

Definition at line 20567 of file pcbnew.py.

◆ SetVisibleElements()

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

Definition at line 20563 of file pcbnew.py.

◆ SetVisibleLayers()

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

Definition at line 20555 of file pcbnew.py.

◆ SynchronizeComponentClasses()

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

Definition at line 20758 of file pcbnew.py.

◆ SynchronizeNetsAndNetClasses()

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

Definition at line 20754 of file pcbnew.py.

◆ SynchronizeProperties()

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

Definition at line 20762 of file pcbnew.py.

◆ SynchronizeTimeDomainProperties()

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

Definition at line 20766 of file pcbnew.py.

◆ TestZoneIntersection()

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

Definition at line 20794 of file pcbnew.py.

◆ Tracks()

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

Definition at line 20314 of file pcbnew.py.

Here is the caller graph for this function:

◆ TracksInNet()

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

Definition at line 20815 of file pcbnew.py.

◆ UpdateBoardOutline()

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

Definition at line 20299 of file pcbnew.py.

◆ UpdateRatsnestExclusions()

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

Definition at line 20479 of file pcbnew.py.

◆ UpdateUserUnits()

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

Definition at line 20630 of file pcbnew.py.

◆ Zones()

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

Definition at line 20284 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 20975 of file pcbnew.py.

◆ this

pcbnew.BOARD.this

Definition at line 20924 of file pcbnew.py.

Property Documentation

◆ m_LegacyCopperEdgeClearanceLoaded

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

Definition at line 20351 of file pcbnew.py.

◆ m_LegacyDesignSettingsLoaded

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

Definition at line 20350 of file pcbnew.py.

◆ m_LegacyNetclassesLoaded

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

Definition at line 20352 of file pcbnew.py.

◆ m_LegacyVisibleItems

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

Definition at line 20349 of file pcbnew.py.

◆ m_LegacyVisibleLayers

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

Definition at line 20348 of file pcbnew.py.

◆ m_maxClearanceValue

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

Definition at line 20914 of file pcbnew.py.

◆ m_SolderMaskBridges

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

Definition at line 20915 of file pcbnew.py.

◆ m_ZoneBBoxCache

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

Definition at line 20913 of file pcbnew.py.

◆ m_ZoneIsolatedIslandsMap

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

Definition at line 20916 of file pcbnew.py.

◆ thisown

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

Definition at line 20241 of file pcbnew.py.


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