KiCAD pcbnew scripting
Public Member Functions | Static Public Attributes | 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, kwargs)
 
def ClassOf (aItem)
 
def GetClass (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def SetClass (self, aNetClass)
 
def GetNetClass (self)
 
def GetClassName (self)
 
def GetTrackWidth (self)
 
def GetViaSize (self)
 
def GetMicroViaSize (self)
 
def GetViaDrillSize (self)
 
def GetMicroViaDrillSize (self)
 
def GetClearance (self, aBoardItem)
 
def Draw (self, panel, DC, aDrawMode, offset)
 
def GetNet (self)
 
def SetNetCode (self, aNetCode)
 
def GetNetname (self)
 
def GetShortNetname (self)
 
def GetMsgPanelInfo (self, aList)
 
def Clear (self)
 
def GetParent (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, args, kwargs)
 
def GetPosition (self)
 
def GetCenter (self)
 
def SetPosition (self, aPos)
 
def IsConnected (self)
 
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, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
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 SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (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
 
def GetFlags (self)
 
def SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aList)
 
def HitTest (self, aPosition)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
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)
 
def ViewGetLayers (self, aLayers, aCount)
 

Static Public Attributes

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

Detailed Description

Class NETINFO_ITEM handles the data for a net.

C++ includes: class_netinfo.h 

Definition at line 30363 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.NETINFO_ITEM.__init__ (   self,
  args,
  kwargs 
)

Definition at line 30380 of file pcbnew.py.

Member Function Documentation

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

Definition at line 30386 of file pcbnew.py.

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

void
NETINFO_ITEM::Clear()

Function Clear sets all fields to their defaults values. 

Definition at line 30629 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.Draw (   self,
  panel,
  DC,
  aDrawMode,
  offset 
)
Draw(NETINFO_ITEM self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode, wxPoint offset)

void
NETINFO_ITEM::Draw(EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE
aDrawMode, const wxPoint &offset) override

Function Draw.

Function Draw (TODO)

Todo we actually could show a NET, simply show all the tracks and a
pads or net name on pad and vias 

Definition at line 30540 of file pcbnew.py.

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

wxString
NETINFO_ITEM::GetClass() const override

Function GetClass returns the class name.

wxString 

Definition at line 30394 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.GetClassName (   self)
GetClassName(NETINFO_ITEM self) -> wxString

wxString
NETINFO_ITEM::GetClassName() const

Function GetClassName returns the class name. 

Definition at line 30450 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.GetClearance (   self,
  aBoardItem 
)
GetClearance(NETINFO_ITEM self, BOARD_ITEM aBoardItem) -> int

int
NETINFO_ITEM::GetClearance(BOARD_ITEM *aBoardItem)

Function GetClearance returns the clearance when routing near
aBoardItem. 

Definition at line 30527 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.GetMicroViaDrillSize (   self)
GetMicroViaDrillSize(NETINFO_ITEM self) -> int

int
NETINFO_ITEM::GetMicroViaDrillSize()

Function GetViaDrillSize returns the size of via drills used to route
this net. 

Definition at line 30514 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.GetMicroViaSize (   self)
GetMicroViaSize(NETINFO_ITEM self) -> int

int
NETINFO_ITEM::GetMicroViaSize()

Function GetMicroViaSize returns the size of vias used to route this
net. 

Definition at line 30488 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.GetMsgPanelInfo (   self,
  aList 
)
GetMsgPanelInfo(NETINFO_ITEM self, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

void
NETINFO_ITEM::GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList)
override

Function GetMsgPanelInfo returns the information about the
NETINFO_ITEM in aList to display in the message panel.

Parameters:
-----------

aList:  is the list in which to place the status information. 

Definition at line 30610 of file pcbnew.py.

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

int
NETINFO_ITEM::GetNet() const

Function GetNet.

int - the netcode 

Definition at line 30558 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.GetNetClass (   self)
GetNetClass(NETINFO_ITEM self) -> NETCLASSPTR

NETCLASSPTR
NETINFO_ITEM::GetNetClass() 

Definition at line 30440 of file pcbnew.py.

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

const wxString&
NETINFO_ITEM::GetNetname() const

Function GetNetname.

const wxString&, a reference to the full netname 

Definition at line 30582 of file pcbnew.py.

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

BOARD*
NETINFO_ITEM::GetParent() const 

Definition at line 30641 of file pcbnew.py.

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

const wxPoint&
NETINFO_ITEM::GetPosition() const override 

Definition at line 30408 of file pcbnew.py.

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

const wxString&
NETINFO_ITEM::GetShortNetname() const

Function GetShortNetname.

const wxString &, a reference to the short netname 

Definition at line 30596 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.GetTrackWidth (   self)
GetTrackWidth(NETINFO_ITEM self) -> int

int
NETINFO_ITEM::GetTrackWidth()

Function GetTrackWidth returns the width of tracks used to route this
net. 

Definition at line 30462 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.GetViaDrillSize (   self)
GetViaDrillSize(NETINFO_ITEM self) -> int

int
NETINFO_ITEM::GetViaDrillSize()

Function GetViaDrillSize returns the size of via drills used to route
this net. 

Definition at line 30501 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.GetViaSize (   self)
GetViaSize(NETINFO_ITEM self) -> int

int
NETINFO_ITEM::GetViaSize()

Function GetViaSize returns the size of vias used to route this net.

Definition at line 30475 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.SetClass (   self,
  aNetClass 
)
SetClass(NETINFO_ITEM self, NETCLASSPTR aNetClass)

void
NETINFO_ITEM::SetClass(NETCLASSPTR aNetClass)

Function SetClass sets aNetclass into this NET. 

Definition at line 30428 of file pcbnew.py.

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

void
NETINFO_ITEM::SetNetCode(int aNetCode) 

Definition at line 30572 of file pcbnew.py.

def pcbnew.NETINFO_ITEM.SetPosition (   self,
  aPos 
)
SetPosition(NETINFO_ITEM self, wxPoint aPos)

void
NETINFO_ITEM::SetPosition(const wxPoint &aPos) override 

Definition at line 30418 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.NETINFO_ITEM.ClassOf = staticmethod(ClassOf)
static

Definition at line 30391 of file pcbnew.py.


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