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

Public Member Functions

def __init__ (self, *args, **kwargs)
 
"void" SetBoardUse (self, "BOARD_USE" aUse)
 
"BOARD_USE" GetBoardUse (self)
 
"void" IncrementTimeStamp (self)
 
"int" GetTimeStamp (self)
 
"bool" IsFootprintHolder (self)
 
"void" SetFileName (self, "wxString" aFileName)
 
"wxString const &" GetFileName (self)
 
"TRACKS const &" Tracks (self, *args)
 
"FOOTPRINTS const &" Footprints (self, *args)
 
"DRAWINGS const &" Drawings (self, *args)
 
"ZONES const &" Zones (self, *args)
 
"MARKERS const &" Markers (self, *args)
 
"GROUPS const &" Groups (self, *args)
 
"std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const" AllConnectedItems (self)
 
"std::map< wxString,wxString,std::less< wxString >,std::allocator< std::pair< wxString const,wxString > > > const &" GetProperties (self)
 
"void" SetProperties (self, "MAP_STRING_STRING" aProps)
 
"bool" ResolveTextVar (self, "wxString" token, "int" aDepth)
 
"wxPoint" GetPosition (self)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint const" GetFocusPosition (self)
 
"bool" IsEmpty (self)
 
"void" Move (self, "wxPoint" aMoveVector)
 
"void" SetFileFormatVersionAtLoad (self, "int" aVersion)
 
"int" GetFileFormatVersionAtLoad (self)
 
"void" SetGenerator (self, "wxString" aGenerator)
 
"wxString const &" GetGenerator (self)
 
"void" AddNative (self, *args)
 
"void" RemoveNative (self, *args)
 
"void" FinalizeBulkAdd (self, "std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > &" aNewItems)
 
"void" FinalizeBulkRemove (self, "std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > &" aRemovedItems)
 
"FOOTPRINT *" GetFirstFootprint (self)
 
"void" DeleteAllFootprints (self)
 
"BOARD_ITEM *" GetItem (self, "KIID" aID)
 
"void" FillItemMap (self, "std::map< KIID,EDA_ITEM *,std::less< KIID >,std::allocator< std::pair< KIID const,EDA_ITEM * > > > &" aMap)
 
"wxString" ConvertCrossReferencesToKIIDs (self, "wxString" aSource)
 
"wxString" ConvertKIIDsToCrossReferences (self, "wxString" aSource)
 
"std::shared_ptr< CONNECTIVITY_DATA >" GetConnectivity (self)
 
"void" BuildConnectivity (self, "PROGRESS_REPORTER *" aReporter=None)
 
"void" DeleteMARKERs (self, *args)
 
"PROJECT *" GetProject (self)
 
"void" SetProject (self, "PROJECT *" aProject)
 
"void" ClearProject (self)
 
"std::vector< PCB_MARKER *,std::allocator< PCB_MARKER * > >" ResolveDRCExclusions (self)
 
"void" ResetNetHighLight (self)
 
"std::set< int,std::less< int >,std::allocator< int > > const &" GetHighLightNetCodes (self)
 
"void" SetHighLightNet (self, "int" aNetCode, "bool" aMulti=False)
 
"bool" IsHighLightNetON (self)
 
"void" HighLightON (self, "bool" aValue=True)
 
"void" HighLightOFF (self)
 
"int" GetCopperLayerCount (self)
 
"void" SetCopperLayerCount (self, "int" aCount)
 
"LSET" GetEnabledLayers (self)
 
"void" SetEnabledLayers (self, "LSET" aLayerMask)
 
"bool" IsLayerEnabled (self, "PCB_LAYER_ID" aLayer)
 
"bool" IsLayerVisible (self, "PCB_LAYER_ID" aLayer)
 
"LSET" GetVisibleLayers (self)
 
"void" SetVisibleLayers (self, "LSET" aLayerMask)
 
"GAL_SET" GetVisibleElements (self)
 
"void" SetVisibleElements (self, "GAL_SET" aMask)
 
"void" SetVisibleAlls (self)
 
"bool" IsElementVisible (self, "GAL_LAYER_ID" aLayer)
 
"void" SetElementVisibility (self, "GAL_LAYER_ID" aLayer, "bool" aNewState)
 
"bool" IsFootprintLayerVisible (self, "PCB_LAYER_ID" aLayer)
 
"BOARD_DESIGN_SETTINGS &" GetDesignSettings (self)
 
"ZONE_SETTINGS const &" GetZoneSettings (self)
 
"void" SetZoneSettings (self, "ZONE_SETTINGS" aSettings)
 
