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 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 RunOnDescendants (self, aFunction, aDepth=0)
 
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 HasItemsOnLayer (self, aLayer)
 
def RemoveAllItemsOnLayer (self, aLayer)
 
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 GetItem (self, aID)
 
def FillItemMap (self, aMap)
 
def ConvertCrossReferencesToKIIDs (self, aSource)
 
def ConvertKIIDsToCrossReferences (self, aSource)
 
def GetConnectivity (self)
 
def BuildConnectivity (self, aReporter=None)
 
def DeleteMARKERs (self, *args)
 
def GetProject (self)
 
def SetProject (self, aProject, aReferenceOnly=False)
 
def ClearProject (self)
 
def ResolveDRCExclusions (self, aCreateMarkers)
 
def 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 InvalidateClearanceCache (self, aUuid)
 
def InitializeClearanceCache (self)
 
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, aRenderSettings=None)
 
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 ComputeBoundingBox (self, aBoardEdgesOnly=False)
 
def GetBoardEdgesBoundingBox (self)
 
def FindFootprintByReference (self, aReference)
 
def FindFootprintByPath (self, aPath)
 
def GetNetClassAssignmentCandidates (self)
 
def SynchronizeNetsAndNetClasses (self, aResetTrackAndViaSizes)
 
def SynchronizeProperties (self)
 
def GetClass (self)
 
def SetAreasNetCodesFromNetNames (self)
 
def GetArea (self, index)
 
def GetZoneList (self, aIncludeZonesInFootprints=False)
 
def GetAreaCount (self)
 
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 GroupLegalOps (self, selection)
 
def LegacyTeardrops (self)
 
def SetLegacyTeardrops (self, aFlag)
 
def GetEmbeddedFiles (self, *args)
 
def SetEmbeddedFilesDelegate (self, aDelegate)
 
def GetFonts (self)
 
def EmbedFonts (self)
 
def GetComponentClassManager (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 SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def 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)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
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)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
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 Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
def __init__ (self, *args, **kwargs)
 
def Type (self)
 
def GetParent (self)
 
def SetParent (self, aParent)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def 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 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 19734 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 19739 of file pcbnew.py.

◆ __init__() [2/2]

def pcbnew.BOARD.__init__ (   self,
args 
)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 20391 of file pcbnew.py.

Member Function Documentation

◆ AddListener()

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

Definition at line 20316 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 19864 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 19814 of file pcbnew.py.

◆ BuildConnectivity()

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

Definition at line 19945 of file pcbnew.py.

◆ BuildListOfNets()

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

Definition at line 20196 of file pcbnew.py.

◆ BulkRemoveStaleTeardrops()

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

Definition at line 19889 of file pcbnew.py.

◆ CacheTriangulation()

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

Definition at line 19909 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 19744 of file pcbnew.py.

◆ ClearProject()

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

Definition at line 19964 of file pcbnew.py.

◆ ComputeBoundingBox()

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

Definition at line 20227 of file pcbnew.py.

◆ ConvertBrdLayerToPolygonalContours()

def pcbnew.BOARD.ConvertBrdLayerToPolygonalContours (   self,
  aLayer,
  aOutlines,
  aRenderSettings = None 
)
ConvertBrdLayerToPolygonalContours(BOARD self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aOutlines, KIGFX::RENDER_SETTINGS * aRenderSettings=None)

Definition at line 20147 of file pcbnew.py.

◆ ConvertCrossReferencesToKIIDs()

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

Definition at line 19933 of file pcbnew.py.

◆ ConvertKIIDsToCrossReferences()

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

Definition at line 19937 of file pcbnew.py.

◆ DeleteAllFootprints()

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

Definition at line 19917 of file pcbnew.py.

◆ DeleteMARKERs()

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

Definition at line 19949 of file pcbnew.py.

Here is the caller graph for this function:

◆ DetachAllFootprints()

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

Definition at line 19921 of file pcbnew.py.

◆ DpCoupledNet()

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

Definition at line 20211 of file pcbnew.py.

◆ Drawings()

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

Definition at line 19792 of file pcbnew.py.

Here is the caller graph for this function:

◆ EmbedFonts()

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

Definition at line 20379 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 19929 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 19893 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 19897 of file pcbnew.py.

◆ FindFootprintByPath()

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

Definition at line 20239 of file pcbnew.py.

◆ FindFootprintByReference()

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

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

Here is the caller graph for this function:

◆ FixupEmbeddedData()

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

Definition at line 19901 of file pcbnew.py.

◆ FlipLayer()

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

Definition at line 20024 of file pcbnew.py.

◆ Footprints()

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

Definition at line 19776 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 19784 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 20439 of file pcbnew.py.

◆ GetArea()

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

Definition at line 20263 of file pcbnew.py.

◆ GetAreaCount()

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

Definition at line 20271 of file pcbnew.py.

◆ GetBoardEdgesBoundingBox()

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

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

◆ GetBoardUse()

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

Definition at line 19752 of file pcbnew.py.

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

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

◆ GetConnectivity()

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

Definition at line 19941 of file pcbnew.py.

