KiCad Pcbnew Python Scripting
Public Member Functions | Static Public Member Functions | Properties | List of all members
pcbnew.BOARD_CONNECTED_ITEM Class Reference
Inheritance diagram for pcbnew.BOARD_CONNECTED_ITEM:
Inheritance graph

Public Member Functions

def __init__ (self, *args, **kwargs)
def GetNet (self)
def SetNet (self, aNetInfo)
def GetNetCode (self)
def SetNetCode (self, *args)
def GetNetname (self)
def GetNetnameMsg (self)
def GetShortNetname (self)
def GetUnescapedShortNetname (self)
def GetOwnClearance (self, aLayer, aSource=None)
def GetLocalClearanceOverrides (self, aSource)
def GetLocalClearance (self, aSource)
def GetEffectiveNetClass (self)
def GetNetClassName (self)
def SetLocalRatsnestVisible (self, aVisible)
def GetLocalRatsnestVisible (self)
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
def SetParentGroup (self, aGroup)
def GetParentGroup (self)
def GetX (self)
def GetY (self)
def GetCenter (self)
def SetX (self, aX)
def SetY (self, aY)
def IsConnected (self)
def IsOnCopperLayer (self)
def HasHole (self)
def IsTented (self)
def GetEffectiveShape (self, *args)
def GetEffectiveHoleShape (self)
def GetParent (self)
def GetParentFootprint (self)
def HasLineStroke (self)
def GetStroke (self)
def SetStroke (self, aStroke)
def GetLayer (self)
def GetLayerSet (self)
def SetLayerSet (self, aLayers)
def SetLayer (self, aLayer)
def Duplicate (self)
def SwapItemData (self, aImage)
def IsOnLayer (self, aLayer)
def IsKnockout (self)
def SetIsKnockout (self, aKnockout)
def IsLocked (self)
def SetLocked (self, aLocked)
def DeleteStructure (self)
def Move (self, aMoveVector)
def Rotate (self, aRotCentre, aAngle)
def Flip (self, aCentre, aFlipLeftRight)
def GetBoard (self, *args)
def GetLayerName (self)
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
def Cast (self)
def Duplicate (self)
def SetPos (self, p)
def SetStartEnd (self, start, end)
- Public Member Functions inherited from pcbnew.EDA_ITEM
def __init__ (self, *args, **kwargs)
def Type (self)
def GetParent (self)
def SetParent (self, aParent)
def IsModified (self)
def IsNew (self)
def IsMoving (self)
def IsSelected (self)
def IsEntered (self)
def IsBrightened (self)
def IsRollover (self)
def SetSelected (self)
def SetBrightened (self)
def ClearSelected (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 XorFlags (self, aMask)
def ClearFlags (self, *args)
def GetFlags (self)
def HasFlag (self, aFlag)
def GetEditFlags (self)
def ClearTempFlags (self)
def ClearEditFlags (self)
def RenderAsBitmap (self, aWorldScale)
def SetIsShownAsBitmap (self, aBitmap)
def IsShownAsBitmap (self)
def IsType (self, aScanTypes)
def SetForceVisible (self, aEnable)
def IsForceVisible (self)
def GetMsgPanelInfo (self, aFrame, aList)
def GetFriendlyName (self)
def HitTest (self, *args)
def GetBoundingBox (self)
def GetPosition (self)
def SetPosition (self, aPos)
def GetFocusPosition (self)
def GetSortPosition (self)
def Clone (self)
def Visit (self, inspector, testData, aScanTypes)
def GetClass (self)
def GetTypeDesc (self)
def GetItemDescription (self, aUnitsProvider)
def GetMenuImage (self)
def Matches (self, aSearchData, aAuxData)
def Replace (self, *args)
def IsReplaceable (self)
def __lt__ (self, aItem)
def ViewBBox (self)
def ViewGetLayers (self, aLayers, aCount)

Static Public Member Functions

def ClassOf (aItem)
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, aRight)


 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
- Properties inherited from pcbnew.BOARD_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
- Properties inherited from pcbnew.EDA_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)

Detailed Description

Proxy of C++ BOARD_CONNECTED_ITEM class.