"PAGE_INFO const &" GetPageSettings (self)
 
"void" SetPageSettings (self, "PAGE_INFO const &" aPageSettings)
 
"PCB_PLOT_PARAMS const &" GetPlotOptions (self)
 
"void" SetPlotOptions (self, "PCB_PLOT_PARAMS" aOptions)
 
"TITLE_BLOCK const &" GetTitleBlock (self, *args)
 
"void" SetTitleBlock (self, "TITLE_BLOCK" aTitleBlock)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"bool" GetBoardPolygonOutlines (self, "SHAPE_POLY_SET" aOutlines, "OUTLINE_ERROR_HANDLER *" aErrorHandler=None)
 
"void" ConvertBrdLayerToPolygonalContours (self, "PCB_LAYER_ID" aLayer, "SHAPE_POLY_SET" aOutlines)
 
"PCB_LAYER_ID const" GetLayerID (self, "wxString" aLayerName)
 
"wxString const" GetLayerName (self, "PCB_LAYER_ID" aLayer)
 
"bool" SetLayerName (self, "PCB_LAYER_ID" aLayer, "wxString" aLayerName)
 
"bool" SetLayerDescr (self, "PCB_LAYER_ID" aIndex, "LAYER" aLayer)
 
"LAYER_T" GetLayerType (self, "PCB_LAYER_ID" aLayer)
 
"bool" SetLayerType (self, "PCB_LAYER_ID" aLayer, "LAYER_T" aLayerType)
 
"unsigned int" GetNodesCount (self, "int" aNet=-1)
 
"unsigned int" GetUnconnectedNetCount (self)
 
"std::vector< PAD *,std::allocator< PAD * > > const" GetPads (self)
 
"void" BuildListOfNets (self)
 
"NETINFO_ITEM *" FindNet (self, *args)
 
"NETINFO_LIST &" GetNetInfo (self, *args)
 
"unsigned int" GetNetCount (self)
 
"EDA_RECT" ComputeBoundingBox (self, "bool" aBoardEdgesOnly=False)
 
"EDA_RECT const" GetBoundingBox (self)
 
"EDA_RECT const" GetBoardEdgesBoundingBox (self)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"SEARCH_RESULT" Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
 
"FOOTPRINT *" FindFootprintByReference (self, "wxString" aReference)
 
"FOOTPRINT *" FindFootprintByPath (self, "KIID_PATH" aPath)
 
"std::vector< wxString,std::allocator< wxString > >" GetNetClassAssignmentCandidates (self)
 
"void" SynchronizeNetsAndNetClasses (self)
 
"void" SynchronizeProperties (self)
 
"wxString" GetClass (self)
 
"int" SetAreasNetCodesFromNetNames (self)
 
"ZONE *" GetArea (self, "int" index)
 
"std::list< ZONE *,std::allocator< ZONE * > >" GetZoneList (self, "bool" aIncludeZonesInFootprints=False)
 
"int" GetAreaCount (self)
 
"ZONE *" AddArea (self, "PICKED_ITEMS_LIST *" aNewZonesList, "int" aNetcode, "PCB_LAYER_ID" aLayer, "wxPoint" aStartPointPosition, "ZONE_BORDER_DISPLAY_STYLE" aHatch)
 
"bool" TestZoneIntersection (self, "ZONE" aZone1, "ZONE" aZone2)
 
"PAD *" GetPadFast (self, "wxPoint" aPosition, "LSET" aLayerMask)
 
"PAD *" GetPad (self, *args)
 
"void" PadDelete (self, "PAD" aPad)
 
"void" GetSortedPadListByXthenYCoord (self, "PADS_VEC" aVector, "int" aNetCode=-1)
 
"std::tuple< int,double,double >" GetTrackLength (self, "PCB_TRACK" aTrack)
 
"TRACKS" TracksInNet (self, "int" aNetCode)
 
"FOOTPRINT *" GetFootprint (self, "wxPoint" aPosition, "PCB_LAYER_ID" aActiveLayer, "bool" aVisibleOnly, "bool" aIgnoreLocked=False)
 
"void" ClearAllNetCodes (self)
 
"void" MapNets (self, "BOARD" aDestBoard)
 
"void" SanitizeNetcodes (self)
 
"void" AddListener (self, "BOARD_LISTENER" aListener)
 
"void" RemoveListener (self, "BOARD_LISTENER" aListener)
 
"void" OnItemChanged (self, "BOARD_ITEM" aItem)
 
"void" OnItemsChanged (self, "std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > &" aItems)
 
