KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
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
[legend]

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 GetClearanceOverrides (self, aSource)
 
def GetLocalClearance (self, *args)
 
def GetEffectiveNetClass (self)
 
def GetNetClassName (self)
 
def SetLocalRatsnestVisible (self, aVisible)
 
def GetLocalRatsnestVisible (self)
 
def GetTeardropParams (self, *args)
 
def SetTeardropsEnabled (self, aEnable)
 
def GetTeardropsEnabled (self)
 
def SetTeardropBestLengthRatio (self, aRatio)
 
def GetTeardropBestLengthRatio (self)
 
def SetTeardropMaxLength (self, aMaxLength)
 
def GetTeardropMaxLength (self)
 
def SetTeardropBestWidthRatio (self, aRatio)
 
def GetTeardropBestWidthRatio (self)
 
def SetTeardropMaxWidth (self, aMaxWidth)
 
def GetTeardropMaxWidth (self)
 
def SetTeardropCurvePts (self, aPointCount)
 
def GetTeardropCurvePts (self)
 
def SetTeardropPreferZoneConnections (self, aPrefer)
 
def GetTeardropPreferZoneConnections (self)
 
def SetTeardropAllowSpanTwoTracks (self, aAllow)
 
def GetTeardropAllowSpanTwoTracks (self)
 
def SetTeardropMaxTrackWidth (self, aRatio)
 
