KiCAD pcbnew 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
 
def GetNetname (self)
 
def GetShortNetname (self)
 
def GetClearance
 
def GetNetClass (self)
 
def GetNetClassName (self)
 
def SetLocalRatsnestVisible (self, aVisible)
 
def GetLocalRatsnestVisible (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 BOARD_CONNECTED_ITEM is a base class derived from BOARD_ITEM for
items that can be connected and have a net, a netname, a clearance ...

mainly: tracks, pads and zones Handle connection info

C++ includes: class_board_connected_item.h 

Definition at line 16863 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 16883 of file pcbnew.py.

Member Function Documentation

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

Definition at line 16887 of file pcbnew.py.

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

int
BOARD_CONNECTED_ITEM::GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL)
const

Function GetClearance returns the clearance in internal units.

If aItem is not NULL then the returned clearance is the greater of
this object's NETCLASS clearance and aItem's NETCLASS clearance. If
aItem is NULL, then this objects clearance is returned.

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

aItem:  is another BOARD_CONNECTED_ITEM or NULL

int - the clearance in internal units. 

Definition at line 17001 of file pcbnew.py.

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

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible() const 

Definition at line 17063 of file pcbnew.py.

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

NETINFO_ITEM*
BOARD_CONNECTED_ITEM::GetNet() const

Function GetNet Returns NET_INFO object for a given item. 

Definition at line 16911 of file pcbnew.py.

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

NETCLASSPTR
BOARD_CONNECTED_ITEM::GetNetClass() const

Function GetNetClass returns the NETCLASS for this item. 

Definition at line 17026 of file pcbnew.py.

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

wxString BOARD_CONNECTED_ITEM::GetNetClassName() const

Function GetNetClassName returns a pointer to the netclass of the
zone.

If the net is not found (can happen when a netlist is reread, and the
net name does not exist, return the default net class (should not
return a null pointer). the Net Class name of this item 

Definition at line 17038 of file pcbnew.py.

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

int
BOARD_CONNECTED_ITEM::GetNetCode() const

Function GetNetCode.

int - the net code. 

Definition at line 16935 of file pcbnew.py.

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

const
wxString& BOARD_CONNECTED_ITEM::GetNetname() const

Function GetNetname.

wxString - the full netname 

Definition at line 16973 of file pcbnew.py.

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

const
wxString& BOARD_CONNECTED_ITEM::GetShortNetname() const

Function GetShortNetname.

wxString - the short netname 

Definition at line 16987 of file pcbnew.py.

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

bool
BOARD_CONNECTED_ITEM::IsConnected() const override

>

Function IsConnected() Returns information if the object is derived
from BOARD_CONNECTED_ITEM. True if the object is of
BOARD_CONNECTED_ITEM type, false otherwise. 

Definition at line 16895 of file pcbnew.py.

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

void BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible(bool aVisible) 

Definition at line 17054 of file pcbnew.py.

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

void
BOARD_CONNECTED_ITEM::SetNet(NETINFO_ITEM *aNetInfo)

Function SetNet Sets a NET_INFO object for the item. 

Definition at line 16923 of file pcbnew.py.

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

bool
BOARD_CONNECTED_ITEM::SetNetCode(int aNetCode, bool aNoAssert=false)

Function SetNetCode sets net using a net code.

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

aNetCode:  is a net code for the new net. It has to exist in
NETINFO_LIST held by BOARD.

aNoAssert:  if true, do not assert that the net exists. Otherwise,
item is assigned to the unconnected net.

true on success, false if the net did not exist 

Definition at line 16949 of file pcbnew.py.

Member Data Documentation

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

Definition at line 16892 of file pcbnew.py.


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