KiCAD pcbnew 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 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 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 Colors (self)
 
def SetColorsSettings (self, aColorsSettings)
 
def GetBoardPolygonOutlines (self, aOutlines, aErrorText=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)
 
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, 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=None)
 
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, 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 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)
 
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 SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, 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)
 
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_Zone = _swig_property(_pcbnew.BOARD_m_Zone_get, _pcbnew.BOARD_m_Zone_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 18779 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 18855 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 19352 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 18895 of file pcbnew.py.

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

Definition at line 18921 of file pcbnew.py.

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

Definition at line 19217 of file pcbnew.py.

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

Definition at line 18792 of file pcbnew.py.

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

Definition at line 19480 of file pcbnew.py.

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

Definition at line 19126 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 19372 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 19392 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 19240 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 19144 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 19475 of file pcbnew.py.

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

Definition at line 18926 of file pcbnew.py.

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

Definition at line 18931 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 19263 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 19271 of file pcbnew.py.

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

Definition at line 18836 of file pcbnew.py.

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

Definition at line 18846 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 18908 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 19286 of file pcbnew.py.

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

Definition at line 19281 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 19222 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 19524 of file pcbnew.py.

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

Definition at line 19337 of file pcbnew.py.

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

Definition at line 19347 of file pcbnew.py.

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

Definition at line 19342 of file pcbnew.py.

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

Definition at line 18951 of file pcbnew.py.

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

Definition at line 19253 of file pcbnew.py.

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

Definition at line 19136 of file pcbnew.py.

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

Definition at line 19248 of file pcbnew.py.

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

Definition at line 19312 of file pcbnew.py.

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

Definition at line 18916 of file pcbnew.py.

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

Definition at line 19006 of file pcbnew.py.

def pcbnew.BOARD.GetCurrentNetClassName (   self)

Definition at line 19496 of file pcbnew.py.

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

Definition at line 19076 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.BOARD.GetDrawings (   self)

Definition at line 19487 of file pcbnew.py.

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

Definition at line 19016 of file pcbnew.py.

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

Definition at line 18890 of file pcbnew.py.

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

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

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

Definition at line 18961 of file pcbnew.py.

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

Definition at line 18971 of file pcbnew.py.

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

Definition at line 19149 of file pcbnew.py.

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

Definition at line 19154 of file pcbnew.py.

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

Definition at line 19177 of file pcbnew.py.

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

Definition at line 19470 of file pcbnew.py.

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

Definition at line 18936 of file pcbnew.py.

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

Definition at line 18941 of file pcbnew.py.

def pcbnew.BOARD.GetModules (   self)

Definition at line 19486 of file pcbnew.py.

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

Definition at line 19258 of file pcbnew.py.

def pcbnew.BOARD.GetNetClasses (   self)

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

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

Definition at line 19235 of file pcbnew.py.

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

Definition at line 19230 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 19505 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 19511 of file pcbnew.py.

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

Definition at line 19197 of file pcbnew.py.

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

Definition at line 19187 of file pcbnew.py.

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

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

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

Definition at line 19207 of file pcbnew.py.

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

Definition at line 19413 of file pcbnew.py.

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

Definition at line 19212 of file pcbnew.py.

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

Definition at line 19086 of file pcbnew.py.

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

Definition at line 19096 of file pcbnew.py.

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

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

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

Definition at line 19164 of file pcbnew.py.

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

Definition at line 19106 of file pcbnew.py.

def pcbnew.BOARD.GetTracks (   self)

Definition at line 19488 of file pcbnew.py.

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

Definition at line 19405 of file pcbnew.py.

def pcbnew.BOARD.GetTrackWidthList (   self)

Definition at line 19502 of file pcbnew.py.

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

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

def pcbnew.BOARD.GetViasDimensionsList (   self)

Definition at line 19499 of file pcbnew.py.

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

Definition at line 19046 of file pcbnew.py.

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

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

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

Definition at line 19116 of file pcbnew.py.

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

Definition at line 18986 of file pcbnew.py.

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

Definition at line 18991 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 19317 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 19357 of file pcbnew.py.

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

Definition at line 19061 of file pcbnew.py.

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

Definition at line 18875 of file pcbnew.py.

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

Definition at line 18981 of file pcbnew.py.

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

Definition at line 19026 of file pcbnew.py.

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

Definition at line 19031 of file pcbnew.py.

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

Definition at line 19071 of file pcbnew.py.

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

Definition at line 19447 of file pcbnew.py.

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

Definition at line 18831 of file pcbnew.py.

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

Definition at line 18880 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 19362 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 19367 of file pcbnew.py.

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

Definition at line 19429 of file pcbnew.py.

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

Definition at line 19001 of file pcbnew.py.

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

Definition at line 18996 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 19322 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 19327 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 19377 of file pcbnew.py.

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

Definition at line 18903 of file pcbnew.py.

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

Definition at line 19294 of file pcbnew.py.

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

Definition at line 18966 of file pcbnew.py.

def pcbnew.BOARD.Save (   self,
  filename 
)

Definition at line 19490 of file pcbnew.py.

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

Definition at line 19332 of file pcbnew.py.

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

Definition at line 18946 of file pcbnew.py.

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

Definition at line 19131 of file pcbnew.py.

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

Definition at line 19011 of file pcbnew.py.

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

Definition at line 19081 of file pcbnew.py.

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

Definition at line 19066 of file pcbnew.py.

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

Definition at line 19021 of file pcbnew.py.

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

Definition at line 18885 of file pcbnew.py.

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

Definition at line 18800 of file pcbnew.py.

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

Definition at line 18956 of file pcbnew.py.

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

Definition at line 18976 of file pcbnew.py.

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

Definition at line 19172 of file pcbnew.py.

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

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

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

Definition at line 19091 of file pcbnew.py.

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

Definition at line 19101 of file pcbnew.py.

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

Definition at line 18870 of file pcbnew.py.

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

Definition at line 19111 of file pcbnew.py.

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

Definition at line 19056 of file pcbnew.py.

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

Definition at line 19051 of file pcbnew.py.

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

Definition at line 19041 of file pcbnew.py.

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

Definition at line 19121 of file pcbnew.py.

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

Definition at line 19302 of file pcbnew.py.

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

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

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

Definition at line 19382 of file pcbnew.py.

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

Definition at line 18826 of file pcbnew.py.

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

Definition at line 19452 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 19457 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 19276 of file pcbnew.py.

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

Definition at line 18841 of file pcbnew.py.

Member Data Documentation

pcbnew.BOARD.ClassOf = staticmethod(ClassOf)
static

Definition at line 18797 of file pcbnew.py.

pcbnew.BOARD.GetStandardLayerName = staticmethod(GetStandardLayerName)
static

Definition at line 19169 of file pcbnew.py.

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

Definition at line 18853 of file pcbnew.py.

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

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

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

Definition at line 18820 of file pcbnew.py.

pcbnew.BOARD.m_Zone = _swig_property(_pcbnew.BOARD_m_Zone_get, _pcbnew.BOARD_m_Zone_set)
static

Definition at line 18824 of file pcbnew.py.

pcbnew.BOARD.this

Definition at line 18861 of file pcbnew.py.


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