KiCad Pcbnew Python Scripting
Public Member Functions | Static Public Attributes | 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 ClassOf (aItem)
 
def IsConnected (self)
 
def GetNet (self)
 
def SetNet (self, aNetInfo)
 
def GetNetCode (self)
 
def SetNetCode (self, aNetCode, aNoAssert=False)
 
def GetNetname (self)
 
def GetNetnameMsg (self)
 
def GetShortNetname (self)
 
def GetClearance (self, aItem=None)
 
def GetNetClass (self)
 
def GetNetClassName (self)
 
def SetLocalRatsnestVisible (self, aVisible)
 
def GetLocalRatsnestVisible (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def GetPosition (self)
 
def GetCenter (self)
 
def SetPosition (self, aPos)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def Draw (self, *args)
 
def SwapData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (aShape)
 
def Move (self, *args)
 
def Rotate (self, *args)
 
def Flip (self, *args)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor, 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 Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def GetList (self)
 
def SetParent (self, aParent)
 
def SetList (self, aList)
 
def IsNew (self)
 
def IsModified (self)
 
def IsMoving (self)
 
def IsDragging (self)
 
def IsWireImage (self)
 
def IsSelected (self)
 
def IsResized (self)
 
def IsHighlighted (self)
 
def IsBrightened (self)
 
def SetWireImage (self)
 
def SetSelected (self)
 
def SetHighlighted (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearHighlighted (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 ClearFlags (self, aMask=-1)
 
def GetFlags (self)
 
def GetEditFlags (self)
 
def ClearTempFlags (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aUnits, aList)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self, aUnits)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (aLeft, aRight)
 
def ViewBBox (self)
 

Static Public Attributes

 ClassOf = staticmethod(ClassOf)
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 ShowShape = staticmethod(ShowShape)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
 IterateForward = staticmethod(IterateForward)
 
 Sort = staticmethod(Sort)
 

Detailed Description

Proxy of C++ BOARD_CONNECTED_ITEM class.

Definition at line 9291 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 9303 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

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

Reimplemented in pcbnew.ZONE_CONTAINER, pcbnew.VIA, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 9307 of file pcbnew.py.

◆ GetClearance()

def pcbnew.BOARD_CONNECTED_ITEM.GetClearance (   self,
  aItem = None 
)
GetClearance(BOARD_CONNECTED_ITEM self, BOARD_CONNECTED_ITEM aItem=None) -> int
GetClearance(BOARD_CONNECTED_ITEM self) -> int

Reimplemented in pcbnew.ZONE_CONTAINER, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 9356 of file pcbnew.py.

◆ GetLocalRatsnestVisible()

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

Definition at line 9379 of file pcbnew.py.

◆ GetNet()

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

Definition at line 9318 of file pcbnew.py.

◆ GetNetClass()

def pcbnew.BOARD_CONNECTED_ITEM.GetNetClass (   self)
GetNetClass(BOARD_CONNECTED_ITEM self) -> std::shared_ptr< NETCLASS >

Definition at line 9364 of file pcbnew.py.

◆ GetNetClassName()

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

Definition at line 9369 of file pcbnew.py.

◆ GetNetCode()

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

Definition at line 9328 of file pcbnew.py.

◆ GetNetname()

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

Definition at line 9341 of file pcbnew.py.

◆ GetNetnameMsg()

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

Definition at line 9346 of file pcbnew.py.

◆ GetShortNetname()

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

Definition at line 9351 of file pcbnew.py.

◆ IsConnected()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 9313 of file pcbnew.py.

◆ SetLocalRatsnestVisible()

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

Definition at line 9374 of file pcbnew.py.

◆ SetNet()

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

Definition at line 9323 of file pcbnew.py.

◆ SetNetCode()

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

Definition at line 9333 of file pcbnew.py.

Member Data Documentation

◆ ClassOf

pcbnew.BOARD_CONNECTED_ITEM.ClassOf = staticmethod(ClassOf)
static

Definition at line 9311 of file pcbnew.py.


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