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

Public Member Functions

def __init__ (self, *args)
 
"wxString" GetClass (self)
 
"wxPoint" GetPosition (self)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"EDA_ITEM *" Clone (self)
 
"void" SetNetClass (self, "NETCLASSPTR const &" aNetClass)
 
"NETCLASS *" GetNetClass (self)
 
"wxString" GetNetClassName (self)
 
"int" GetNetCode (self)
 
"void" SetNetCode (self, "int" aNetCode)
 
"wxString const &" GetNetname (self)
 
"wxString const &" GetShortNetname (self)
 
"void" SetNetname (self, "wxString" aNewName)
 
"bool" IsCurrent (self)
 
"void" SetIsCurrent (self, "bool" isCurrent)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"void" Clear (self)
 
"BOARD *" GetParent (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
"void" SetParentGroup (self, "PCB_GROUP" aGroup)
 
"PCB_GROUP *" GetParentGroup (self)
 
"int" GetX (self)
 
"int" GetY (self)
 
"wxPoint" GetCenter (self)
 
"void" SetX (self, "int" aX)
 
"void" SetY (self, "int" aY)
 
"bool" IsConnected (self)
 
"bool" IsOnCopperLayer (self)
 
"std::shared_ptr< SHAPE >" GetEffectiveShape (self, *args)
 
"BOARD_ITEM_CONTAINER *" GetParent (self)
 
"BOARD_ITEM_CONTAINER *" GetParentFootprint (self)
 
"PCB_LAYER_ID" GetLayer (self)
 
"LSET" GetLayerSet (self)
 
"void" SetLayerSet (self, "LSET" aLayers)
 
"void" SetLayer (self, "PCB_LAYER_ID" aLayer)
 
"BOARD_ITEM *" Duplicate (self)
 
"void" SwapData (self, "BOARD_ITEM" aImage)
 
"bool" IsOnLayer (self, "PCB_LAYER_ID" aLayer)
 
"bool" IsTrack (self)
 
"bool" IsLocked (self)
 
"void" SetLocked (self, "bool" aLocked)
 
"void" DeleteStructure (self)
 
"void" Move (self, *args)
 
"void" Rotate (self, *args)
 
"void" Flip (self, *args)
 
"BOARD *" GetBoard (self, *args)
 
"wxString" GetLayerName (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 
"void" TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" 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)
 
"KICAD_T" Type (self)
 
"EDA_ITEM *" GetParent (self)
 
"void" SetParent (self, "EDA_ITEM" aParent)
 
"bool" IsModified (self)
 
"bool" IsNew (self)
 
"bool" IsMoving (self)
 
"bool" IsDragging (self)
 
"bool" IsWireImage (self)
 
"bool" IsSelected (self)
 
"bool" IsEntered (self)
 
"bool" IsResized (self)
 
"bool" IsBrightened (self)
 
"void" SetWireImage (self)
 
"void" SetSelected (self)
 
"void" SetBrightened (self)
 
"void" ClearSelected (self)
 
"void" ClearBrightened (self)
 
"void" SetModified (self)
 
"int" GetState (self, "EDA_ITEM_FLAGS" type)
 
"void" SetState (self, "EDA_ITEM_FLAGS" type, "bool" state)
 
"EDA_ITEM_FLAGS" GetStatus (self)
 
"void" SetStatus (self, "EDA_ITEM_FLAGS" aStatus)
 
"void" SetFlags (self, "EDA_ITEM_FLAGS" aMask)
 
"void" ClearFlags (self, *args)
 
"EDA_ITEM_FLAGS" GetFlags (self)
 
"bool" HasFlag (self, "EDA_ITEM_FLAGS" aFlag)
 
"EDA_ITEM_FLAGS" GetEditFlags (self)
 
"void" ClearTempFlags (self)
 
"void" ClearEditFlags (self)
 
"bool" IsType (self, "KICAD_T const []" aScanTypes)
 
"void" SetForceVisible (self, "bool" aEnable)
 
"bool" IsForceVisible (self)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"bool" HitTest (self, *args)
 
"EDA_RECT const" GetBoundingBox (self)
 
"wxPoint" GetPosition (self)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint const" GetFocusPosition (self)
 
"EDA_ITEM *" Clone (self)
 
"SEARCH_RESULT" Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
 
"wxString" GetClass (self)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"BITMAPS" GetMenuImage (self)
 
"bool" Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)
 
"bool" Replace (self, *args)
 
"bool" IsReplaceable (self)
 
"bool" __lt__ (self, "EDA_ITEM" aItem)
 
"BOX2I const" ViewBBox (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 

Static Public Member Functions

"bool" ClassOf ("EDA_ITEM" aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
"bool" Sort ("EDA_ITEM" aLeft, "EDA_ITEM" 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++ NETINFO_ITEM class.

Definition at line 15037 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 15043 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

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

Definition at line 15049 of file pcbnew.py.

◆ Clear()

"void" pcbnew.NETINFO_ITEM.Clear (   self)
Clear(NETINFO_ITEM self)

Definition at line 15113 of file pcbnew.py.

◆ Clone()

"EDA_ITEM *" pcbnew.NETINFO_ITEM.Clone (   self)
Clone(NETINFO_ITEM self) -> EDA_ITEM

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15065 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15053 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetMsgPanelInfo()

"void" pcbnew.NETINFO_ITEM.GetMsgPanelInfo (   self,
"EDA_DRAW_FRAME *"  aFrame,
"std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &"  aList 
)
GetMsgPanelInfo(NETINFO_ITEM self, EDA_DRAW_FRAME * aFrame, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15109 of file pcbnew.py.

◆ GetNetClass()

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

Definition at line 15073 of file pcbnew.py.

◆ GetNetClassName()

"wxString" pcbnew.NETINFO_ITEM.GetNetClassName (   self)
GetNetClassName(NETINFO_ITEM self) -> wxString

Definition at line 15077 of file pcbnew.py.

◆ GetNetCode()

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

Definition at line 15081 of file pcbnew.py.

◆ GetNetname()

"wxString const &" pcbnew.NETINFO_ITEM.GetNetname (   self)
GetNetname(NETINFO_ITEM self) -> wxString

Definition at line 15089 of file pcbnew.py.

◆ GetParent()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 15117 of file pcbnew.py.

◆ GetPosition()

"wxPoint" pcbnew.NETINFO_ITEM.GetPosition (   self)
GetPosition(NETINFO_ITEM self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15057 of file pcbnew.py.

◆ GetShortNetname()

"wxString const &" pcbnew.NETINFO_ITEM.GetShortNetname (   self)
GetShortNetname(NETINFO_ITEM self) -> wxString

Definition at line 15093 of file pcbnew.py.

◆ IsCurrent()

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

Definition at line 15101 of file pcbnew.py.

◆ SetIsCurrent()

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

Definition at line 15105 of file pcbnew.py.

◆ SetNetClass()

"void" pcbnew.NETINFO_ITEM.SetNetClass (   self,
"NETCLASSPTR const &"  aNetClass 
)
SetNetClass(NETINFO_ITEM self, NETCLASSPTR const & aNetClass)

Definition at line 15069 of file pcbnew.py.

◆ SetNetCode()

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

Definition at line 15085 of file pcbnew.py.

◆ SetNetname()

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

Definition at line 15097 of file pcbnew.py.

◆ SetPosition()

"void" pcbnew.NETINFO_ITEM.SetPosition (   self,
"wxPoint"  aPos 
)
SetPosition(NETINFO_ITEM self, wxPoint aPos)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15061 of file pcbnew.py.

Here is the caller graph for this function:

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


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