KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Properties | List of all members
pcbnew.PCB_TABLE Class Reference
Inheritance diagram for pcbnew.PCB_TABLE:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, *args)
 
def GetClass (self)
 
def SetStrokeExternal (self, aDoStroke)
 
def StrokeExternal (self)
 
def SetStrokeHeaderSeparator (self, aDoStroke)
 
def StrokeHeaderSeparator (self)
 
def SetBorderStroke (self, aParams)
 
def GetBorderStroke (self)
 
def SetBorderWidth (self, aWidth)
 
def GetBorderWidth (self)
 
def SetBorderStyle (self, aStyle)
 
def GetBorderStyle (self)
 
def SetBorderColor (self, aColor)
 
def GetBorderColor (self)
 
def SetSeparatorsStroke (self, aParams)
 
def GetSeparatorsStroke (self)
 
def SetSeparatorsWidth (self, aWidth)
 
def GetSeparatorsWidth (self)
 
def SetSeparatorsStyle (self, aStyle)
 
def GetSeparatorsStyle (self)
 
def SetSeparatorsColor (self, aColor)
 
def GetSeparatorsColor (self)
 
def SetStrokeColumns (self, aDoStroke)
 
def StrokeColumns (self)
 
def SetStrokeRows (self, aDoStroke)
 
def StrokeRows (self)
 
def GetEnd (self)
 
def SetPositionX (self, x)
 
def SetPositionY (self, y)
 
def GetPositionX (self)
 
def GetPositionY (self)
 
def SetColCount (self, aCount)
 
def GetColCount (self)
 
def GetRowCount (self)
 
def SetColWidth (self, aCol, aWidth)
 
def GetColWidth (self, aCol)
 
def SetRowHeight (self, aRow, aHeight)
 
def GetRowHeight (self, aRow)
 
def GetCell (self, aRow, aCol)
 
def GetCells (self)
 
def AddCell (self, aCell)
 
def InsertCell (self, aIdx, aCell)
 
def ClearCells (self)
 
def DeleteMarkedCells (self)
 
def AddNative (self, *args)
 
def RemoveNative (self, *args)
 
def Autosize (self)
 
def DrawBorders (self, aCallback)
 
def GetEffectiveShape (self, *args)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc, aIgnoreLineWidth=False)
 
def HitTest (self, *args)
 
def __eq__ (self, *args)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
def __init__ (self, *args, **kwargs)
 
def AddNative (self, *args)
 
def RemoveNative (self, *args)
 
def DeleteNative (self, aItem)
 
def Add (self, item)
 
def Remove (self, item)
 
def Delete (self, item)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
def CopyFrom (self, aOther)
 
def IsGroupableType (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def HasDrilledHole (self)
 
def IsTented (self, aLayer)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction, aMode)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
def GetLayer (self)
 
def BoardLayerCount (self)
 
def BoardCopperLayerCount (self)
 
def BoardLayerSet (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def IsSideSpecific (self)
 
def SetLayer (self, aLayer)
 
def Duplicate (self, addToParentGroup, aCommit=None)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def GetMaxError (self)
 
def StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipDirection)
 
def Mirror (self, aCentre, aFlipDirection)
 
def Normalize (self)
 
