pcbnew.BOARD_CONNECTED_ITEM Class Reference

Inheritance diagram for pcbnew.BOARD_CONNECTED_ITEM:

Public Member Functions
def	__init__ (self, *args, **kwargs)
"bool"	IsConnected (self)
"NETINFO_ITEM *"	GetNet (self)
"void"	SetNet (self, "NETINFO_ITEM" aNetInfo)
"int"	GetNetCode (self)
"void"	SetNetCode (self, *args)
"wxString"	GetNetname (self)
"wxString"	GetNetnameMsg (self)
"wxString"	GetShortNetname (self)
"int"	GetOwnClearance (self, "PCB_LAYER_ID" aLayer, "wxString" aSource=None)
"int"	GetLocalClearanceOverrides (self, "wxString" aSource)
"int"	GetLocalClearance (self, "wxString" aSource)
"NETCLASS *"	GetNetClass (self)
"NETCLASS *"	GetEffectiveNetclass (self)
"wxString"	GetNetClassName (self)
"void"	SetLocalRatsnestVisible (self, "bool" aVisible)
"bool"	GetLocalRatsnestVisible (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++ BOARD_CONNECTED_ITEM class.

Definition at line 8646 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

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

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_VIA, pcbnew.PCB_TRACK, pcbnew.PAD, pcbnew.PCB_ARC, pcbnew.ZONE, and pcbnew.FP_ZONE.

Definition at line 8651 of file pcbnew.py.

Member Function Documentation

ClassOf()

"bool" pcbnew.BOARD_CONNECTED_ITEM.ClassOf ( "EDA_ITEM"  aItem )

static

ClassOf(EDA_ITEM aItem) -> bool

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_VIA, and pcbnew.ZONE.

Definition at line 8656 of file pcbnew.py.

GetEffectiveNetclass()

"NETCLASS *" pcbnew.BOARD_CONNECTED_ITEM.GetEffectiveNetclass

(

self

)

GetEffectiveNetclass(BOARD_CONNECTED_ITEM self) -> NETCLASS *

Definition at line 8711 of file pcbnew.py.

GetLocalClearance()

"int" pcbnew.BOARD_CONNECTED_ITEM.GetLocalClearance	(		self,
		"wxString"	aSource
	)

GetLocalClearance(BOARD_CONNECTED_ITEM self, wxString aSource) -> int

Reimplemented in pcbnew.PCB_TRACK, pcbnew.PAD, and pcbnew.ZONE.

Definition at line 8703 of file pcbnew.py.

GetLocalClearanceOverrides()

"int" pcbnew.BOARD_CONNECTED_ITEM.GetLocalClearanceOverrides	(		self,
		"wxString"	aSource
	)

GetLocalClearanceOverrides(BOARD_CONNECTED_ITEM self, wxString aSource) -> int

Reimplemented in pcbnew.PAD.

Definition at line 8699 of file pcbnew.py.

GetLocalRatsnestVisible()

"bool" pcbnew.BOARD_CONNECTED_ITEM.GetLocalRatsnestVisible

(

self

)

GetLocalRatsnestVisible(BOARD_CONNECTED_ITEM self) -> bool

Definition at line 8723 of file pcbnew.py.

GetNet()

"NETINFO_ITEM *" pcbnew.BOARD_CONNECTED_ITEM.GetNet

(

self

)

GetNet(BOARD_CONNECTED_ITEM self) -> NETINFO_ITEM

Definition at line 8664 of file pcbnew.py.

GetNetClass()

"NETCLASS *" pcbnew.BOARD_CONNECTED_ITEM.GetNetClass

(

self

)

GetNetClass(BOARD_CONNECTED_ITEM self) -> NETCLASS *

Reimplemented in pcbnew.ZONE.

Definition at line 8707 of file pcbnew.py.

GetNetClassName()

"wxString" pcbnew.BOARD_CONNECTED_ITEM.GetNetClassName

(

self

)

GetNetClassName(BOARD_CONNECTED_ITEM self) -> wxString

Reimplemented in pcbnew.ZONE.

Definition at line 8715 of file pcbnew.py.

GetNetCode()

"int" pcbnew.BOARD_CONNECTED_ITEM.GetNetCode

(

self

)

GetNetCode(BOARD_CONNECTED_ITEM self) -> int

Definition at line 8672 of file pcbnew.py.

GetNetname()

"wxString" pcbnew.BOARD_CONNECTED_ITEM.GetNetname

(

self

)

GetNetname(BOARD_CONNECTED_ITEM self) -> wxString

Definition at line 8683 of file pcbnew.py.

GetNetnameMsg()

"wxString" pcbnew.BOARD_CONNECTED_ITEM.GetNetnameMsg

(

self

)

GetNetnameMsg(BOARD_CONNECTED_ITEM self) -> wxString

Definition at line 8687 of file pcbnew.py.

GetOwnClearance()

"int" pcbnew.BOARD_CONNECTED_ITEM.GetOwnClearance	(		self,
		"PCB_LAYER_ID"	aLayer,
		"wxString"	aSource = None
	)

GetOwnClearance(BOARD_CONNECTED_ITEM self, PCB_LAYER_ID aLayer, wxString aSource=None) -> int

Reimplemented in pcbnew.PAD.

Definition at line 8695 of file pcbnew.py.

GetShortNetname()

"wxString" pcbnew.BOARD_CONNECTED_ITEM.GetShortNetname

(

self

)

GetShortNetname(BOARD_CONNECTED_ITEM self) -> wxString

Definition at line 8691 of file pcbnew.py.

IsConnected()

"bool" pcbnew.BOARD_CONNECTED_ITEM.IsConnected

(

self

)

IsConnected(BOARD_CONNECTED_ITEM self) -> bool

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.ZONE.

Definition at line 8660 of file pcbnew.py.

SetLocalRatsnestVisible()

"void" pcbnew.BOARD_CONNECTED_ITEM.SetLocalRatsnestVisible	(		self,
		"bool"	aVisible
	)

SetLocalRatsnestVisible(BOARD_CONNECTED_ITEM self, bool aVisible)

Definition at line 8719 of file pcbnew.py.

SetNet()

"void" pcbnew.BOARD_CONNECTED_ITEM.SetNet	(		self,
		"NETINFO_ITEM"	aNetInfo
	)

SetNet(BOARD_CONNECTED_ITEM self, NETINFO_ITEM aNetInfo)

Definition at line 8668 of file pcbnew.py.

SetNetCode()

"void" pcbnew.BOARD_CONNECTED_ITEM.SetNetCode	(		self,
		*	args
	)

    SetNetCode(BOARD_CONNECTED_ITEM self, int aNetCode, bool aNoAssert) -> bool
    SetNetCode(BOARD_CONNECTED_ITEM self, int aNetCode)

Definition at line 8676 of file pcbnew.py.

Here is the caller graph for this function:

Property Documentation

thisown

pcbnew.BOARD_CONNECTED_ITEM.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 8649 of file pcbnew.py.

---

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

• pcbnew.py