Definition at line 9961 of file

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.BOARD_CONNECTED_ITEM.__init__ (   self,
**  kwargs 

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PAD, pcbnew.PCB_ARC, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.FP_ZONE, and pcbnew.PCB_TRACK.

Definition at line 9966 of file

Member Function Documentation

◆ ClassOf()

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

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_VIA, and pcbnew.ZONE.

Definition at line 9971 of file

◆ GetEffectiveNetClass()

def pcbnew.BOARD_CONNECTED_ITEM.GetEffectiveNetClass (   self)

Definition at line 10022 of file

◆ GetLocalClearance()

def pcbnew.BOARD_CONNECTED_ITEM.GetLocalClearance (   self,
GetLocalClearance(BOARD_CONNECTED_ITEM self, wxString aSource) -> int

Reimplemented in pcbnew.PAD, and pcbnew.ZONE.

Definition at line 10018 of file

◆ GetLocalClearanceOverrides()

def pcbnew.BOARD_CONNECTED_ITEM.GetLocalClearanceOverrides (   self,
GetLocalClearanceOverrides(BOARD_CONNECTED_ITEM self, wxString aSource) -> int

Definition at line 10014 of file

◆ GetLocalRatsnestVisible()

def pcbnew.BOARD_CONNECTED_ITEM.GetLocalRatsnestVisible (   self)
GetLocalRatsnestVisible(BOARD_CONNECTED_ITEM self) -> bool

Definition at line 10034 of file

◆ GetNet()

def pcbnew.BOARD_CONNECTED_ITEM.GetNet (   self)

Definition at line 9975 of file

◆ GetNetClassName()

def pcbnew.BOARD_CONNECTED_ITEM.GetNetClassName (   self)
GetNetClassName(BOARD_CONNECTED_ITEM self) -> wxString

Definition at line 10026 of file

◆ GetNetCode()

def pcbnew.BOARD_CONNECTED_ITEM.GetNetCode (   self)
GetNetCode(BOARD_CONNECTED_ITEM self) -> int

Definition at line 9983 of file

◆ GetNetname()

def pcbnew.BOARD_CONNECTED_ITEM.GetNetname (   self)
GetNetname(BOARD_CONNECTED_ITEM self) -> wxString

Definition at line 9994 of file

◆ GetNetnameMsg()

def pcbnew.BOARD_CONNECTED_ITEM.GetNetnameMsg (   self)
GetNetnameMsg(BOARD_CONNECTED_ITEM self) -> wxString

Definition at line 9998 of file

◆ GetOwnClearance()

def pcbnew.BOARD_CONNECTED_ITEM.GetOwnClearance (   self,
  aSource = None 
GetOwnClearance(BOARD_CONNECTED_ITEM self, PCB_LAYER_ID aLayer, wxString aSource=None) -> int

Reimplemented in pcbnew.PAD.

Definition at line 10010 of file

◆ GetShortNetname()

def pcbnew.BOARD_CONNECTED_ITEM.GetShortNetname (   self)
GetShortNetname(BOARD_CONNECTED_ITEM self) -> wxString

Definition at line 10002 of file

◆ GetUnescapedShortNetname()

def pcbnew.BOARD_CONNECTED_ITEM.GetUnescapedShortNetname (   self)
GetUnescapedShortNetname(BOARD_CONNECTED_ITEM self) -> wxString

Definition at line 10006 of file

◆ SetLocalRatsnestVisible()

def pcbnew.BOARD_CONNECTED_ITEM.SetLocalRatsnestVisible (   self,
SetLocalRatsnestVisible(BOARD_CONNECTED_ITEM self, bool aVisible)

Definition at line 10030 of file

◆ SetNet()

def pcbnew.BOARD_CONNECTED_ITEM.SetNet (   self,

Definition at line 9979 of file

◆ SetNetCode()

def pcbnew.BOARD_CONNECTED_ITEM.SetNetCode (   self,
    SetNetCode(BOARD_CONNECTED_ITEM self, int aNetCode, bool aNoAssert) -> bool
    SetNetCode(BOARD_CONNECTED_ITEM self, int aNetCode)

Definition at line 9987 of file

Here is the caller graph for this function:

Property Documentation

◆ thisown

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

Definition at line 9964 of file

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