◆ GetContextualTextVars()

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

Definition at line 19826 of file pcbnew.py.

◆ GetCopperLayerCount()

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

Definition at line 20004 of file pcbnew.py.

◆ GetCopperLayerStackMaxId()

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

Definition at line 20020 of file pcbnew.py.

◆ GetCurrentNetClassName()

def pcbnew.BOARD.GetCurrentNetClassName (   self)

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

Here is the caller graph for this function:

◆ GetDrawings()

def pcbnew.BOARD.GetDrawings (   self)

Definition at line 20402 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 20364 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 20032 of file pcbnew.py.

◆ GetFileFormatVersionAtLoad()

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

Definition at line 19852 of file pcbnew.py.

◆ GetFileName()

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

Definition at line 19772 of file pcbnew.py.

◆ GetFirstFootprint()

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

Definition at line 19913 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 20375 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 20300 of file pcbnew.py.

◆ GetFootprints()

def pcbnew.BOARD.GetFootprints (   self)

Definition at line 20401 of file pcbnew.py.

◆ GetGenerator()

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

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

◆ GetItem()

def pcbnew.BOARD.GetItem (   self,
  aID 
)
GetItem(BOARD self, KIID aID) -> BOARD_ITEM

Definition at line 19925 of file pcbnew.py.

◆ GetItemSet()

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

Definition at line 19806 of file pcbnew.py.

◆ GetLayerID()

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

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

◆ GetLayerType()

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

Definition at line 20180 of file pcbnew.py.

◆ GetMaxClearanceValue()

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

Definition at line 20304 of file pcbnew.py.

◆ GetNetClassAssignmentCandidates()

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

Definition at line 20243 of file pcbnew.py.

◆ GetNetClasses()

def pcbnew.BOARD.GetNetClasses (   self)

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

◆ GetNetCount()

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

Definition at line 20223 of file pcbnew.py.

◆ GetNetInfo()

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

Definition at line 20215 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 20420 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 20426 of file pcbnew.py.

◆ GetNodesCount()

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

Definition at line 20188 of file pcbnew.py.

◆ GetOutlinesChainingEpsilon()

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

Definition at line 20139 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 20279 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 20192 of file pcbnew.py.

◆ GetPageSettings()

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

Definition at line 20096 of file pcbnew.py.

◆ GetPlotOptions()

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

Definition at line 20104 of file pcbnew.py.

◆ GetProject()

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

Definition at line 19956 of file pcbnew.py.

◆ GetProperties()

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

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

◆ GetStackupOrDefault()

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

Definition at line 20092 of file pcbnew.py.

◆ GetStandardLayerName()

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

Definition at line 20164 of file pcbnew.py.

◆ GetTimeStamp()

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

Definition at line 19760 of file pcbnew.py.

◆ GetTitleBlock()

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

Definition at line 20112 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 >

Definition at line 20292 of file pcbnew.py.

◆ GetTracks()

def pcbnew.BOARD.GetTracks (   self)

Definition at line 20403 of file pcbnew.py.

◆ GetTrackWidthList()

def pcbnew.BOARD.GetTrackWidthList (   self)

Definition at line 20417 of file pcbnew.py.

◆ GetUserDefinedLayerCount()

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

Definition at line 20012 of file pcbnew.py.

◆ GetUserUnits()

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

Definition at line 20123 of file pcbnew.py.

◆ GetViasDimensionsList()

def pcbnew.BOARD.GetViasDimensionsList (   self)

Definition at line 20414 of file pcbnew.py.

◆ GetVisibleElements()

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

Definition at line 20056 of file pcbnew.py.

◆ GetVisibleLayers()

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

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

◆ GroupLegalOps()

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

Definition at line 20352 of file pcbnew.py.

◆ Groups()

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

Definition at line 19810 of file pcbnew.py.

◆ GroupsSanityCheck()

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

Definition at line 20344 of file pcbnew.py.

◆ GroupsSanityCheckInternal()

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

Definition at line 20348 of file pcbnew.py.

◆ HasItemsOnLayer()

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

Definition at line 19881 of file pcbnew.py.

◆ HighLightOFF()

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

Definition at line 20000 of file pcbnew.py.

◆ HighLightON()

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

Definition at line 19996 of file pcbnew.py.

◆ IncrementTimeStamp()

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

Definition at line 19756 of file pcbnew.py.

◆ InitializeClearanceCache()

def pcbnew.BOARD.InitializeClearanceCache (   self)
InitializeClearanceCache(BOARD self)

Definition at line 20088 of file pcbnew.py.

◆ InvalidateClearanceCache()

def pcbnew.BOARD.InvalidateClearanceCache (   self,
  aUuid 
)
InvalidateClearanceCache(BOARD self, KIID aUuid)

Definition at line 20084 of file pcbnew.py.

◆ IsBackLayer()

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

Definition at line 20176 of file pcbnew.py.

◆ IsElementVisible()

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

Definition at line 20068 of file pcbnew.py.

◆ IsEmpty()

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

Definition at line 19840 of file pcbnew.py.

◆ IsFootprintHolder()

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