"wxString" GroupsSanityCheck (self, "bool" repair=False)
 
"wxString" GroupsSanityCheckInternal (self, "bool" repair)
 
"BOARD::GroupLegalOpsField" GroupLegalOps (self, "PCB_SELECTION const &" selection)
 
def __init__ (self, *args)
 
def GetFootprints (self)
 
def GetDrawings (self)
 
def GetTracks (self)
 
def Save (self, filename)
 
def GetNetClasses (self)
 
def GetCurrentNetClassName (self)
 
def GetViasDimensionsList (self)
 
def GetTrackWidthList (self)
 
def GetNetsByName (self)
 
def GetNetsByNetcode (self)
 
def GetNetcodeFromNetname (self, netname)
 
def GetAllNetClasses (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
def __init__ (self, *args, **kwargs)
 
"void" AddNative (self, *args)
 
"void" RemoveNative (self, *args)
 
"void" DeleteNative (self, "BOARD_ITEM" aItem)
 
"ZONE_SETTINGS const &" GetZoneSettings (self)
 
"void" SetZoneSettings (self, "ZONE_SETTINGS" aSettings)
 
def Add (self, item)
 
def Remove (self, item)
 
def Delete (self, item)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
"void" SetParentGroup (self, "PCB_GROUP" aGroup)
 
"PCB_GROUP *" GetParentGroup (self)
 
"int" GetX (self)
 
"int" GetY (self)
 
"wxPoint" GetCenter (self)
 
"void" SetX (self, "int" aX)
 
"void" SetY (self, "int" aY)
 
"bool" IsConnected (self)
 
"bool" IsOnCopperLayer (self)
 
"std::shared_ptr< SHAPE >" GetEffectiveShape (self, *args)
 
"BOARD_ITEM_CONTAINER *" GetParent (self)
 
"BOARD_ITEM_CONTAINER *" GetParentFootprint (self)
 
"PCB_LAYER_ID" GetLayer (self)
 
"LSET" GetLayerSet (self)
 
"void" SetLayerSet (self, "LSET" aLayers)
 
"void" SetLayer (self, "PCB_LAYER_ID" aLayer)
 
"BOARD_ITEM *" Duplicate (self)
 
"void" SwapData (self, "BOARD_ITEM" aImage)
 
"bool" IsOnLayer (self, "PCB_LAYER_ID" aLayer)
 
"bool" IsTrack (self)
 
"bool" IsLocked (self)
 
"void" SetLocked (self, "bool" aLocked)
 
"void" DeleteStructure (self)
 
"void" Move (self, *args)
 
"void" Rotate (self, *args)
 
"void" Flip (self, *args)
 
"BOARD *" GetBoard (self, *args)
 
"wxString" GetLayerName (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 
"void" TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" 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)
 
"KICAD_T" Type (self)
 
"EDA_ITEM *" GetParent (self)
 
"void" SetParent (self, "EDA_ITEM" aParent)
 
"bool" IsModified (self)
 
"bool" IsNew (self)
 
"bool" IsMoving (self)
 
"bool" IsDragging (self)
 
"bool" IsWireImage (self)
 
"bool" IsSelected (self)
 
"bool" IsEntered (self)
 
"bool" IsResized (self)
 
"bool" IsBrightened (self)
 
"void" SetWireImage (self)
 
"void" SetSelected (self)
 
"void" SetBrightened (self)
 
"void" ClearSelected (self)
 
"void" ClearBrightened (self)
 
"void" SetModified (self)
 
"int" GetState (self, "EDA_ITEM_FLAGS" type)
 
"void" SetState (self, "EDA_ITEM_FLAGS" type, "bool" state)
 
"EDA_ITEM_FLAGS" GetStatus (self)
 
"void" SetStatus (self, "EDA_ITEM_FLAGS" aStatus)
 
"void" SetFlags (self, "EDA_ITEM_FLAGS" aMask)
 
"void" ClearFlags (self, *args)
 
"EDA_ITEM_FLAGS" GetFlags (self)
 
"bool" HasFlag (self, "EDA_ITEM_FLAGS" aFlag)
 
"EDA_ITEM_FLAGS" GetEditFlags (self)
 
"void" ClearTempFlags (self)
 
"void" ClearEditFlags (self)
 
"bool" IsType (self, "KICAD_T const []" aScanTypes)
 
"void" SetForceVisible (self, "bool" aEnable)
 
"bool" IsForceVisible (self)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"bool" HitTest (self, *args)
 
"EDA_RECT const" GetBoundingBox (self)
 
"wxPoint" GetPosition (self)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint const" GetFocusPosition (self)
 
"EDA_ITEM *" Clone (self)
 
"SEARCH_RESULT" Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
 
"wxString" GetClass (self)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"BITMAPS" GetMenuImage (self)
 
"bool" Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)
 
"bool" Replace (self, *args)
 
"bool" IsReplaceable (self)
 
"bool" __lt__ (self, "EDA_ITEM" aItem)
 
"BOX2I const" ViewBBox (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 

Static Public Member Functions

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

Public Attributes

 this
 

Static Public Attributes

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

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 m_LegacyVisibleLayers = property(_pcbnew.BOARD_m_LegacyVisibleLayers_get, _pcbnew.BOARD_m_LegacyVisibleLayers_set, doc=)
 
 m_LegacyVisibleItems = property(_pcbnew.BOARD_m_LegacyVisibleItems_get, _pcbnew.BOARD_m_LegacyVisibleItems_set, doc=)
 
 m_LegacyDesignSettingsLoaded = property(_pcbnew.BOARD_m_LegacyDesignSettingsLoaded_get, _pcbnew.BOARD_m_LegacyDesignSettingsLoaded_set, doc=)
 
 m_LegacyCopperEdgeClearanceLoaded = property(_pcbnew.BOARD_m_LegacyCopperEdgeClearanceLoaded_get, _pcbnew.BOARD_m_LegacyCopperEdgeClearanceLoaded_set, doc=)
 
 m_LegacyNetclassesLoaded = property(_pcbnew.BOARD_m_LegacyNetclassesLoaded_get, _pcbnew.BOARD_m_LegacyNetclassesLoaded_set, doc=)
 
 m_InsideFCourtyardCache = property(_pcbnew.BOARD_m_InsideFCourtyardCache_get, _pcbnew.BOARD_m_InsideFCourtyardCache_set, doc=)
 
 m_InsideBCourtyardCache = property(_pcbnew.BOARD_m_InsideBCourtyardCache_get, _pcbnew.BOARD_m_InsideBCourtyardCache_set, doc=)
 
 m_LayerExpressionCache = property(_pcbnew.BOARD_m_LayerExpressionCache_get, _pcbnew.BOARD_m_LayerExpressionCache_set, doc=)
 
- Properties inherited from pcbnew.BOARD_ITEM_CONTAINER
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 

Detailed Description

Proxy of C++ BOARD class.

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

◆ __init__() [2/2]

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

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 16935 of file pcbnew.py.

Member Function Documentation

◆ AddArea()

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

Definition at line 16851 of file pcbnew.py.

◆ AddListener()

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

Definition at line 16904 of file pcbnew.py.

◆ AddNative()

"void" pcbnew.BOARD.AddNative (   self,
*  args 
) 
AddNative(BOARD self, BOARD_ITEM aItem, ADD_MODE aMode=INSERT)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 16526 of file pcbnew.py.

Here is the caller graph for this function:

◆ AllConnectedItems()

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

Definition at line 16468 of file pcbnew.py.

◆ BuildConnectivity()

"void" pcbnew.BOARD.BuildConnectivity (   self,
"PROGRESS_REPORTER *"  aReporter = None 
) 
BuildConnectivity(BOARD self, PROGRESS_REPORTER * aReporter=None)

Definition at line 16570 of file pcbnew.py.

◆ BuildListOfNets()

"void" pcbnew.BOARD.BuildListOfNets (   self) 
BuildListOfNets(BOARD self)

Definition at line 16769 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 16394 of file pcbnew.py.

◆ ClearAllNetCodes()

"void" pcbnew.BOARD.ClearAllNetCodes (   self) 
ClearAllNetCodes(BOARD self)

Definition at line 16892 of file pcbnew.py.

◆ ClearProject()

"void" pcbnew.BOARD.ClearProject (   self) 
ClearProject(BOARD self)

Definition at line 16589 of file pcbnew.py.

◆ ComputeBoundingBox()

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

Definition at line 16791 of file pcbnew.py.

◆ ConvertBrdLayerToPolygonalContours()

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

Definition at line 16724 of file pcbnew.py.

◆ ConvertCrossReferencesToKIIDs()

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

Definition at line 16558 of file pcbnew.py.

◆ ConvertKIIDsToCrossReferences()

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

Definition at line 16562 of file pcbnew.py.

◆ DeleteAllFootprints()

"void" pcbnew.BOARD.DeleteAllFootprints (   self) 
DeleteAllFootprints(BOARD self)

Definition at line 16546 of file pcbnew.py.

◆ DeleteMARKERs()

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

Definition at line 16574 of file pcbnew.py.

Here is the caller graph for this function:

◆ Drawings()

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

Definition at line 16440 of file pcbnew.py.

Here is the caller graph for this function:

◆ FillItemMap()

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

Definition at line 16554 of file pcbnew.py.

◆ FinalizeBulkAdd()

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

Definition at line 16534 of file pcbnew.py.

◆ FinalizeBulkRemove()

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

Definition at line 16538 of file pcbnew.py.

◆ FindFootprintByPath()

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

Definition at line 16815 of file pcbnew.py.

◆ FindFootprintByReference()

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

Definition at line 16811 of file pcbnew.py.

◆ FindNet()

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

Definition at line 16773 of file pcbnew.py.

Here is the caller graph for this function:

◆ Footprints()

"FOOTPRINTS const &" pcbnew.BOARD.Footprints (   self,
*  args 
) 
    Footprints(BOARD self) -> FOOTPRINTS
    Footprints(BOARD self) -> FOOTPRINTS

Definition at line 16433 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetAllNetClasses()

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

Definition at line 16983 of file pcbnew.py.

◆ GetArea()

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

Definition at line 16839 of file pcbnew.py.

◆ GetAreaCount()

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

Definition at line 16847 of file pcbnew.py.

◆ GetBoardEdgesBoundingBox()

"EDA_RECT const" pcbnew.BOARD.GetBoardEdgesBoundingBox (   self) 
GetBoardEdgesBoundingBox(BOARD self) -> EDA_RECT

Definition at line 16799 of file pcbnew.py.

◆ GetBoardPolygonOutlines()

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

Definition at line 16720 of file pcbnew.py.

◆ GetBoardUse()

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

Definition at line 16402 of file pcbnew.py.

◆ GetBoundingBox()

"EDA_RECT const" pcbnew.BOARD.GetBoundingBox (   self) 
GetBoundingBox(BOARD self) -> EDA_RECT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16795 of file pcbnew.py.

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16831 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetConnectivity()

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

Definition at line 16566 of file pcbnew.py.

◆ GetCopperLayerCount()

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

Definition at line 16621 of file pcbnew.py.

◆ GetCurrentNetClassName()

def pcbnew.BOARD.GetCurrentNetClassName (   self)

Definition at line 16955 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetDesignSettings()

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

Definition at line 16677 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetDrawings()

def pcbnew.BOARD.GetDrawings (   self)

Definition at line 16946 of file pcbnew.py.

◆ GetEnabledLayers()

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

Definition at line 16629 of file pcbnew.py.

◆ GetFileFormatVersionAtLoad()

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

Definition at line 16514 of file pcbnew.py.

◆ GetFileName()

"wxString const &" pcbnew.BOARD.GetFileName (   self) 
GetFileName(BOARD self) -> wxString

Definition at line 16422 of file pcbnew.py.

◆ GetFirstFootprint()

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

Definition at line 16542 of file pcbnew.py.

◆ GetFocusPosition()

"wxPoint const" pcbnew.BOARD.GetFocusPosition (   self) 
GetFocusPosition(BOARD self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16498 of file pcbnew.py.

◆ GetFootprint()

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

Definition at line 16888 of file pcbnew.py.

◆ GetFootprints()

def pcbnew.BOARD.GetFootprints (   self)

Definition at line 16945 of file pcbnew.py.

◆ GetGenerator()

"wxString const &" pcbnew.BOARD.GetGenerator (   self) 
GetGenerator(BOARD self) -> wxString

Definition at line 16522 of file pcbnew.py.

◆ GetHighLightNetCodes()

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

Definition at line 16601 of file pcbnew.py.

◆ GetItem()

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

Definition at line 16550 of file pcbnew.py.

◆ GetLayerID()

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

Definition at line 16728 of file pcbnew.py.

◆ GetLayerName()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 16732 of file pcbnew.py.

◆ GetLayerType()

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

Definition at line 16749 of file pcbnew.py.

◆ GetMsgPanelInfo()

"void" pcbnew.BOARD.GetMsgPanelInfo (   self,
"EDA_DRAW_FRAME *"  aFrame,
"std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &"  aList 
) 
GetMsgPanelInfo(BOARD self, EDA_DRAW_FRAME * aFrame, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16803 of file pcbnew.py.

◆ GetNetClassAssignmentCandidates()

"std.vector< wxString,std.allocator< wxString > >" pcbnew.BOARD.GetNetClassAssignmentCandidates (   self) 
GetNetClassAssignmentCandidates(BOARD self) -> std::vector< wxString,std::allocator< wxString > >

Definition at line 16819 of file pcbnew.py.

◆ GetNetClasses()

def pcbnew.BOARD.GetNetClasses (   self)

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

◆ GetNetCount()

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

Definition at line 16787 of file pcbnew.py.

◆ GetNetInfo()

"NETINFO_LIST &" pcbnew.BOARD.GetNetInfo (   self,
*  args 
) 
    GetNetInfo(BOARD self) -> NETINFO_LIST
    GetNetInfo(BOARD self) -> NETINFO_LIST

Definition at line 16780 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 16964 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 16970 of file pcbnew.py.

◆ GetNodesCount()

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

Definition at line 16757 of file pcbnew.py.

◆ GetPad()

"PAD *" pcbnew.BOARD.GetPad (   self,
*  args 
) 
    GetPad(BOARD self, wxPoint aPosition, LSET aLayerMask) -> PAD
    GetPad(BOARD self, wxPoint aPosition) -> PAD
    GetPad(BOARD self, PCB_TRACK aTrace, ENDPOINT_T aEndPoint) -> PAD
    GetPad(BOARD self, PADS_VEC aPadList, wxPoint aPosition, LSET aLayerMask) -> PAD

Definition at line 16863 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetPadFast()

"PAD *" pcbnew.BOARD.GetPadFast (   self,
"wxPoint"  aPosition,
"LSET"  aLayerMask 
) 
GetPadFast(BOARD self, wxPoint aPosition, LSET aLayerMask) -> PAD

Definition at line 16859 of file pcbnew.py.

◆ GetPads()

"std.vector< PAD *,std.allocator< PAD * > > const" pcbnew.BOARD.GetPads (   self) 
GetPads(BOARD self) -> PADS_VEC

Definition at line 16765 of file pcbnew.py.

◆ GetPageSettings()

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

Definition at line 16689 of file pcbnew.py.

◆ GetPlotOptions()

"PCB_PLOT_PARAMS const &" pcbnew.BOARD.GetPlotOptions (   self) 
GetPlotOptions(BOARD self) -> PCB_PLOT_PARAMS

Definition at line 16697 of file pcbnew.py.

◆ GetPosition()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16490 of file pcbnew.py.

◆ GetProject()

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

Definition at line 16581 of file pcbnew.py.

◆ GetProperties()

"std.map< wxString,wxString,std.less< wxString >,std.allocator< std.pair< wxString const,wxString > > > const &" pcbnew.BOARD.GetProperties (   self) 
GetProperties(BOARD self) -> MAP_STRING_STRING

Definition at line 16472 of file pcbnew.py.

◆ GetSelectMenuText()

"wxString" pcbnew.BOARD.GetSelectMenuText (   self,
"EDA_UNITS"  aUnits 
) 
GetSelectMenuText(BOARD self, EDA_UNITS aUnits) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16716 of file pcbnew.py.

◆ GetSortedPadListByXthenYCoord()

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

Definition at line 16876 of file pcbnew.py.

◆ GetStandardLayerName()

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

Definition at line 16741 of file pcbnew.py.

◆ GetTimeStamp()

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

Definition at line 16410 of file pcbnew.py.

◆ GetTitleBlock()

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

Definition at line 16705 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetTrackLength()

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

Definition at line 16880 of file pcbnew.py.

◆ GetTracks()

def pcbnew.BOARD.GetTracks (   self)

Definition at line 16947 of file pcbnew.py.

◆ GetTrackWidthList()

def pcbnew.BOARD.GetTrackWidthList (   self)

Definition at line 16961 of file pcbnew.py.

◆ GetUnconnectedNetCount()

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

Definition at line 16761 of file pcbnew.py.

◆ GetViasDimensionsList()

def pcbnew.BOARD.GetViasDimensionsList (   self)

Definition at line 16958 of file pcbnew.py.

◆ GetVisibleElements()

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

Definition at line 16653 of file pcbnew.py.

◆ GetVisibleLayers()

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

Definition at line 16645 of file pcbnew.py.

◆ GetZoneList()

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

Definition at line 16843 of file pcbnew.py.

◆ GetZoneSettings()

"ZONE_SETTINGS const &" pcbnew.BOARD.GetZoneSettings (   self) 
GetZoneSettings(BOARD self) -> ZONE_SETTINGS

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 16681 of file pcbnew.py.

◆ GroupLegalOps()

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

Definition at line 16928 of file pcbnew.py.

◆ Groups()

"GROUPS const &" pcbnew.BOARD.Groups (   self,
*  args 
) 
    Groups(BOARD self) -> GROUPS
    Groups(BOARD self) -> GROUPS

Definition at line 16461 of file pcbnew.py.

Here is the caller graph for this function:

◆ GroupsSanityCheck()

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

Definition at line 16920 of file pcbnew.py.

◆ GroupsSanityCheckInternal()

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

Definition at line 16924 of file pcbnew.py.

◆ HighLightOFF()

"void" pcbnew.BOARD.HighLightOFF (   self) 
HighLightOFF(BOARD self)

Definition at line 16617 of file pcbnew.py.

◆ HighLightON()

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

Definition at line 16613 of file pcbnew.py.

◆ IncrementTimeStamp()

"void" pcbnew.BOARD.IncrementTimeStamp (   self) 
IncrementTimeStamp(BOARD self)

Definition at line 16406 of file pcbnew.py.

◆ IsElementVisible()

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

Definition at line 16665 of file pcbnew.py.

◆ IsEmpty()

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

Definition at line 16502 of file pcbnew.py.

◆ IsFootprintHolder()

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

Definition at line 16414 of file pcbnew.py.

◆ IsFootprintLayerVisible()

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

Definition at line 16673 of file pcbnew.py.

◆ IsHighLightNetON()

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

Definition at line 16609 of file pcbnew.py.

◆ IsLayerEnabled()

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

Definition at line 16637 of file pcbnew.py.

◆ IsLayerVisible()

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

Definition at line 16641 of file pcbnew.py.

◆ MapNets()

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

Definition at line 16896 of file pcbnew.py.

◆ Markers()

"MARKERS const &" pcbnew.BOARD.Markers (   self,
*  args 
) 
    Markers(BOARD self) -> MARKERS
    Markers(BOARD self) -> MARKERS

Definition at line 16454 of file pcbnew.py.

Here is the caller graph for this function:

◆ Move()

"void" pcbnew.BOARD.Move (   self,
"wxPoint"  aMoveVector 
) 
Move(BOARD self, wxPoint aMoveVector)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 16506 of file pcbnew.py.

◆ OnItemChanged()

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

Definition at line 16912 of file pcbnew.py.

◆ OnItemsChanged()

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

Definition at line 16916 of file pcbnew.py.

◆ PadDelete()

"void" pcbnew.BOARD.PadDelete (   self,
"PAD"  aPad 
) 
PadDelete(BOARD self, PAD aPad)

Definition at line 16872 of file pcbnew.py.

◆ RemoveListener()

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

Definition at line 16908 of file pcbnew.py.

◆ RemoveNative()

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

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 16530 of file pcbnew.py.

Here is the caller graph for this function:

◆ ResetNetHighLight()

"void" pcbnew.BOARD.ResetNetHighLight (   self) 
ResetNetHighLight(BOARD self)

Definition at line 16597 of file pcbnew.py.

◆ ResolveDRCExclusions()

"std.vector< PCB_MARKER *,std.allocator< PCB_MARKER * > >" pcbnew.BOARD.ResolveDRCExclusions (   self) 
ResolveDRCExclusions(BOARD self) -> MARKERS

Definition at line 16593 of file pcbnew.py.

◆ ResolveTextVar()

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

Definition at line 16480 of file pcbnew.py.

◆ SanitizeNetcodes()

"void" pcbnew.BOARD.SanitizeNetcodes (   self) 
SanitizeNetcodes(BOARD self)

Definition at line 16900 of file pcbnew.py.

◆ Save()

def pcbnew.BOARD.Save (   self,
  filename 
)

Definition at line 16949 of file pcbnew.py.

◆ SetAreasNetCodesFromNetNames()

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

Definition at line 16835 of file pcbnew.py.

◆ SetBoardUse()

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

Definition at line 16398 of file pcbnew.py.

◆ SetCopperLayerCount()

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

Definition at line 16625 of file pcbnew.py.

◆ SetElementVisibility()

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

Definition at line 16669 of file pcbnew.py.

◆ SetEnabledLayers()

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

Definition at line 16633 of file pcbnew.py.

◆ SetFileFormatVersionAtLoad()

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

Definition at line 16510 of file pcbnew.py.

◆ SetFileName()

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

Definition at line 16418 of file pcbnew.py.

◆ SetGenerator()

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

Definition at line 16518 of file pcbnew.py.

◆ SetHighLightNet()

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

Definition at line 16605 of file pcbnew.py.

◆ SetLayerDescr()

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

Definition at line 16745 of file pcbnew.py.

◆ SetLayerName()

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

Definition at line 16736 of file pcbnew.py.

◆ SetLayerType()

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

Definition at line 16753 of file pcbnew.py.

◆ SetPageSettings()

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

Definition at line 16693 of file pcbnew.py.

◆ SetPlotOptions()

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

Definition at line 16701 of file pcbnew.py.

◆ SetPosition()

"void" pcbnew.BOARD.SetPosition (   self,
"wxPoint"  aPos 
) 
SetPosition(BOARD self, wxPoint aPos)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16494 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetProject()

"void" pcbnew.BOARD.SetProject (   self,
"PROJECT *"  aProject 
) 
SetProject(BOARD self, PROJECT * aProject)

Definition at line 16585 of file pcbnew.py.

◆ SetProperties()

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

Definition at line 16476 of file pcbnew.py.

◆ SetTitleBlock()

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

Definition at line 16712 of file pcbnew.py.

◆ SetVisibleAlls()

"void" pcbnew.BOARD.SetVisibleAlls (   self) 
SetVisibleAlls(BOARD self)

Definition at line 16661 of file pcbnew.py.

◆ SetVisibleElements()

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

Definition at line 16657 of file pcbnew.py.

◆ SetVisibleLayers()

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

Definition at line 16649 of file pcbnew.py.

◆ SetZoneSettings()

"void" pcbnew.BOARD.SetZoneSettings (   self,
"ZONE_SETTINGS"  aSettings 
) 
SetZoneSettings(BOARD self, ZONE_SETTINGS aSettings)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 16685 of file pcbnew.py.

◆ SynchronizeNetsAndNetClasses()

"void" pcbnew.BOARD.SynchronizeNetsAndNetClasses (   self) 
SynchronizeNetsAndNetClasses(BOARD self)

Definition at line 16823 of file pcbnew.py.

◆ SynchronizeProperties()

"void" pcbnew.BOARD.SynchronizeProperties (   self) 
SynchronizeProperties(BOARD self)

Definition at line 16827 of file pcbnew.py.

◆ TestZoneIntersection()

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

Definition at line 16855 of file pcbnew.py.

◆ Tracks()

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

Definition at line 16426 of file pcbnew.py.

Here is the caller graph for this function:

◆ TracksInNet()

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

Definition at line 16884 of file pcbnew.py.

◆ Visit()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 16807 of file pcbnew.py.

◆ Zones()

"ZONES const &" pcbnew.BOARD.Zones (   self,
*  args 
) 
    Zones(BOARD self) -> ZONES
    Zones(BOARD self) -> ZONES

Definition at line 16447 of file pcbnew.py.

Here is the caller graph for this function:

Member Data Documentation

◆ netclassmap

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

Definition at line 16992 of file pcbnew.py.

◆ this

pcbnew.BOARD.this

Definition at line 16941 of file pcbnew.py.

Property Documentation

◆ m_InsideBCourtyardCache

pcbnew.BOARD.m_InsideBCourtyardCache = property(_pcbnew.BOARD_m_InsideBCourtyardCache_get, _pcbnew.BOARD_m_InsideBCourtyardCache_set, doc=)
static

Definition at line 16932 of file pcbnew.py.

◆ m_InsideFCourtyardCache

pcbnew.BOARD.m_InsideFCourtyardCache = property(_pcbnew.BOARD_m_InsideFCourtyardCache_get, _pcbnew.BOARD_m_InsideFCourtyardCache_set, doc=)
static

Definition at line 16931 of file pcbnew.py.

◆ m_LayerExpressionCache

pcbnew.BOARD.m_LayerExpressionCache = property(_pcbnew.BOARD_m_LayerExpressionCache_get, _pcbnew.BOARD_m_LayerExpressionCache_set, doc=)
static

Definition at line 16933 of file pcbnew.py.

◆ m_LegacyCopperEdgeClearanceLoaded

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

Definition at line 16486 of file pcbnew.py.

◆ m_LegacyDesignSettingsLoaded

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

Definition at line 16485 of file pcbnew.py.

◆ m_LegacyNetclassesLoaded

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

Definition at line 16487 of file pcbnew.py.

◆ m_LegacyVisibleItems

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

Definition at line 16484 of file pcbnew.py.

◆ m_LegacyVisibleLayers

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

Definition at line 16483 of file pcbnew.py.

◆ thisown

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

Definition at line 16387 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Sun Jan 1 2023 00:51:22 for KiCad Pcbnew Python Scripting by doxygen 1.9.4