KiCAD pcbnew scripting
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.NETINFO_LIST Class Reference
Inheritance diagram for pcbnew.NETINFO_LIST:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, aParent)
 
def GetNetItem (self, args)
 
def GetNetCount (self)
 
def AppendNet (self, aNewElement)
 
def RemoveNet (self, aNet)
 
def GetPadCount (self)
 
def GetPads (self)
 
def NetsByName (self)
 
def NetsByNetcode (self)
 
def GetPad (self, aIdx)
 
def DeletePad (self, aPad)
 
def GetParent (self)
 

Public Attributes

 this
 

Static Public Attributes

tuple ORPHANED_ITEM = _swig_property(_pcbnew.NETINFO_LIST_ORPHANED_ITEM_get, _pcbnew.NETINFO_LIST_ORPHANED_ITEM_set)
 

Detailed Description

Class NETINFO_LIST is a container class for NETINFO_ITEM elements,
which are the nets.

That makes this class a container for the nets.

C++ includes: class_netinfo.h 

Definition at line 28751 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.NETINFO_LIST.__init__ (   self,
  aParent 
)
__init__(NETINFO_LIST self, BOARD aParent) -> NETINFO_LIST

NETINFO_LIST::NETINFO_LIST(BOARD *aParent) 

Definition at line 28768 of file pcbnew.py.

Member Function Documentation

def pcbnew.NETINFO_LIST.AppendNet (   self,
  aNewElement 
)
AppendNet(NETINFO_LIST self, NETINFO_ITEM aNewElement)

void
NETINFO_LIST::AppendNet(NETINFO_ITEM *aNewElement)

Function AppendNet adds aNewElement to the end of the net list.

Negative net code means it is going to be auto-assigned. 

Definition at line 28817 of file pcbnew.py.

def pcbnew.NETINFO_LIST.DeletePad (   self,
  aPad 
)
DeletePad(NETINFO_LIST self, D_PAD aPad) -> bool

bool
NETINFO_LIST::DeletePad(D_PAD *aPad) 

Definition at line 28911 of file pcbnew.py.

def pcbnew.NETINFO_LIST.GetNetCount (   self)
GetNetCount(NETINFO_LIST self) -> unsigned int

unsigned
NETINFO_LIST::GetNetCount() const

Function GetNetCount.

the number of nets ( always >= 1 ) because the first net is the "not
connected" net and always exists 

Definition at line 28802 of file pcbnew.py.

def pcbnew.NETINFO_LIST.GetNetItem (   self,
  args 
)
GetNetItem(NETINFO_LIST self, int aNetCode) -> NETINFO_ITEM
GetNetItem(NETINFO_LIST self, wxString aNetName) -> NETINFO_ITEM

NETINFO_ITEM *
NETINFO_LIST::GetNetItem(const wxString &aNetName) const

Function GetItem.

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

aNetName:  = net name to identify a given NETINFO_ITEM

NETINFO_ITEM* - by aNetName, or NULL if not found 

Definition at line 28782 of file pcbnew.py.

def pcbnew.NETINFO_LIST.GetPad (   self,
  aIdx 
)
GetPad(NETINFO_LIST self, unsigned int aIdx) -> D_PAD

D_PAD *
NETINFO_LIST::GetPad(unsigned aIdx) const

Function GetPad.

D_PAD* - the pad from m_PadsFullList or nullptr if bad aIdx 

Definition at line 28897 of file pcbnew.py.

def pcbnew.NETINFO_LIST.GetPadCount (   self)
GetPadCount(NETINFO_LIST self) -> unsigned int

unsigned
NETINFO_LIST::GetPadCount() const

Function GetPadCount.

the number of pads in board 

Definition at line 28843 of file pcbnew.py.

def pcbnew.NETINFO_LIST.GetPads (   self)
GetPads(NETINFO_LIST self) -> D_PADS

const D_PADS&
NETINFO_LIST::GetPads() const

Function GetPads returns a list of all the pads (so long as
buildPadsFullList() has been recently called).

Returned list contains non-owning pointers. D_PADS& - a full list of
pads 

Definition at line 28857 of file pcbnew.py.

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

BOARD*
NETINFO_LIST::GetParent() const 

Definition at line 28925 of file pcbnew.py.

def pcbnew.NETINFO_LIST.NetsByName (   self)
NetsByName(NETINFO_LIST self) -> NETNAMES_MAP

const NETNAMES_MAP&
NETINFO_LIST::NetsByName() const

Return the name map, at least for python. 

Definition at line 28873 of file pcbnew.py.

def pcbnew.NETINFO_LIST.NetsByNetcode (   self)
NetsByNetcode(NETINFO_LIST self) -> NETCODES_MAP

const
NETCODES_MAP& NETINFO_LIST::NetsByNetcode() const

Return the netcode map, at least for python. 

Definition at line 28885 of file pcbnew.py.

def pcbnew.NETINFO_LIST.RemoveNet (   self,
  aNet 
)
RemoveNet(NETINFO_LIST self, NETINFO_ITEM aNet)

void
NETINFO_LIST::RemoveNet(NETINFO_ITEM *aNet)

Function RemoveNet Removes a new from the net list. 

Definition at line 28831 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.NETINFO_LIST.ORPHANED_ITEM = _swig_property(_pcbnew.NETINFO_LIST_ORPHANED_ITEM_get, _pcbnew.NETINFO_LIST_ORPHANED_ITEM_set)
static

Definition at line 28923 of file pcbnew.py.

pcbnew.NETINFO_LIST.this

Definition at line 28778 of file pcbnew.py.


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