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

Public Member Functions

 __init__ (self, *args)
 
 GetClass (self)
 
 SetNetClass (self, aNetClass)
 
 GetNetClass (self)
 
 GetNetClassSlow (self)
 
 GetNetCode (self)
 
 SetNetCode (self, aNetCode)
 
 GetNetname (self)
 
 GetShortNetname (self)
 
 GetDisplayNetname (self)
 
 HasAutoGeneratedNetname (self)
 
 SetNetname (self, aNewName)
 
 IsCurrent (self)
 
 SetIsCurrent (self, isCurrent)
 
 Clear (self)
 
 SetParent (self, aParent)
 
 GetParent (self)
 
 GetNetClassName (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)
 
 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)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 HasSelectedAncestorGroup (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)
 

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++ NETINFO_ITEM class.

Definition at line 20173 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.NETINFO_ITEM.__init__ ( self,
* args )
__init__(NETINFO_ITEM self, BOARD aParent, wxString aNetName=wxEmptyString, int aNetCode=-1) -> NETINFO_ITEM

Definition at line 20179 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

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

Definition at line 20185 of file pcbnew.py.

◆ Clear()

pcbnew.NETINFO_ITEM.Clear ( self)
Clear(NETINFO_ITEM self)

Definition at line 20241 of file pcbnew.py.

◆ GetClass()

pcbnew.NETINFO_ITEM.GetClass ( self)
GetClass(NETINFO_ITEM self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 20189 of file pcbnew.py.

◆ GetDisplayNetname()

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

Definition at line 20221 of file pcbnew.py.

◆ GetNetClass()

pcbnew.NETINFO_ITEM.GetNetClass ( self)
GetNetClass(NETINFO_ITEM self) -> NETCLASS

Definition at line 20197 of file pcbnew.py.

◆ GetNetClassName()

pcbnew.NETINFO_ITEM.GetNetClassName ( self)

Definition at line 20253 of file pcbnew.py.

◆ GetNetClassSlow()

pcbnew.NETINFO_ITEM.GetNetClassSlow ( self)
GetNetClassSlow(NETINFO_ITEM self) -> std::shared_ptr< NETCLASS >

Definition at line 20201 of file pcbnew.py.

◆ GetNetCode()

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

Definition at line 20205 of file pcbnew.py.

◆ GetNetname()

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

Definition at line 20213 of file pcbnew.py.

◆ GetParent()

pcbnew.NETINFO_ITEM.GetParent ( self)
GetParent(NETINFO_ITEM self) -> BOARD

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 20249 of file pcbnew.py.

◆ GetShortNetname()

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

Definition at line 20217 of file pcbnew.py.

◆ HasAutoGeneratedNetname()

pcbnew.NETINFO_ITEM.HasAutoGeneratedNetname ( self)
HasAutoGeneratedNetname(NETINFO_ITEM self) -> bool

Definition at line 20225 of file pcbnew.py.

◆ IsCurrent()

pcbnew.NETINFO_ITEM.IsCurrent ( self)
IsCurrent(NETINFO_ITEM self) -> bool

Definition at line 20233 of file pcbnew.py.

◆ SetIsCurrent()

pcbnew.NETINFO_ITEM.SetIsCurrent ( self,
isCurrent )
SetIsCurrent(NETINFO_ITEM self, bool isCurrent)

Definition at line 20237 of file pcbnew.py.

◆ SetNetClass()

pcbnew.NETINFO_ITEM.SetNetClass ( self,
aNetClass )
SetNetClass(NETINFO_ITEM self, std::shared_ptr< NETCLASS > const & aNetClass)

Definition at line 20193 of file pcbnew.py.

◆ SetNetCode()

pcbnew.NETINFO_ITEM.SetNetCode ( self,
aNetCode )
SetNetCode(NETINFO_ITEM self, int aNetCode)

Definition at line 20209 of file pcbnew.py.

◆ SetNetname()

pcbnew.NETINFO_ITEM.SetNetname ( self,
aNewName )
SetNetname(NETINFO_ITEM self, wxString aNewName)

Definition at line 20229 of file pcbnew.py.

◆ SetParent()

pcbnew.NETINFO_ITEM.SetParent ( self,
aParent )
SetParent(NETINFO_ITEM self, BOARD aParent)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 20245 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 20176 of file pcbnew.py.


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