def GetTeardropMaxTrackWidth (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 Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def IsTented (self)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
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 StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def Normalize (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
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 SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearEditFlags (self)
 
def GetTempFlags (self)
 
def ClearTempFlags (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)
 

Properties

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

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from pcbnew.BOARD_ITEM.

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

Definition at line 10288 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

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

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

Definition at line 10293 of file pcbnew.py.

◆ GetClearanceOverrides()

def pcbnew.BOARD_CONNECTED_ITEM.GetClearanceOverrides (   self,
  aSource 
)
GetClearanceOverrides(BOARD_CONNECTED_ITEM self, wxString aSource) -> std::optional< int >

Definition at line 10336 of file pcbnew.py.

◆ GetEffectiveNetClass()

def pcbnew.BOARD_CONNECTED_ITEM.GetEffectiveNetClass (   self)
GetEffectiveNetClass(BOARD_CONNECTED_ITEM self) -> NETCLASS

Definition at line 10347 of file pcbnew.py.

◆ GetLocalClearance()

def pcbnew.BOARD_CONNECTED_ITEM.GetLocalClearance (   self,
args 
)
    GetLocalClearance(BOARD_CONNECTED_ITEM self) -> std::optional< int >
    GetLocalClearance(BOARD_CONNECTED_ITEM self, wxString aSource) -> std::optional< int >

Reimplemented in pcbnew.PAD, and pcbnew.ZONE.

Definition at line 10340 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLocalRatsnestVisible()

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

Definition at line 10359 of file pcbnew.py.

◆ GetNet()

def pcbnew.BOARD_CONNECTED_ITEM.GetNet (   self)
GetNet(BOARD_CONNECTED_ITEM self) -> NETINFO_ITEM

Definition at line 10297 of file pcbnew.py.

◆ GetNetClassName()

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

Definition at line 10351 of file pcbnew.py.

◆ GetNetCode()

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

Definition at line 10305 of file pcbnew.py.

◆ GetNetname()

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

Definition at line 10316 of file pcbnew.py.

◆ GetNetnameMsg()

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

Definition at line 10320 of file pcbnew.py.

◆ GetOwnClearance()

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

Reimplemented in pcbnew.PAD.

Definition at line 10332 of file pcbnew.py.

◆ GetShortNetname()

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

Definition at line 10324 of file pcbnew.py.

◆ GetTeardropAllowSpanTwoTracks()

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

Definition at line 10430 of file pcbnew.py.

◆ GetTeardropBestLengthRatio()

def pcbnew.BOARD_CONNECTED_ITEM.GetTeardropBestLengthRatio (   self)
GetTeardropBestLengthRatio(BOARD_CONNECTED_ITEM self) -> double

Definition at line 10382 of file pcbnew.py.

◆ GetTeardropBestWidthRatio()

def pcbnew.BOARD_CONNECTED_ITEM.GetTeardropBestWidthRatio (   self)
GetTeardropBestWidthRatio(BOARD_CONNECTED_ITEM self) -> double

Definition at line 10398 of file pcbnew.py.

◆ GetTeardropCurvePts()

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

Definition at line 10414 of file pcbnew.py.

◆ GetTeardropMaxLength()

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

Definition at line 10390 of file pcbnew.py.

◆ GetTeardropMaxTrackWidth()

def pcbnew.BOARD_CONNECTED_ITEM.GetTeardropMaxTrackWidth (   self)
GetTeardropMaxTrackWidth(BOARD_CONNECTED_ITEM self) -> double

Definition at line 10438 of file pcbnew.py.

◆ GetTeardropMaxWidth()

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

Definition at line 10406 of file pcbnew.py.

◆ GetTeardropParams()

def pcbnew.BOARD_CONNECTED_ITEM.GetTeardropParams (   self,
args 
)
    GetTeardropParams(BOARD_CONNECTED_ITEM self) -> TEARDROP_PARAMETERS
    GetTeardropParams(BOARD_CONNECTED_ITEM self) -> TEARDROP_PARAMETERS const &

Definition at line 10363 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetTeardropPreferZoneConnections()

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

Definition at line 10422 of file pcbnew.py.

◆ GetTeardropsEnabled()

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

Definition at line 10374 of file pcbnew.py.

◆ GetUnescapedShortNetname()

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

Definition at line 10328 of file pcbnew.py.

◆ SetLocalRatsnestVisible()

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

Definition at line 10355 of file pcbnew.py.

◆ SetNet()

def pcbnew.BOARD_CONNECTED_ITEM.SetNet (   self,
  aNetInfo 
)
SetNet(BOARD_CONNECTED_ITEM self, NETINFO_ITEM aNetInfo)

Definition at line 10301 of file pcbnew.py.

◆ SetNetCode()

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

Definition at line 10309 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetTeardropAllowSpanTwoTracks()

def pcbnew.BOARD_CONNECTED_ITEM.SetTeardropAllowSpanTwoTracks (   self,
  aAllow 
)
SetTeardropAllowSpanTwoTracks(BOARD_CONNECTED_ITEM self, bool aAllow)

Definition at line 10426 of file pcbnew.py.

◆ SetTeardropBestLengthRatio()

def pcbnew.BOARD_CONNECTED_ITEM.SetTeardropBestLengthRatio (   self,
  aRatio 
)
SetTeardropBestLengthRatio(BOARD_CONNECTED_ITEM self, double aRatio)

Definition at line 10378 of file pcbnew.py.

◆ SetTeardropBestWidthRatio()

def pcbnew.BOARD_CONNECTED_ITEM.SetTeardropBestWidthRatio (   self,
  aRatio 
)
SetTeardropBestWidthRatio(BOARD_CONNECTED_ITEM self, double aRatio)

Definition at line 10394 of file pcbnew.py.

◆ SetTeardropCurvePts()

def pcbnew.BOARD_CONNECTED_ITEM.SetTeardropCurvePts (   self,
  aPointCount 
)
SetTeardropCurvePts(BOARD_CONNECTED_ITEM self, int aPointCount)

Definition at line 10410 of file pcbnew.py.

◆ SetTeardropMaxLength()

def pcbnew.BOARD_CONNECTED_ITEM.SetTeardropMaxLength (   self,
  aMaxLength 
)
SetTeardropMaxLength(BOARD_CONNECTED_ITEM self, int aMaxLength)

Definition at line 10386 of file pcbnew.py.

◆ SetTeardropMaxTrackWidth()

def pcbnew.BOARD_CONNECTED_ITEM.SetTeardropMaxTrackWidth (   self,
  aRatio 
)
SetTeardropMaxTrackWidth(BOARD_CONNECTED_ITEM self, double aRatio)

Definition at line 10434 of file pcbnew.py.

◆ SetTeardropMaxWidth()

def pcbnew.BOARD_CONNECTED_ITEM.SetTeardropMaxWidth (   self,
  aMaxWidth 
)
SetTeardropMaxWidth(BOARD_CONNECTED_ITEM self, int aMaxWidth)

Definition at line 10402 of file pcbnew.py.

◆ SetTeardropPreferZoneConnections()

def pcbnew.BOARD_CONNECTED_ITEM.SetTeardropPreferZoneConnections (   self,
  aPrefer 
)
SetTeardropPreferZoneConnections(BOARD_CONNECTED_ITEM self, bool aPrefer)

Definition at line 10418 of file pcbnew.py.

◆ SetTeardropsEnabled()

def pcbnew.BOARD_CONNECTED_ITEM.SetTeardropsEnabled (   self,
  aEnable 
)
SetTeardropsEnabled(BOARD_CONNECTED_ITEM self, bool aEnable)

Definition at line 10370 of file pcbnew.py.

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")
static

Definition at line 10286 of file pcbnew.py.


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