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 GetNumSegmZone (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 ReplaceNetlist (self, aNetlist, aDeleteSinglePadNets, aNewFootprints, aReporter)
 
def updateComponentPadConnections (self, aNetlist, footprint, component, aReporter)
 
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 AddNative (self, aItem, aMode=ADD_INSERT)
 
def RemoveNative (self, aItem)
 
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 GetPosition (self)
 
def GetCenter (self)
 
def SetPosition (self, aPos)
 
def IsConnected (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def Draw (self, args)
 
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 HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
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 __init__ (self, args, kwargs)
 
def Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (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 IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aUnits, aList)
 
def HitTest (self, aPosition)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self, aUnits)
 
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)
 
def ViewGetLayers (self, aLayers, aCount)
 

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_SegZoneDeprecated = _swig_property(_pcbnew.BOARD_m_SegZoneDeprecated_get, _pcbnew.BOARD_m_SegZoneDeprecated_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)
 
 FormatAngle = staticmethod(FormatAngle)
 
 FormatInternalUnits = staticmethod(FormatInternalUnits)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
 IterateForward = staticmethod(IterateForward)
 
 Sort = staticmethod(Sort)
 

Detailed Description

Proxy of C++ BOARD class.

Definition at line 19629 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 19710 of file pcbnew.py.

Member Function Documentation

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

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)

Definition at line 19750 of file pcbnew.py.

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

Definition at line 19696 of file pcbnew.py.

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

Definition at line 19781 of file pcbnew.py.

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

Definition at line 20086 of file pcbnew.py.

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

Definition at line 19642 of file pcbnew.py.

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

Definition at line 20351 of file pcbnew.py.

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

Definition at line 19991 of file pcbnew.py.

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

Definition at line 20243 of file pcbnew.py.

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

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

Definition at line 20109 of file pcbnew.py.

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

Definition at line 20010 of file pcbnew.py.

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

Definition at line 20346 of file pcbnew.py.

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

Definition at line 19786 of file pcbnew.py.

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

Definition at line 19791 of file pcbnew.py.

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)

Definition at line 20132 of file pcbnew.py.

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

Definition at line 20140 of file pcbnew.py.

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

Definition at line 19686 of file pcbnew.py.

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

Definition at line 19701 of file pcbnew.py.

Here is the caller graph for this function:

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

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

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

Definition at line 20150 of file pcbnew.py.

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

Definition at line 20091 of file pcbnew.py.

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

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

Definition at line 20208 of file pcbnew.py.

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

Definition at line 20218 of file pcbnew.py.

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

Definition at line 20213 of file pcbnew.py.

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

Definition at line 19811 of file pcbnew.py.

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

Definition at line 20122 of file pcbnew.py.

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

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

Definition at line 20117 of file pcbnew.py.

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

Definition at line 20183 of file pcbnew.py.

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

Definition at line 19776 of file pcbnew.py.

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

Definition at line 19866 of file pcbnew.py.

def pcbnew.BOARD.GetCurrentNetClassName (   self)

Definition at line 20372 of file pcbnew.py.

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

Definition at line 19936 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.BOARD.GetDrawings (   self)

Definition at line 20363 of file pcbnew.py.

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

Definition at line 19876 of file pcbnew.py.

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

Definition at line 19745 of file pcbnew.py.

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

Definition at line 19655 of file pcbnew.py.

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

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

Definition at line 19821 of file pcbnew.py.

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

Definition at line 19831 of file pcbnew.py.

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

Definition at line 19763 of file pcbnew.py.

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

Definition at line 20015 of file pcbnew.py.

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

Definition at line 20020 of file pcbnew.py.

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

Definition at line 20043 of file pcbnew.py.

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

Definition at line 20341 of file pcbnew.py.

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

Definition at line 19796 of file pcbnew.py.

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

Definition at line 19801 of file pcbnew.py.

def pcbnew.BOARD.GetModules (   self)

Definition at line 20362 of file pcbnew.py.

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)

Definition at line 20127 of file pcbnew.py.

def pcbnew.BOARD.GetNetClasses (   self)

Definition at line 20369 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 20393 of file pcbnew.py.

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

Definition at line 20104 of file pcbnew.py.

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

Definition at line 20099 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 20381 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 20387 of file pcbnew.py.

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

Definition at line 20063 of file pcbnew.py.

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

Definition at line 20053 of file pcbnew.py.

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

Definition at line 20058 of file pcbnew.py.

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

Here is the caller graph for this function:

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

Definition at line 20076 of file pcbnew.py.

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

Definition at line 20284 of file pcbnew.py.

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

Definition at line 20081 of file pcbnew.py.

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

Definition at line 19946 of file pcbnew.py.

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

Definition at line 19956 of file pcbnew.py.

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

Definition at line 19720 of file pcbnew.py.

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

Definition at line 19986 of file pcbnew.py.

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

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

Definition at line 20030 of file pcbnew.py.

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

Definition at line 19966 of file pcbnew.py.

def pcbnew.BOARD.GetTracks (   self)

Definition at line 20364 of file pcbnew.py.

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

