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

Public Member Functions

def ClassOf (aItem)
 
def SetFileName (self, aFileName)
 
def GetFileName (self)
 
def Tracks (self)
 
def Modules (self)
 
def Drawings (self)
 
def Zones (self)
 
def AllConnectedItems (self)
 
def DrawingsList (self)
 
def __init__ (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def IsEmpty (self)
 
def Move (self, aMoveVector)
 
def SetFileFormatVersionAtLoad (self, aVersion)
 
def GetFileFormatVersionAtLoad (self)
 
def AddNative (self, aItem, aMode=ADD_INSERT)
 
def RemoveNative (self, aBoardItem)
 
def GetItem (self, aWeakReference)
 
def Duplicate (self, aItem, aAddToBoard=False)
 
def GetConnectivity (self)
 
def BuildConnectivity (self)
 
def DeleteMARKERs (self)
 
def DeleteZONEOutlines (self)
 
def GetMARKER (self, index)
 
def GetMARKERCount (self)
 
def SetAuxOrigin (self, aPoint)
 
def GetAuxOrigin (self)
 
def SetGridOrigin (self, aPoint)
 
def GetGridOrigin (self)
 
def ResetHighLight (self)
 
def GetHighLightNetCode (self)
 
def SetHighLightNet (self, aNetCode)
 
def IsHighLightNetON (self)
 
def HighLightOFF (self)
 
def HighLightON (self)
 
def PushHighLight (self)
 
def PopHighLight (self)
 
def GetCopperLayerCount (self)
 
def SetCopperLayerCount (self, aCount)
 
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 IsModuleLayerVisible (self, aLayer)
 
def GetDesignSettings (self)
 
def SetDesignSettings (self, aDesignSettings)
 
def GetPageSettings (self)
 
def SetPageSettings (self, aPageSettings)
 
def GetPlotOptions (self)
 
def SetPlotOptions (self, aOptions)
 
def GetTitleBlock (self)
 
def SetTitleBlock (self, aTitleBlock)
 
def GetZoneSettings (self)
 
def SetZoneSettings (self, aSettings)
 
def GetSelectMenuText (self, aUnits)
 
def Colors (self)
 
def SetColorsSettings (self, aColorsSettings)
 
def GetBoardPolygonOutlines (self, aOutlines, aErrorText=None, aErrorLocation=None)
 
def ConvertBrdLayerToPolygonalContours (self, aLayer, aOutlines)
 
def GetLayerID (self, aLayerName)
 
def GetLayerName (self, aLayer)
 
def SetLayerName (self, aLayer, aLayerName)
 
def GetStandardLayerName (aLayerId)
 
def SetLayerDescr (self, aIndex, aLayer)
 
def GetLayerType (self, aLayer)
 
def SetLayerType (self, aLayer, aLayerType)
 
def GetNumSegmTrack (self)
 
def GetNodesCount (self, aNet=-1)
 
def GetUnconnectedNetCount (self)
 
def GetPadCount (self)
 
def GetPads (self)
 
def BuildListOfNets (self)
 
def FindNet (self, *args)
 
def GetNetInfo (self)
 
def GetNetCount (self)
 
def ComputeBoundingBox (self, aBoardEdgesOnly=False)
 
def GetBoundingBox (self)
 
def GetBoardEdgesBoundingBox (self)
 
def GetMsgPanelInfo (self, aUnits, aList)
 
def Draw (self, *args)
 
def DrawHighLight (self, aDrawPanel, aDC, aNetCode)
 
def Visit (self, inspector, testData, scanTypes)
 
def FindModuleByReference (self, aReference)
 
def FindModule (self, aRefOrTimeStamp, aSearchByTimeStamp=False)
 
def SortedNetnamesList (self, aNames, aSortbyPadsCount)
 
def SynchronizeNetsAndNetClasses (self)
 
def GetClass (self)
 
def HitTestForAnyFilledArea (self, aRefPos, aStartLayer, aEndLayer, aNetCode)
 
def RedrawAreasOutlines (self, aPanel, aDC, aDrawMode, aLayer)
 
def RedrawFilledAreas (self, aPanel, aDC, aDrawMode, aLayer)
 
def SetAreasNetCodesFromNetNames (self)
 
def GetArea (self, index)
 
def GetAreaIndex (self, aArea)
 
def GetAreaCount (self)
 
def AddArea (self, aNewZonesList, aNetcode, aLayer, aStartPointPosition, aHatch)
 
def InsertArea (self, aNetcode, aAreaIdx, aLayer, aCornerX, aCornerY, aHatch)
 
def NormalizeAreaPolygon (self, aNewZonesList, aCurrArea)
 
def OnAreaPolygonModified (self, aModifiedZonesList, modified_area)
 
def CombineAllAreasInNet (self, aDeletedList, aNetCode, aUseLocalFlags)
 
def RemoveArea (self, aDeletedList, area_to_remove)
 
def TestAreaIntersections (self, area_to_test)
 
def TestAreaIntersection (self, area_ref, area_to_test)
 
def CombineAreas (self, aDeletedList, area_ref, area_to_combine)
 
def GetViaByPosition (self, *args)
 
def GetTracksByPosition (self, *args)
 
def GetPadFast (self, aPosition, aLayerMask)
 
def GetPad (self, *args)
 
def PadDelete (self, aPad)
 
def GetSortedPadListByXthenYCoord (self, aVector, aNetCode=-1)
 
def GetVisibleTrack (self, aStartingTrace, aPosition, aLayerSet)
 
def MarkTrace (self, aTrackList, aTrace, aCount, aTraceLength, aInPackageLength, aReorder)
 
def TracksInNet (self, aNetCode)
 
def TracksInNetBetweenPoints (self, aStartPos, aGoalPos, aNetCode)
 
def GetFootprint (self, aPosition, aActiveLayer, aVisibleOnly, aIgnoreLocked=False)
 
def GetLockPoint (self, aPosition, aLayerMask)
 
def CreateLockPoint (self, aPosition, aSegment, aList)
 
def ClearAllNetCodes (self)
 
def SanitizeNetcodes (self)
 
def GetModules (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 DeleteNative (self, aItem)
 
def Add (self, item)
 
def Remove (self, item)
 
def Delete (self, item)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def GetCenter (self)
 
def IsConnected (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def SwapData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (aShape)
 
def Move (self, *args)
 
def Rotate (self, *args)
 
def Flip (self, *args)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor, 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 Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def GetList (self)
 
def SetParent (self, aParent)
 
def SetList (self, aList)
 
def IsNew (self)
 
def IsModified (self)
 
def IsMoving (self)
 
def IsDragging (self)
 
def IsWireImage (self)
 
def IsSelected (self)
 
def IsResized (self)
 
def IsHighlighted (self)
 
def IsBrightened (self)
 
def SetWireImage (self)
 
def SetSelected (self)
 
def SetHighlighted (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearHighlighted (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def ClearFlags (self, aMask=-1)
 
def GetFlags (self)
 
def GetEditFlags (self)
 
def ClearTempFlags (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def HitTest (self, *args)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (aLeft, aRight)
 
def ViewBBox (self)
 

Public Attributes

 this
 

Static Public Attributes

 ClassOf = staticmethod(ClassOf)
 
 m_Status_Pcb = _swig_property(_pcbnew.BOARD_m_Status_Pcb_get, _pcbnew.BOARD_m_Status_Pcb_set)
 
 m_Modules = _swig_property(_pcbnew.BOARD_m_Modules_get, _pcbnew.BOARD_m_Modules_set)
 
 m_Track = _swig_property(_pcbnew.BOARD_m_Track_get, _pcbnew.BOARD_m_Track_set)
 
 m_CurrentZoneContour = _swig_property(_pcbnew.BOARD_m_CurrentZoneContour_get, _pcbnew.BOARD_m_CurrentZoneContour_set)
 
 GetStandardLayerName = staticmethod(GetStandardLayerName)
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 ShowShape = staticmethod(ShowShape)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
 IterateForward = staticmethod(IterateForward)
 
 Sort = staticmethod(Sort)
 

Detailed Description

Proxy of C++ BOARD class.

Definition at line 18555 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.BOARD.__init__ (   self)
__init__(BOARD self) -> BOARD

Definition at line 18630 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, wxPoint aStartPointPosition, int aHatch) -> ZONE_CONTAINER

Definition at line 19126 of file pcbnew.py.

◆ AddNative()

def pcbnew.BOARD.AddNative (   self,
  aItem,
  aMode = ADD_INSERT 
)
AddNative(BOARD self, BOARD_ITEM aItem, ADD_MODE aMode=ADD_INSERT)
AddNative(BOARD self, BOARD_ITEM aItem)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 18670 of file pcbnew.py.

◆ AllConnectedItems()

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

Definition at line 18616 of file pcbnew.py.

◆ BuildConnectivity()

def pcbnew.BOARD.BuildConnectivity (   self)
BuildConnectivity(BOARD self)

Definition at line 18701 of file pcbnew.py.

◆ BuildListOfNets()

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

Definition at line 18999 of file pcbnew.py.

◆ ClassOf()

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

Definition at line 18568 of file pcbnew.py.

◆ ClearAllNetCodes()

def pcbnew.BOARD.ClearAllNetCodes (   self)
ClearAllNetCodes(BOARD self)

Definition at line 19254 of file pcbnew.py.

◆ Colors()

def pcbnew.BOARD.Colors (   self)
Colors(BOARD self) -> COLORS_DESIGN_SETTINGS

Definition at line 18911 of file pcbnew.py.

◆ CombineAllAreasInNet()

def pcbnew.BOARD.CombineAllAreasInNet (   self,
  aDeletedList,
  aNetCode,
  aUseLocalFlags 
)
CombineAllAreasInNet(BOARD self, PICKED_ITEMS_LIST * aDeletedList, int aNetCode, bool aUseLocalFlags) -> bool

Definition at line 19146 of file pcbnew.py.

◆ CombineAreas()

def pcbnew.BOARD.CombineAreas (   self,
  aDeletedList,
  area_ref,
  area_to_combine 
)
CombineAreas(BOARD self, PICKED_ITEMS_LIST * aDeletedList, ZONE_CONTAINER area_ref, ZONE_CONTAINER area_to_combine) -> bool

Definition at line 19166 of file pcbnew.py.

◆ ComputeBoundingBox()

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

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

◆ CreateLockPoint()

def pcbnew.BOARD.CreateLockPoint (   self,
  aPosition,
  aSegment,
  aList 
)
CreateLockPoint(BOARD self, wxPoint aPosition, TRACK aSegment, PICKED_ITEMS_LIST * aList) -> TRACK

Definition at line 19249 of file pcbnew.py.

◆ DeleteMARKERs()

def pcbnew.BOARD.DeleteMARKERs (   self)
DeleteMARKERs(BOARD self)

Definition at line 18706 of file pcbnew.py.

◆ DeleteZONEOutlines()

def pcbnew.BOARD.DeleteZONEOutlines (   self)
DeleteZONEOutlines(BOARD self)

Definition at line 18711 of file pcbnew.py.

◆ Draw()

def pcbnew.BOARD.Draw (   self,
args 
)
Draw(BOARD self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
Draw(BOARD self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 19045 of file pcbnew.py.

◆ DrawHighLight()

def pcbnew.BOARD.DrawHighLight (   self,
  aDrawPanel,
  aDC,
  aNetCode 
)
DrawHighLight(BOARD self, EDA_DRAW_PANEL * aDrawPanel, wxDC * aDC, int aNetCode)

Definition at line 19053 of file pcbnew.py.

◆ Drawings()

def pcbnew.BOARD.Drawings (   self)
Drawings(BOARD self) -> DLIST_ITERATOR_WRAPPER< BOARD_ITEM >

Definition at line 18606 of file pcbnew.py.

◆ DrawingsList()

def pcbnew.BOARD.DrawingsList (   self)
DrawingsList(BOARD self) -> BOARD_ITEM_List

Definition at line 18621 of file pcbnew.py.

Here is the caller graph for this function:

◆ Duplicate()

def pcbnew.BOARD.Duplicate (   self,
  aItem,
  aAddToBoard = False 
)
Duplicate(BOARD self, BOARD_ITEM aItem, bool aAddToBoard=False) -> BOARD_ITEM
Duplicate(BOARD self, BOARD_ITEM aItem) -> BOARD_ITEM

Definition at line 18688 of file pcbnew.py.

◆ FindModule()

def pcbnew.BOARD.FindModule (   self,
  aRefOrTimeStamp,
  aSearchByTimeStamp = False 
)
FindModule(BOARD self, wxString aRefOrTimeStamp, bool aSearchByTimeStamp=False) -> MODULE
FindModule(BOARD self, wxString aRefOrTimeStamp) -> MODULE

Definition at line 19068 of file pcbnew.py.

◆ FindModuleByReference()

def pcbnew.BOARD.FindModuleByReference (   self,
  aReference 
)
FindModuleByReference(BOARD self, wxString aReference) -> MODULE

Definition at line 19063 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 19004 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 19303 of file pcbnew.py.

◆ GetArea()

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

Definition at line 19111 of file pcbnew.py.

◆ GetAreaCount()

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

Definition at line 19121 of file pcbnew.py.

◆ GetAreaIndex()

def pcbnew.BOARD.GetAreaIndex (   self,
  aArea 
)
GetAreaIndex(BOARD self, ZONE_CONTAINER aArea) -> int

Definition at line 19116 of file pcbnew.py.

◆ GetAuxOrigin()

def pcbnew.BOARD.GetAuxOrigin (   self)
GetAuxOrigin(BOARD self) -> wxPoint

Definition at line 18731 of file pcbnew.py.

◆ GetBoardEdgesBoundingBox()

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

Definition at line 19035 of file pcbnew.py.

◆ GetBoardPolygonOutlines()

def pcbnew.BOARD.GetBoardPolygonOutlines (   self,
  aOutlines,
  aErrorText = None,
  aErrorLocation = None 
)
GetBoardPolygonOutlines(BOARD self, SHAPE_POLY_SET aOutlines, wxString aErrorText=None, wxPoint aErrorLocation=None) -> bool
GetBoardPolygonOutlines(BOARD self, SHAPE_POLY_SET aOutlines, wxString aErrorText=None) -> bool
GetBoardPolygonOutlines(BOARD self, SHAPE_POLY_SET aOutlines) -> bool

Definition at line 18921 of file pcbnew.py.

◆ GetBoundingBox()

def pcbnew.BOARD.GetBoundingBox (   self)
GetBoundingBox(BOARD self) -> EDA_RECT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 19030 of file pcbnew.py.

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 19086 of file pcbnew.py.

◆ GetConnectivity()

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

Definition at line 18696 of file pcbnew.py.

◆ GetCopperLayerCount()

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

Definition at line 18786 of file pcbnew.py.

◆ GetCurrentNetClassName()

def pcbnew.BOARD.GetCurrentNetClassName (   self)

Definition at line 19275 of file pcbnew.py.

◆ GetDesignSettings()

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

Definition at line 18856 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetDrawings()

def pcbnew.BOARD.GetDrawings (   self)

Definition at line 19266 of file pcbnew.py.

◆ GetEnabledLayers()

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

Definition at line 18796 of file pcbnew.py.

◆ GetFileFormatVersionAtLoad()

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

Definition at line 18665 of file pcbnew.py.

◆ GetFileName()

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

Definition at line 18579 of file pcbnew.py.

◆ GetFootprint()

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

Definition at line 19236 of file pcbnew.py.

◆ GetGridOrigin()

def pcbnew.BOARD.GetGridOrigin (   self)
GetGridOrigin(BOARD self) -> wxPoint

Definition at line 18741 of file pcbnew.py.

◆ GetHighLightNetCode()

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

Definition at line 18751 of file pcbnew.py.

◆ GetItem()

def pcbnew.BOARD.GetItem (   self,
  aWeakReference 
)
GetItem(BOARD self, void * aWeakReference) -> BOARD_ITEM

Definition at line 18683 of file pcbnew.py.

◆ GetLayerID()

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

Definition at line 18935 of file pcbnew.py.

◆ GetLayerName()

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

Definition at line 18940 of file pcbnew.py.

◆ GetLayerType()

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

Definition at line 18961 of file pcbnew.py.

◆ GetLockPoint()

def pcbnew.BOARD.GetLockPoint (   self,
  aPosition,
  aLayerMask 
)
GetLockPoint(BOARD self, wxPoint aPosition, LSET aLayerMask) -> BOARD_CONNECTED_ITEM

Definition at line 19244 of file pcbnew.py.

◆ GetMARKER()

def pcbnew.BOARD.GetMARKER (   self,
  index 
)
GetMARKER(BOARD self, int index) -> MARKER_PCB

Definition at line 18716 of file pcbnew.py.

◆ GetMARKERCount()

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

Definition at line 18721 of file pcbnew.py.

◆ GetModules()

def pcbnew.BOARD.GetModules (   self)

Definition at line 19265 of file pcbnew.py.

◆ GetMsgPanelInfo()

def pcbnew.BOARD.GetMsgPanelInfo (   self,
  aUnits,
  aList 
)
GetMsgPanelInfo(BOARD self, EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 19040 of file pcbnew.py.

◆ GetNetClasses()

def pcbnew.BOARD.GetNetClasses (   self)

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

◆ GetNetCount()

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

Definition at line 19017 of file pcbnew.py.

◆ GetNetInfo()

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

Definition at line 19012 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 19284 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 19290 of file pcbnew.py.

◆ GetNodesCount()

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

Definition at line 18976 of file pcbnew.py.

◆ GetNumSegmTrack()

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

Definition at line 18971 of file pcbnew.py.

◆ GetPad()

def pcbnew.BOARD.GetPad (   self,
args 
)
GetPad(BOARD self, unsigned int aIndex) -> D_PAD
GetPad(BOARD self, wxPoint aPosition, LSET aLayerMask) -> D_PAD
GetPad(BOARD self, wxPoint aPosition) -> D_PAD
GetPad(BOARD self, TRACK aTrace, ENDPOINT_T aEndPoint) -> D_PAD
GetPad(BOARD self, D_PADS aPadList, wxPoint aPosition, LSET aLayerMask) -> D_PAD

Definition at line 19192 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetPadCount()

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

Definition at line 18989 of file pcbnew.py.

◆ GetPadFast()

def pcbnew.BOARD.GetPadFast (   self,
  aPosition,
  aLayerMask 
)
GetPadFast(BOARD self, wxPoint aPosition, LSET aLayerMask) -> D_PAD

Definition at line 19187 of file pcbnew.py.

◆ GetPads()

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

Definition at line 18994 of file pcbnew.py.

◆ GetPageSettings()

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

Definition at line 18866 of file pcbnew.py.

◆ GetPlotOptions()

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

Definition at line 18876 of file pcbnew.py.

◆ GetPosition()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 18640 of file pcbnew.py.

◆ GetSelectMenuText()

def pcbnew.BOARD.GetSelectMenuText (   self,
  aUnits 
)
GetSelectMenuText(BOARD self, EDA_UNITS_T aUnits) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 18906 of file pcbnew.py.

◆ GetSortedPadListByXthenYCoord()

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

Definition at line 19208 of file pcbnew.py.

◆ GetStandardLayerName()

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

Definition at line 18950 of file pcbnew.py.

◆ GetTitleBlock()

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

Definition at line 18886 of file pcbnew.py.

◆ GetTracks()

def pcbnew.BOARD.GetTracks (   self)

Definition at line 19267 of file pcbnew.py.

◆ GetTracksByPosition()

def pcbnew.BOARD.GetTracksByPosition (   self,
args 
)
GetTracksByPosition(BOARD self, wxPoint aPosition, PCB_LAYER_ID aLayer) -> std::list< TRACK *,std::allocator< TRACK * > >
GetTracksByPosition(BOARD self, wxPoint aPosition) -> std::list< TRACK *,std::allocator< TRACK * > >

Definition at line 19179 of file pcbnew.py.

◆ GetTrackWidthList()

def pcbnew.BOARD.GetTrackWidthList (   self)

Definition at line 19281 of file pcbnew.py.

◆ GetUnconnectedNetCount()

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

Definition at line 18984 of file pcbnew.py.

◆ GetViaByPosition()

def pcbnew.BOARD.GetViaByPosition (   self,
args 
)
GetViaByPosition(BOARD self, wxPoint aPosition, PCB_LAYER_ID aLayer) -> VIA
GetViaByPosition(BOARD self, wxPoint aPosition) -> VIA

Definition at line 19171 of file pcbnew.py.

◆ GetViasDimensionsList()

def pcbnew.BOARD.GetViasDimensionsList (   self)

Definition at line 19278 of file pcbnew.py.

◆ GetVisibleElements()

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

Definition at line 18826 of file pcbnew.py.

◆ GetVisibleLayers()

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

Definition at line 18816 of file pcbnew.py.

◆ GetVisibleTrack()

def pcbnew.BOARD.GetVisibleTrack (   self,
  aStartingTrace,
  aPosition,
  aLayerSet 
)
GetVisibleTrack(BOARD self, TRACK aStartingTrace, wxPoint aPosition, LSET aLayerSet) -> TRACK

Definition at line 19216 of file pcbnew.py.

◆ GetZoneSettings()

def pcbnew.BOARD.GetZoneSettings (   self)
GetZoneSettings(BOARD self) -> ZONE_SETTINGS

Definition at line 18896 of file pcbnew.py.

◆ HighLightOFF()

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

Definition at line 18766 of file pcbnew.py.

◆ HighLightON()

def pcbnew.BOARD.HighLightON (   self)
HighLightON(BOARD self)

Definition at line 18771 of file pcbnew.py.

◆ HitTestForAnyFilledArea()

def pcbnew.BOARD.HitTestForAnyFilledArea (   self,
  aRefPos,
  aStartLayer,
  aEndLayer,
  aNetCode 
)
HitTestForAnyFilledArea(BOARD self, wxPoint aRefPos, PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer, int aNetCode) -> ZONE_CONTAINER

Definition at line 19091 of file pcbnew.py.

◆ InsertArea()

def pcbnew.BOARD.InsertArea (   self,
  aNetcode,
  aAreaIdx,
  aLayer,
  aCornerX,
  aCornerY,
  aHatch 
)
InsertArea(BOARD self, int aNetcode, int aAreaIdx, PCB_LAYER_ID aLayer, int aCornerX, int aCornerY, int aHatch) -> ZONE_CONTAINER

Definition at line 19131 of file pcbnew.py.

◆ IsElementVisible()

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

Definition at line 18841 of file pcbnew.py.

◆ IsEmpty()

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

Definition at line 18650 of file pcbnew.py.

◆ IsHighLightNetON()

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

Definition at line 18761 of file pcbnew.py.

◆ IsLayerEnabled()

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

Definition at line 18806 of file pcbnew.py.

◆ IsLayerVisible()

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

Definition at line 18811 of file pcbnew.py.

◆ IsModuleLayerVisible()

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

Definition at line 18851 of file pcbnew.py.

◆ MarkTrace()

def pcbnew.BOARD.MarkTrace (   self,
  aTrackList,
  aTrace,
  aCount,
  aTraceLength,
  aInPackageLength,
  aReorder 
)
MarkTrace(BOARD self, TRACK aTrackList, TRACK aTrace, int * aCount, double * aTraceLength, double * aInPackageLength, bool aReorder) -> TRACK

Definition at line 19221 of file pcbnew.py.

◆ Modules()

def pcbnew.BOARD.Modules (   self)
Modules(BOARD self) -> DLIST_ITERATOR_WRAPPER< MODULE >

Definition at line 18601 of file pcbnew.py.

◆ Move()

def pcbnew.BOARD.Move (   self,
  aMoveVector 
)
Move(BOARD self, wxPoint aMoveVector)

Definition at line 18655 of file pcbnew.py.

◆ NormalizeAreaPolygon()

def pcbnew.BOARD.NormalizeAreaPolygon (   self,
  aNewZonesList,
  aCurrArea 
)
NormalizeAreaPolygon(BOARD self, PICKED_ITEMS_LIST * aNewZonesList, ZONE_CONTAINER aCurrArea) -> bool

Definition at line 19136 of file pcbnew.py.

◆ OnAreaPolygonModified()

def pcbnew.BOARD.OnAreaPolygonModified (   self,
  aModifiedZonesList,
  modified_area 
)
OnAreaPolygonModified(BOARD self, PICKED_ITEMS_LIST * aModifiedZonesList, ZONE_CONTAINER modified_area) -> bool

Definition at line 19141 of file pcbnew.py.

◆ PadDelete()

def pcbnew.BOARD.PadDelete (   self,
  aPad 
)
PadDelete(BOARD self, D_PAD aPad)

Definition at line 19203 of file pcbnew.py.

◆ PopHighLight()

def pcbnew.BOARD.PopHighLight (   self)
PopHighLight(BOARD self)

Definition at line 18781 of file pcbnew.py.

◆ PushHighLight()

def pcbnew.BOARD.PushHighLight (   self)
PushHighLight(BOARD self)

Definition at line 18776 of file pcbnew.py.

◆ RedrawAreasOutlines()

def pcbnew.BOARD.RedrawAreasOutlines (   self,
  aPanel,
  aDC,
  aDrawMode,
  aLayer 
)
RedrawAreasOutlines(BOARD self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, PCB_LAYER_ID aLayer)

Definition at line 19096 of file pcbnew.py.

◆ RedrawFilledAreas()

def pcbnew.BOARD.RedrawFilledAreas (   self,
  aPanel,
  aDC,
  aDrawMode,
  aLayer 
)
RedrawFilledAreas(BOARD self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, PCB_LAYER_ID aLayer)

Definition at line 19101 of file pcbnew.py.

◆ RemoveArea()

def pcbnew.BOARD.RemoveArea (   self,
  aDeletedList,
  area_to_remove 
)
RemoveArea(BOARD self, PICKED_ITEMS_LIST * aDeletedList, ZONE_CONTAINER area_to_remove)

Definition at line 19151 of file pcbnew.py.

◆ RemoveNative()

def pcbnew.BOARD.RemoveNative (   self,
  aBoardItem 
)
RemoveNative(BOARD self, BOARD_ITEM aBoardItem)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 18678 of file pcbnew.py.

◆ ResetHighLight()

def pcbnew.BOARD.ResetHighLight (   self)
ResetHighLight(BOARD self)

Definition at line 18746 of file pcbnew.py.

◆ SanitizeNetcodes()

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

Definition at line 19259 of file pcbnew.py.

◆ Save()

def pcbnew.BOARD.Save (   self,
  filename 
)

Definition at line 19269 of file pcbnew.py.

◆ SetAreasNetCodesFromNetNames()

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

Definition at line 19106 of file pcbnew.py.

◆ SetAuxOrigin()

def pcbnew.BOARD.SetAuxOrigin (   self,
  aPoint 
)
SetAuxOrigin(BOARD self, wxPoint aPoint)

Definition at line 18726 of file pcbnew.py.

◆ SetColorsSettings()

def pcbnew.BOARD.SetColorsSettings (   self,
  aColorsSettings 
)
SetColorsSettings(BOARD self, COLORS_DESIGN_SETTINGS aColorsSettings)

Definition at line 18916 of file pcbnew.py.

◆ SetCopperLayerCount()

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

Definition at line 18791 of file pcbnew.py.

◆ SetDesignSettings()

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

Definition at line 18861 of file pcbnew.py.

◆ SetElementVisibility()

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

Definition at line 18846 of file pcbnew.py.

◆ SetEnabledLayers()

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

Definition at line 18801 of file pcbnew.py.

◆ SetFileFormatVersionAtLoad()

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

Definition at line 18660 of file pcbnew.py.

◆ SetFileName()

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

Definition at line 18574 of file pcbnew.py.

◆ SetGridOrigin()

def pcbnew.BOARD.SetGridOrigin (   self,
  aPoint 
)
SetGridOrigin(BOARD self, wxPoint aPoint)

Definition at line 18736 of file pcbnew.py.

◆ SetHighLightNet()

def pcbnew.BOARD.SetHighLightNet (   self,
  aNetCode 
)
SetHighLightNet(BOARD self, int aNetCode)

Definition at line 18756 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 18956 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 18945 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 18966 of file pcbnew.py.

◆ SetPageSettings()

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

Definition at line 18871 of file pcbnew.py.

◆ SetPlotOptions()

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

Definition at line 18881 of file pcbnew.py.

◆ SetPosition()

def pcbnew.BOARD.SetPosition (   self,
  aPos 
)
SetPosition(BOARD self, wxPoint aPos)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 18645 of file pcbnew.py.

◆ SetTitleBlock()

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

Definition at line 18891 of file pcbnew.py.

◆ SetVisibleAlls()

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

Definition at line 18836 of file pcbnew.py.

◆ SetVisibleElements()

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

Definition at line 18831 of file pcbnew.py.

◆ SetVisibleLayers()

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

Definition at line 18821 of file pcbnew.py.

◆ SetZoneSettings()

def pcbnew.BOARD.SetZoneSettings (   self,
  aSettings 
)
SetZoneSettings(BOARD self, ZONE_SETTINGS aSettings)

Definition at line 18901 of file pcbnew.py.

◆ SortedNetnamesList()

def pcbnew.BOARD.SortedNetnamesList (   self,
  aNames,
  aSortbyPadsCount 
)
SortedNetnamesList(BOARD self, wxArrayString & aNames, bool aSortbyPadsCount) -> int

Definition at line 19076 of file pcbnew.py.

◆ SynchronizeNetsAndNetClasses()

def pcbnew.BOARD.SynchronizeNetsAndNetClasses (   self)
SynchronizeNetsAndNetClasses(BOARD self)

Definition at line 19081 of file pcbnew.py.

◆ TestAreaIntersection()

def pcbnew.BOARD.TestAreaIntersection (   self,
  area_ref,
  area_to_test 
)
TestAreaIntersection(BOARD self, ZONE_CONTAINER area_ref, ZONE_CONTAINER area_to_test) -> bool

Definition at line 19161 of file pcbnew.py.

◆ TestAreaIntersections()

def pcbnew.BOARD.TestAreaIntersections (   self,
  area_to_test 
)
TestAreaIntersections(BOARD self, ZONE_CONTAINER area_to_test) -> bool

Definition at line 19156 of file pcbnew.py.

◆ Tracks()

def pcbnew.BOARD.Tracks (   self)
Tracks(BOARD self) -> DLIST_ITERATOR_WRAPPER< TRACK >

Definition at line 18596 of file pcbnew.py.

◆ TracksInNet()

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

Definition at line 19226 of file pcbnew.py.

◆ TracksInNetBetweenPoints()

def pcbnew.BOARD.TracksInNetBetweenPoints (   self,
  aStartPos,
  aGoalPos,
  aNetCode 
)
TracksInNetBetweenPoints(BOARD self, wxPoint aStartPos, wxPoint aGoalPos, int aNetCode) -> TRACKS

Definition at line 19231 of file pcbnew.py.

◆ Visit()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 19058 of file pcbnew.py.

◆ Zones()

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

Definition at line 18611 of file pcbnew.py.

Member Data Documentation

◆ ClassOf

pcbnew.BOARD.ClassOf = staticmethod(ClassOf)
static

Definition at line 18572 of file pcbnew.py.

◆ GetStandardLayerName

pcbnew.BOARD.GetStandardLayerName = staticmethod(GetStandardLayerName)
static

Definition at line 18954 of file pcbnew.py.

◆ m_CurrentZoneContour

pcbnew.BOARD.m_CurrentZoneContour = _swig_property(_pcbnew.BOARD_m_CurrentZoneContour_get, _pcbnew.BOARD_m_CurrentZoneContour_set)
static

Definition at line 18628 of file pcbnew.py.

◆ m_Modules

pcbnew.BOARD.m_Modules = _swig_property(_pcbnew.BOARD_m_Modules_get, _pcbnew.BOARD_m_Modules_set)
static

Definition at line 18590 of file pcbnew.py.

◆ m_Status_Pcb

pcbnew.BOARD.m_Status_Pcb = _swig_property(_pcbnew.BOARD_m_Status_Pcb_get, _pcbnew.BOARD_m_Status_Pcb_set)
static

Definition at line 18586 of file pcbnew.py.

◆ m_Track

pcbnew.BOARD.m_Track = _swig_property(_pcbnew.BOARD_m_Track_get, _pcbnew.BOARD_m_Track_set)
static

Definition at line 18594 of file pcbnew.py.

◆ this

pcbnew.BOARD.this

Definition at line 18636 of file pcbnew.py.


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