Definition at line 19764 of file pcbnew.py.

◆ IsFootprintLayerVisible()

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

Definition at line 20076 of file pcbnew.py.

◆ IsFrontLayer()

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

Definition at line 20172 of file pcbnew.py.

◆ IsHighLightNetON()

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

Definition at line 19992 of file pcbnew.py.

◆ IsLayerEnabled()

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

Definition at line 20040 of file pcbnew.py.

◆ IsLayerVisible()

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

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

◆ LegacyTeardrops()

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

Definition at line 20356 of file pcbnew.py.

◆ MapNets()

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

Definition at line 20308 of file pcbnew.py.

◆ Markers()

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

Definition at line 19788 of file pcbnew.py.

◆ MatchDpSuffix()

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

Definition at line 20207 of file pcbnew.py.

◆ OnItemChanged()

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

Definition at line 20328 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 20332 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 20336 of file pcbnew.py.

◆ OnRatsnestChanged()

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

Definition at line 20340 of file pcbnew.py.

◆ RecordDRCExclusions()

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

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

Here is the caller graph for this function:

◆ RemoveAllItemsOnLayer()

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

Definition at line 19885 of file pcbnew.py.

◆ RemoveAllListeners()

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

Definition at line 20324 of file pcbnew.py.

◆ RemoveListener()

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

Definition at line 20320 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 19868 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 20219 of file pcbnew.py.

◆ ResetNetHighLight()

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

Definition at line 19980 of file pcbnew.py.

◆ ResolveDRCExclusions()

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

Definition at line 19968 of file pcbnew.py.

◆ ResolveTextVar()

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

Definition at line 19830 of file pcbnew.py.

◆ RunOnDescendants()

def pcbnew.BOARD.RunOnDescendants (   self,
  aFunction,
  aDepth = 0 
)
RunOnDescendants(BOARD self, std::function< void (BOARD_ITEM *) > const & aFunction, int aDepth=0)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 19844 of file pcbnew.py.

◆ RunOnNestedEmbeddedFiles()

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

Definition at line 19905 of file pcbnew.py.

◆ SanitizeNetcodes()

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

Definition at line 20312 of file pcbnew.py.

◆ Save()

def pcbnew.BOARD.Save (   self,
  filename 
)

Definition at line 20405 of file pcbnew.py.

◆ SetAreasNetCodesFromNetNames()

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

Definition at line 20259 of file pcbnew.py.

◆ SetBoardUse()

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

Definition at line 19748 of file pcbnew.py.

◆ SetCopperLayerCount()

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

Definition at line 20008 of file pcbnew.py.

◆ SetElementVisibility()

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

Definition at line 20072 of file pcbnew.py.

◆ SetEmbeddedFilesDelegate()

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

Definition at line 20371 of file pcbnew.py.

◆ SetEnabledLayers()

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

Definition at line 20036 of file pcbnew.py.

◆ SetFileFormatVersionAtLoad()

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

Definition at line 19848 of file pcbnew.py.

◆ SetFileName()

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

Definition at line 19768 of file pcbnew.py.

◆ SetGenerator()

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

Definition at line 19856 of file pcbnew.py.

◆ SetHighLightNet()

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

Definition at line 19988 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 20168 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 20159 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 20184 of file pcbnew.py.

◆ SetLegacyTeardrops()

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

Definition at line 20360 of file pcbnew.py.

◆ SetOutlinesChainingEpsilon()

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

Definition at line 20143 of file pcbnew.py.

◆ SetPageSettings()

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

Definition at line 20100 of file pcbnew.py.

◆ SetPlotOptions()

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

Definition at line 20108 of file pcbnew.py.

◆ SetProject()

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

Definition at line 19960 of file pcbnew.py.

◆ SetProperties()

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

Definition at line 19822 of file pcbnew.py.

◆ SetTitleBlock()

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

Definition at line 20119 of file pcbnew.py.

◆ SetUserDefinedLayerCount()

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

Definition at line 20016 of file pcbnew.py.

◆ SetUserUnits()

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

Definition at line 20127 of file pcbnew.py.

◆ SetVisibleAlls()

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

Definition at line 20064 of file pcbnew.py.

◆ SetVisibleElements()

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

Definition at line 20060 of file pcbnew.py.

◆ SetVisibleLayers()

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

Definition at line 20052 of file pcbnew.py.

◆ SynchronizeNetsAndNetClasses()

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

Definition at line 20247 of file pcbnew.py.

◆ SynchronizeProperties()

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

Definition at line 20251 of file pcbnew.py.

◆ TestZoneIntersection()

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

Definition at line 20275 of file pcbnew.py.

◆ Tracks()

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

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

◆ UpdateRatsnestExclusions()

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

Definition at line 19976 of file pcbnew.py.

◆ UpdateUserUnits()

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

Definition at line 20131 of file pcbnew.py.

◆ Zones()

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

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

◆ this

pcbnew.BOARD.this

Definition at line 20397 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 19836 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 19835 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 19837 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 19834 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 19833 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 20387 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 20388 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 20386 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 20389 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 19737 of file pcbnew.py.


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