KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.BOARD_CONNECTED_ITEM Class Reference
Inheritance diagram for pcbnew.BOARD_CONNECTED_ITEM:

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 GetNet (self)
 
 SetNet (self, aNetInfo)
 
 UnpackNet (self, aProto)
 
 PackNet (self, aProto)
 
 GetNetCode (self)
 
 SetNetCode (self, *args)
 
 GetNetname (self)
 
 GetNetnameMsg (self)
 
 GetShortNetname (self)
 
 GetDisplayNetname (self)
 
 GetOwnClearance (self, aLayer, aSource=None)
 
 GetClearanceOverrides (self, aSource)
 
 GetLocalClearance (self, *args)
 
 GetEffectiveNetClass (self)
 
 GetNetClassName (self)
 
 SetLocalRatsnestVisible (self, aVisible)
 
 GetLocalRatsnestVisible (self)
 
 GetTeardropParams (self, *args)
 
 SetTeardropsEnabled (self, aEnable)
 
 GetTeardropsEnabled (self)
 
 SetTeardropBestLengthRatio (self, aRatio)
 
 GetTeardropBestLengthRatio (self)
 
 SetTeardropMaxLength (self, aMaxLength)
 
 GetTeardropMaxLength (self)
 
 SetTeardropBestWidthRatio (self, aRatio)
 
 GetTeardropBestWidthRatio (self)
 
 SetTeardropMaxWidth (self, aMaxWidth)
 
 GetTeardropMaxWidth (self)
 
 SetTeardropCurved (self, aCurve)
 
 GetTeardropCurved (self)
 
 SetTeardropPreferZoneConnections (self, aPrefer)
 
 GetTeardropPreferZoneConnections (self)
 
 SetTeardropAllowSpanTwoTracks (self, aAllow)
 
 GetTeardropAllowSpanTwoTracks (self)
 
 SetTeardropMaxTrackWidth (self, aRatio)
 
 GetTeardropMaxTrackWidth (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
 __init__ (self, *args, **kwargs)
 
 CopyFrom (self, aOther)
 
 IsGroupableType (self)
 
 GetX (self)
 
 GetY (self)
 
 GetCenter (self)
 
 SetX (self, aX)
 
 SetY (self, aY)
 
 IsConnected (self)
 
 Similarity (self, aItem)
 
 __eq__ (self, aItem)
 
 IsOnCopperLayer (self)
 
 HasHole (self)
 
 HasDrilledHole (self)
 
 IsTented (self, aLayer)
 
 GetEffectiveShape (self, *args)
 
 GetEffectiveHoleShape (self)
 
 RunOnChildren (self, aFunction, aMode)
 
 GetParent (self)
 
 GetParentFootprint (self)
 
 GetFPRelativePosition (self)
 
 SetFPRelativePosition (self, aPos)
 
 HasLineStroke (self)
 
 GetStroke (self)
 
 SetStroke (self, aStroke)
 
 GetFontMetrics (self)
 
 GetLayer (self)
 
 BoardLayerCount (self)
 
 BoardCopperLayerCount (self)
 
 BoardLayerSet (self)
 
 GetLayerSet (self)
 
 SetLayerSet (self, aLayers)
 
 IsSideSpecific (self)
 
 SetLayer (self, aLayer)
 
 Duplicate (self, addToParentGroup, aCommit=None)
 
 SwapItemData (self, aImage)
 
 IsOnLayer (self, aLayer)
 
 IsKnockout (self)
 
 SetIsKnockout (self, aKnockout)
 
 GetMaxError (self)
 
 StyleFromSettings (self, settings, aCheckSide)
 
 DeleteStructure (self)
 
 Move (self, aMoveVector)
 
 Rotate (self, aRotCentre, aAngle)
 
 Flip (self, aCentre, aFlipDirection)
 
 Mirror (self, aCentre, aFlipDirection)
 
 Normalize (self)
 
 NormalizeForCompare (self)
 
 GetBoard (self, *args)
 
 GetParentAsString (self)
 
 GetLayerName (self)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aRenderSettings=None)
 
 LayerMaskDescribe (self)
 
 Cast (self)
 
 Duplicate (self)
 
 SetPos (self, p)
 
 SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
 __init__ (self, *args, **kwargs)
 
 Type (self)
 
 SetParent (self, aParent)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 IsLocked (self)
 
 SetLocked (self, aLocked)
 
 IsModified (self)
 
 IsNew (self)
 
 IsMoving (self)
 
 IsSelected (self)
 
 IsEntered (self)
 
 IsBrightened (self)
 
 IsRollover (self)
 
 GetRolloverPos (self)
 
 SetIsRollover (self, aIsRollover, aMousePos)
 
 SetSelected (self)
 
 SetBrightened (self)
 
 ClearSelected (self)
 
 ClearBrightened (self)
 
 SetModified (self)
 
 SetFlags (self, aMask)
 
 XorFlags (self, aMask)
 
 ClearFlags (self, *args)
 
 GetFlags (self)
 
 HasFlag (self, aFlag)
 
 GetEditFlags (self)
 
 ClearEditFlags (self)
 
 GetTempFlags (self)
 
 ClearTempFlags (self)
 
 RenderAsBitmap (self, aWorldScale)
 
 SetIsShownAsBitmap (self, aBitmap)
 
 IsShownAsBitmap (self)
 
 IsType (self, aScanTypes)
 
 SetForceVisible (self, aEnable)
 
 IsForceVisible (self)
 
 GetMsgPanelInfo (self, aFrame, aList)
 
 GetFriendlyName (self)
 
 HitTest (self, *args)
 
 GetBoundingBox (self)
 
 GetPosition (self)
 
 SetPosition (self, aPos)
 
 GetFocusPosition (self)
 
 GetSortPosition (self)
 
 Clone (self)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (self, aUnitsProvider, aFull)
 
 DisambiguateItemDescription (self, aUnitsProvider, aFull)
 
 GetMenuImage (self)
 
 Matches (self, aSearchData, aAuxData)
 
 Replace (self, *args)
 
 IsReplaceable (self)
 
 __lt__ (self, aItem)
 
 ViewBBox (self)
 
 ViewGetLayers (self)
 
 GetEmbeddedFiles (self)
 
 GetEmbeddedFonts (self)
 
 PyGetClass (self)
 
 GetClass (self)
 