def NormalizeForCompare (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
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 GetParent (self)
 
def SetParent (self, aParent)
 
def SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetParentGroupId (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetIsRollover (self, aIsRollover)
 
def SetSelected (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearEditFlags (self)
 
def GetTempFlags (self)
 
def ClearTempFlags (self)
 
def RenderAsBitmap (self, aWorldScale)
 
def SetIsShownAsBitmap (self, aBitmap)
 
def IsShownAsBitmap (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def IsForceVisible (self)
 
def GetMsgPanelInfo (self, aFrame, aList)
 
def GetFriendlyName (self)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def GetFocusPosition (self)
 
def GetSortPosition (self)
 
def Clone (self)
 
def Visit (self, inspector, testData, aScanTypes)
 
def GetTypeDesc (self)
 
def GetItemDescription (self, aUnitsProvider, aFull)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def ViewBBox (self)
 
def ViewGetLayers (self)
 
def GetEmbeddedFiles (self)
 
def GetEmbeddedFonts (self)
 
def PyGetClass (self)
 
def GetClass (self)
 

Static Public Member Functions

def ClassOf (aItem)
 
def Compare (aTable, aOther)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, aRight)
 

Properties

property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM_CONTAINER
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
property m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.BOARD_ITEM
_pcbnew DRC = _pcbnew.BOARD_ITEM_DRC
 
_pcbnew INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Detailed Description

Proxy of C++ PCB_TABLE class.

Definition at line 18129 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_TABLE.__init__ (   self,
args 
)
    __init__(PCB_TABLE self, BOARD_ITEM aParent, int aLineWidth) -> PCB_TABLE
    __init__(PCB_TABLE self, PCB_TABLE aTable) -> PCB_TABLE

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 18135 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

def pcbnew.PCB_TABLE.__eq__ (   self,
args 
)
    __eq__(PCB_TABLE self, PCB_TABLE aOther) -> bool
    __eq__(PCB_TABLE self, BOARD_ITEM aBoardItem) -> bool

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 18352 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddCell()

def pcbnew.PCB_TABLE.AddCell (   self,
  aCell 
)
AddCell(PCB_TABLE self, PCB_TABLECELL * aCell)

Definition at line 18304 of file pcbnew.py.

◆ AddNative()

def pcbnew.PCB_TABLE.AddNative (   self,
args 
)
AddNative(PCB_TABLE self, BOARD_ITEM aItem, ADD_MODE aMode=INSERT, bool aSkipConnectivity=False)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 18320 of file pcbnew.py.

Here is the caller graph for this function:

◆ Autosize()

def pcbnew.PCB_TABLE.Autosize (   self)
Autosize(PCB_TABLE self)

Definition at line 18328 of file pcbnew.py.

◆ ClassOf()

def pcbnew.PCB_TABLE.ClassOf (   aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 18144 of file pcbnew.py.

◆ ClearCells()

def pcbnew.PCB_TABLE.ClearCells (   self)
ClearCells(PCB_TABLE self)

Definition at line 18312 of file pcbnew.py.

◆ Compare()

def pcbnew.PCB_TABLE.Compare (   aTable,
  aOther 
)
static
Compare(PCB_TABLE aTable, PCB_TABLE aOther) -> int

Definition at line 18360 of file pcbnew.py.

◆ DeleteMarkedCells()

def pcbnew.PCB_TABLE.DeleteMarkedCells (   self)
DeleteMarkedCells(PCB_TABLE self)

Definition at line 18316 of file pcbnew.py.

◆ DrawBorders()

def pcbnew.PCB_TABLE.DrawBorders (   self,
  aCallback 
)
DrawBorders(PCB_TABLE self, std::function< void (VECTOR2I const &,VECTOR2I const &,STROKE_PARAMS const &) > const & aCallback)

Definition at line 18332 of file pcbnew.py.

◆ GetBorderColor()

def pcbnew.PCB_TABLE.GetBorderColor (   self)
GetBorderColor(PCB_TABLE self) -> COLOR4D

Definition at line 18196 of file pcbnew.py.

◆ GetBorderStroke()

def pcbnew.PCB_TABLE.GetBorderStroke (   self)
GetBorderStroke(PCB_TABLE self) -> STROKE_PARAMS const &

Definition at line 18172 of file pcbnew.py.

◆ GetBorderStyle()

def pcbnew.PCB_TABLE.GetBorderStyle (   self)
GetBorderStyle(PCB_TABLE self) -> LINE_STYLE

Definition at line 18188 of file pcbnew.py.

◆ GetBorderWidth()

def pcbnew.PCB_TABLE.GetBorderWidth (   self)
GetBorderWidth(PCB_TABLE self) -> int

Definition at line 18180 of file pcbnew.py.

◆ GetCell()

def pcbnew.PCB_TABLE.GetCell (   self,
  aRow,
  aCol 
)
GetCell(PCB_TABLE self, int aRow, int aCol) -> PCB_TABLECELL *

Definition at line 18296 of file pcbnew.py.

◆ GetCells()

def pcbnew.PCB_TABLE.GetCells (   self)
GetCells(PCB_TABLE self) -> std::vector< PCB_TABLECELL *,std::allocator< PCB_TABLECELL * > >

Definition at line 18300 of file pcbnew.py.

◆ GetClass()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 18148 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetColCount()

def pcbnew.PCB_TABLE.GetColCount (   self)
GetColCount(PCB_TABLE self) -> int

Definition at line 18272 of file pcbnew.py.

◆ GetColWidth()

def pcbnew.PCB_TABLE.GetColWidth (   self,
  aCol 
)
GetColWidth(PCB_TABLE self, int aCol) -> int

Definition at line 18284 of file pcbnew.py.

◆ GetEffectiveShape()

def pcbnew.PCB_TABLE.GetEffectiveShape (   self,
args 
)
GetEffectiveShape(PCB_TABLE self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 18336 of file pcbnew.py.

◆ GetEnd()

def pcbnew.PCB_TABLE.GetEnd (   self)
GetEnd(PCB_TABLE self) -> VECTOR2I

Definition at line 18248 of file pcbnew.py.

◆ GetPositionX()

def pcbnew.PCB_TABLE.GetPositionX (   self)
GetPositionX(PCB_TABLE self) -> int

Definition at line 18260 of file pcbnew.py.

◆ GetPositionY()

def pcbnew.PCB_TABLE.GetPositionY (   self)
GetPositionY(PCB_TABLE self) -> int

Definition at line 18264 of file pcbnew.py.

◆ GetRowCount()

def pcbnew.PCB_TABLE.GetRowCount (   self)
GetRowCount(PCB_TABLE self) -> int

Definition at line 18276 of file pcbnew.py.

◆ GetRowHeight()

def pcbnew.PCB_TABLE.GetRowHeight (   self,
  aRow 
)
GetRowHeight(PCB_TABLE self, int aRow) -> int

Definition at line 18292 of file pcbnew.py.

◆ GetSeparatorsColor()

def pcbnew.PCB_TABLE.GetSeparatorsColor (   self)
GetSeparatorsColor(PCB_TABLE self) -> COLOR4D

Definition at line 18228 of file pcbnew.py.

◆ GetSeparatorsStroke()

def pcbnew.PCB_TABLE.GetSeparatorsStroke (   self)
GetSeparatorsStroke(PCB_TABLE self) -> STROKE_PARAMS const &

Definition at line 18204 of file pcbnew.py.

◆ GetSeparatorsStyle()

def pcbnew.PCB_TABLE.GetSeparatorsStyle (   self)
GetSeparatorsStyle(PCB_TABLE self) -> LINE_STYLE

Definition at line 18220 of file pcbnew.py.

◆ GetSeparatorsWidth()

def pcbnew.PCB_TABLE.GetSeparatorsWidth (   self)
GetSeparatorsWidth(PCB_TABLE self) -> int

Definition at line 18212 of file pcbnew.py.

◆ HitTest()

def pcbnew.PCB_TABLE.HitTest (   self,
args 
)
    HitTest(PCB_TABLE self, VECTOR2I aPosition, int aAccuracy=0) -> bool
    HitTest(PCB_TABLE self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool
    HitTest(PCB_TABLE self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 18344 of file pcbnew.py.

Here is the caller graph for this function:

◆ InsertCell()

def pcbnew.PCB_TABLE.InsertCell (   self,
  aIdx,
  aCell 
)
InsertCell(PCB_TABLE self, int aIdx, PCB_TABLECELL * aCell)

Definition at line 18308 of file pcbnew.py.

◆ RemoveNative()

def pcbnew.PCB_TABLE.RemoveNative (   self,
args 
)
RemoveNative(PCB_TABLE self, BOARD_ITEM aItem, REMOVE_MODE aMode=NORMAL)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 18324 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetBorderColor()

def pcbnew.PCB_TABLE.SetBorderColor (   self,
  aColor 
)
SetBorderColor(PCB_TABLE self, COLOR4D aColor)

Definition at line 18192 of file pcbnew.py.

◆ SetBorderStroke()

def pcbnew.PCB_TABLE.SetBorderStroke (   self,
  aParams 
)
SetBorderStroke(PCB_TABLE self, STROKE_PARAMS const & aParams)

Definition at line 18168 of file pcbnew.py.

◆ SetBorderStyle()

def pcbnew.PCB_TABLE.SetBorderStyle (   self,
  aStyle 
)
SetBorderStyle(PCB_TABLE self, LINE_STYLE const aStyle)

Definition at line 18184 of file pcbnew.py.

◆ SetBorderWidth()

def pcbnew.PCB_TABLE.SetBorderWidth (   self,
  aWidth 
)
SetBorderWidth(PCB_TABLE self, int aWidth)

Definition at line 18176 of file pcbnew.py.

◆ SetColCount()

def pcbnew.PCB_TABLE.SetColCount (   self,
  aCount 
)
SetColCount(PCB_TABLE self, int aCount)

Definition at line 18268 of file pcbnew.py.

◆ SetColWidth()

def pcbnew.PCB_TABLE.SetColWidth (   self,
  aCol,
  aWidth 
)
SetColWidth(PCB_TABLE self, int aCol, int aWidth)

Definition at line 18280 of file pcbnew.py.

◆ SetPositionX()

def pcbnew.PCB_TABLE.SetPositionX (   self,
  x 
)
SetPositionX(PCB_TABLE self, int x)

Definition at line 18252 of file pcbnew.py.

◆ SetPositionY()

def pcbnew.PCB_TABLE.SetPositionY (   self,
  y 
)
SetPositionY(PCB_TABLE self, int y)

Definition at line 18256 of file pcbnew.py.

◆ SetRowHeight()

def pcbnew.PCB_TABLE.SetRowHeight (   self,
  aRow,
  aHeight 
)
SetRowHeight(PCB_TABLE self, int aRow, int aHeight)

Definition at line 18288 of file pcbnew.py.

◆ SetSeparatorsColor()

def pcbnew.PCB_TABLE.SetSeparatorsColor (   self,
  aColor 
)
SetSeparatorsColor(PCB_TABLE self, COLOR4D aColor)

Definition at line 18224 of file pcbnew.py.

◆ SetSeparatorsStroke()

def pcbnew.PCB_TABLE.SetSeparatorsStroke (   self,
  aParams 
)
SetSeparatorsStroke(PCB_TABLE self, STROKE_PARAMS const & aParams)

Definition at line 18200 of file pcbnew.py.

◆ SetSeparatorsStyle()

def pcbnew.PCB_TABLE.SetSeparatorsStyle (   self,
  aStyle 
)
SetSeparatorsStyle(PCB_TABLE self, LINE_STYLE const aStyle)

Definition at line 18216 of file pcbnew.py.

◆ SetSeparatorsWidth()

def pcbnew.PCB_TABLE.SetSeparatorsWidth (   self,
  aWidth 
)
SetSeparatorsWidth(PCB_TABLE self, int aWidth)

Definition at line 18208 of file pcbnew.py.

◆ SetStrokeColumns()

def pcbnew.PCB_TABLE.SetStrokeColumns (   self,
  aDoStroke 
)
SetStrokeColumns(PCB_TABLE self, bool aDoStroke)

Definition at line 18232 of file pcbnew.py.

◆ SetStrokeExternal()

def pcbnew.PCB_TABLE.SetStrokeExternal (   self,
  aDoStroke 
)
SetStrokeExternal(PCB_TABLE self, bool aDoStroke)

Definition at line 18152 of file pcbnew.py.

◆ SetStrokeHeaderSeparator()

def pcbnew.PCB_TABLE.SetStrokeHeaderSeparator (   self,
  aDoStroke 
)
SetStrokeHeaderSeparator(PCB_TABLE self, bool aDoStroke)

Definition at line 18160 of file pcbnew.py.

◆ SetStrokeRows()

def pcbnew.PCB_TABLE.SetStrokeRows (   self,
  aDoStroke 
)
SetStrokeRows(PCB_TABLE self, bool aDoStroke)

Definition at line 18240 of file pcbnew.py.

◆ StrokeColumns()

def pcbnew.PCB_TABLE.StrokeColumns (   self)
StrokeColumns(PCB_TABLE self) -> bool

Definition at line 18236 of file pcbnew.py.

◆ StrokeExternal()

def pcbnew.PCB_TABLE.StrokeExternal (   self)
StrokeExternal(PCB_TABLE self) -> bool

Definition at line 18156 of file pcbnew.py.

◆ StrokeHeaderSeparator()

def pcbnew.PCB_TABLE.StrokeHeaderSeparator (   self)
StrokeHeaderSeparator(PCB_TABLE self) -> bool

Definition at line 18164 of file pcbnew.py.

◆ StrokeRows()

def pcbnew.PCB_TABLE.StrokeRows (   self)
StrokeRows(PCB_TABLE self) -> bool

Definition at line 18244 of file pcbnew.py.

◆ TransformShapeToPolygon()

def pcbnew.PCB_TABLE.TransformShapeToPolygon (   self,
  aBuffer,
  aLayer,
  aClearance,
  aMaxError,
  aErrorLoc,
  aIgnoreLineWidth = False 
)
TransformShapeToPolygon(PCB_TABLE self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=False)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 18340 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 18132 of file pcbnew.py.


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