def pcbnew.BOARD.GetTrackWidthList (   self)

Definition at line 20378 of file pcbnew.py.

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

Definition at line 20071 of file pcbnew.py.

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

def pcbnew.BOARD.GetViasDimensionsList (   self)

Definition at line 20375 of file pcbnew.py.

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

Definition at line 19906 of file pcbnew.py.

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

Definition at line 19896 of file pcbnew.py.

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

Definition at line 20313 of file pcbnew.py.

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

Definition at line 19976 of file pcbnew.py.

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

Definition at line 19846 of file pcbnew.py.

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

Definition at line 19851 of file pcbnew.py.

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

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

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

Definition at line 19921 of file pcbnew.py.

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

Definition at line 19730 of file pcbnew.py.

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

Definition at line 19841 of file pcbnew.py.

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

Definition at line 19886 of file pcbnew.py.

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

Definition at line 19891 of file pcbnew.py.

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

Definition at line 19931 of file pcbnew.py.

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

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

Definition at line 19681 of file pcbnew.py.

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

Definition at line 19735 of file pcbnew.py.

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

Definition at line 20233 of file pcbnew.py.

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

Definition at line 20238 of file pcbnew.py.

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

Definition at line 20300 of file pcbnew.py.

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

Definition at line 19861 of file pcbnew.py.

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

Definition at line 19856 of file pcbnew.py.

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

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

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

Definition at line 20248 of file pcbnew.py.

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

Definition at line 19758 of file pcbnew.py.

def pcbnew.BOARD.ReplaceNetlist (   self,
  aNetlist,
  aDeleteSinglePadNets,
  aNewFootprints,
  aReporter 
)
ReplaceNetlist(BOARD self, NETLIST & aNetlist, bool aDeleteSinglePadNets, std::vector< MODULE *,std::allocator< MODULE * > > * aNewFootprints, REPORTER & aReporter)

Definition at line 20163 of file pcbnew.py.

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

Definition at line 19826 of file pcbnew.py.

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

Definition at line 20356 of file pcbnew.py.

def pcbnew.BOARD.Save (   self,
  filename 
)

Definition at line 20366 of file pcbnew.py.

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

Definition at line 20203 of file pcbnew.py.

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

Definition at line 19806 of file pcbnew.py.

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

Definition at line 19996 of file pcbnew.py.

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

Definition at line 19871 of file pcbnew.py.

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

Definition at line 19941 of file pcbnew.py.

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

Definition at line 19926 of file pcbnew.py.

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

Definition at line 19881 of file pcbnew.py.

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

Definition at line 19740 of file pcbnew.py.

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

Definition at line 19650 of file pcbnew.py.

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

Definition at line 19816 of file pcbnew.py.

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

Definition at line 19836 of file pcbnew.py.

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

Definition at line 20038 of file pcbnew.py.

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

Definition at line 20025 of file pcbnew.py.

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

Definition at line 20048 of file pcbnew.py.

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

Definition at line 19951 of file pcbnew.py.

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

Definition at line 19961 of file pcbnew.py.

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

Definition at line 19725 of file pcbnew.py.

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

Definition at line 19971 of file pcbnew.py.

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

Definition at line 19916 of file pcbnew.py.

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

Definition at line 19911 of file pcbnew.py.

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

Definition at line 19901 of file pcbnew.py.

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

Definition at line 19981 of file pcbnew.py.

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

Definition at line 20173 of file pcbnew.py.

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

Definition at line 20178 of file pcbnew.py.

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

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

Definition at line 20253 of file pcbnew.py.

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

Definition at line 19676 of file pcbnew.py.

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

Definition at line 20323 of file pcbnew.py.

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

Definition at line 20328 of file pcbnew.py.

def pcbnew.BOARD.updateComponentPadConnections (   self,
  aNetlist,
  footprint,
  component,
  aReporter 
)
updateComponentPadConnections(BOARD self, NETLIST & aNetlist, MODULE footprint, COMPONENT * component, REPORTER & aReporter)

Definition at line 20168 of file pcbnew.py.

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

Definition at line 20145 of file pcbnew.py.

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

Definition at line 19691 of file pcbnew.py.

Member Data Documentation

pcbnew.BOARD.ClassOf = staticmethod(ClassOf)
static

Definition at line 19647 of file pcbnew.py.

pcbnew.BOARD.GetStandardLayerName = staticmethod(GetStandardLayerName)
static

Definition at line 20035 of file pcbnew.py.

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

Definition at line 19708 of file pcbnew.py.

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

Definition at line 19666 of file pcbnew.py.

pcbnew.BOARD.m_SegZoneDeprecated = _swig_property(_pcbnew.BOARD_m_SegZoneDeprecated_get, _pcbnew.BOARD_m_SegZoneDeprecated_set)
static

Definition at line 19674 of file pcbnew.py.

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

Definition at line 19662 of file pcbnew.py.

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

Definition at line 19670 of file pcbnew.py.

pcbnew.BOARD.this

Definition at line 19716 of file pcbnew.py.


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