Static Public Member Functions

 ClassOf (aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
 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=)
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 DRC = _pcbnew.BOARD_ITEM_DRC
 
 INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Detailed Description

Proxy of C++ BOARD_CONNECTED_ITEM class.

Definition at line 11236 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 11241 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

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

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

Definition at line 11246 of file pcbnew.py.

◆ GetClearanceOverrides()

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

Definition at line 11297 of file pcbnew.py.

◆ GetDisplayNetname()

pcbnew.BOARD_CONNECTED_ITEM.GetDisplayNetname ( self)
GetDisplayNetname(BOARD_CONNECTED_ITEM self) -> wxString

Definition at line 11289 of file pcbnew.py.

◆ GetEffectiveNetClass()

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

Definition at line 11308 of file pcbnew.py.

◆ GetLocalClearance()

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

◆ GetLocalRatsnestVisible()

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

Definition at line 11320 of file pcbnew.py.

◆ GetNet()

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

Definition at line 11250 of file pcbnew.py.

◆ GetNetClassName()

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

Definition at line 11312 of file pcbnew.py.

◆ GetNetCode()

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

Definition at line 11266 of file pcbnew.py.

◆ GetNetname()

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

Definition at line 11277 of file pcbnew.py.

◆ GetNetnameMsg()

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

Definition at line 11281 of file pcbnew.py.

◆ GetOwnClearance()

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

◆ GetShortNetname()

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

Definition at line 11285 of file pcbnew.py.

◆ GetTeardropAllowSpanTwoTracks()

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

Definition at line 11391 of file pcbnew.py.

◆ GetTeardropBestLengthRatio()

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

Definition at line 11343 of file pcbnew.py.

◆ GetTeardropBestWidthRatio()

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

Definition at line 11359 of file pcbnew.py.

◆ GetTeardropCurved()

pcbnew.BOARD_CONNECTED_ITEM.GetTeardropCurved ( self)
GetTeardropCurved(BOARD_CONNECTED_ITEM self) -> bool

Definition at line 11375 of file pcbnew.py.

◆ GetTeardropMaxLength()

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

Definition at line 11351 of file pcbnew.py.

◆ GetTeardropMaxTrackWidth()

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

Definition at line 11399 of file pcbnew.py.

◆ GetTeardropMaxWidth()

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

Definition at line 11367 of file pcbnew.py.

◆ GetTeardropParams()

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

◆ GetTeardropPreferZoneConnections()

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

Definition at line 11383 of file pcbnew.py.

◆ GetTeardropsEnabled()

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

Definition at line 11335 of file pcbnew.py.

◆ PackNet()

pcbnew.BOARD_CONNECTED_ITEM.PackNet ( self,
aProto )
PackNet(BOARD_CONNECTED_ITEM self, kiapi::board::types::Net * aProto)

Definition at line 11262 of file pcbnew.py.

◆ SetLocalRatsnestVisible()

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

Definition at line 11316 of file pcbnew.py.

◆ SetNet()

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

Definition at line 11254 of file pcbnew.py.

◆ SetNetCode()

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

◆ SetTeardropAllowSpanTwoTracks()

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

Definition at line 11387 of file pcbnew.py.

◆ SetTeardropBestLengthRatio()

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

Definition at line 11339 of file pcbnew.py.

◆ SetTeardropBestWidthRatio()

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

Definition at line 11355 of file pcbnew.py.

◆ SetTeardropCurved()

pcbnew.BOARD_CONNECTED_ITEM.SetTeardropCurved ( self,
aCurve )
SetTeardropCurved(BOARD_CONNECTED_ITEM self, bool aCurve)

Definition at line 11371 of file pcbnew.py.

◆ SetTeardropMaxLength()

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

Definition at line 11347 of file pcbnew.py.

◆ SetTeardropMaxTrackWidth()

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

Definition at line 11395 of file pcbnew.py.

◆ SetTeardropMaxWidth()

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

Definition at line 11363 of file pcbnew.py.

◆ SetTeardropPreferZoneConnections()

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

Definition at line 11379 of file pcbnew.py.

◆ SetTeardropsEnabled()

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

Definition at line 11331 of file pcbnew.py.

◆ UnpackNet()

pcbnew.BOARD_CONNECTED_ITEM.UnpackNet ( self,
aProto )
UnpackNet(BOARD_CONNECTED_ITEM self, kiapi::board::types::Net const & aProto)

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


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