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

Public Member Functions

def __init__ (self, args)
 
def ClassOf (aItem)
 
def Next (self)
 
def Back (self)
 
def AddNative (self, aItem, aMode=ADD_INSERT)
 
def RemoveNative (self, aItem)
 
def ClearAllNets (self)
 
def CalculateBoundingBox (self)
 
def GetFootprintRect (self)
 
def GetBoundingPoly (self)
 
def GetBoundingBox (self)
 
def PadsList (self, args)
 
def GraphicalItemsList (self, args)
 
def Pads (self)
 
def GraphicalItems (self)
 
def Models (self, args)
 
def SetPosition (self, aPos)
 
def GetPosition (self)
 
def SetOrientation (self, newangle)
 
def SetOrientationDegrees (self, aOrientation)
 
def GetOrientation (self)
 
def GetOrientationDegrees (self)
 
def GetOrientationRadians (self)
 
def GetFPID (self)
 
def SetFPID (self, aFPID)
 
def GetDescription (self)
 
def SetDescription (self, aDoc)
 
def GetKeywords (self)
 
def SetKeywords (self, aKeywords)
 
def GetPath (self)
 
def SetPath (self, aPath)
 
def GetLocalSolderMaskMargin (self)
 
def SetLocalSolderMaskMargin (self, aMargin)
 
def GetLocalClearance (self)
 
def SetLocalClearance (self, aClearance)
 
def GetLocalSolderPasteMargin (self)
 
def SetLocalSolderPasteMargin (self, aMargin)
 
def GetLocalSolderPasteMarginRatio (self)
 
def SetLocalSolderPasteMarginRatio (self, aRatio)
 
def SetZoneConnection (self, aType)
 
def GetZoneConnection (self)
 
def SetThermalWidth (self, aWidth)
 
def GetThermalWidth (self)
 
def SetThermalGap (self, aGap)
 
def GetThermalGap (self)
 
def GetAttributes (self)
 
def SetAttributes (self, aAttributes)
 
def SetFlag (self, aFlag)
 
def IncrementFlag (self)
 
def GetFlag (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def MoveAnchorPosition (self, aMoveVector)
 
def IsFlipped (self)
 
def IsLocked (self)
 
def SetLocked (self, isLocked)
 
def IsPlaced (self)
 
def SetIsPlaced (self, isPlaced)
 
def NeedsPlaced (self)
 
def SetNeedsPlaced (self, needsPlaced)
 
def PadsLocked (self)
 
def SetPadsLocked (self, aPadsLocked)
 
def SetLastEditTime (self, args)
 
def GetLastEditTime (self)
 
def Draw (self, args)
 
def DrawOutlinesWhenMoving (self, aPanel, aDC, aMoveVector)
 
def TransformPadsShapesWithClearanceToPolygon (self, aLayer, aCornerBuffer, aInflateValue, aCircleToSegmentsCount, aCorrectionFactor, aSkipNPTHPadsWihNoCopper=False)
 
def TransformGraphicShapesWithClearanceToPolygonSet (self, aLayer, aCornerBuffer, aInflateValue, aCircleToSegmentsCount, aCorrectionFactor, aCircleToSegmentsCountForTexts=0, aIncludeText=True)
 
def TransformGraphicTextWithClearanceToPolygonSet (self, aLayer, aCornerBuffer, aInflateValue, aCircleToSegmentsCount, aCorrectionFactor, aCircleToSegmentsCountForTexts=0)
 
def DrawEdgesOnly (self, panel, DC, offset, draw_mode)
 
def DrawAncre (self, panel, DC, offset, dim_ancre, draw_mode)
 
def GetMsgPanelInfo (self, aList)
 
def HitTestAccurate (self, aPosition)
 
def HitTest (self, args)
 
def GetReference (self)
 
def SetReference (self, aReference)
 
def GetReferencePrefix (self)
 
def GetValue (self)
 
def SetValue (self, aValue)
 
def Value (self, args)
 
def Reference (self, args)
 
def FindPadByName (self, aPadName)
 
def GetPad (self, args)
 
def GetTopLeftPad (self)
 
def GetPadCount (self, args)
 
def GetUniquePadCount (self, args)
 
def GetNextPadName (self, aFillSequenceGaps)
 
def GetArea (self)
 
def GetLink (self)
 
def SetLink (self, aLink)
 
def GetPlacementCost180 (self)
 
def SetPlacementCost180 (self, aCost)
 
def GetPlacementCost90 (self)
 
def SetPlacementCost90 (self, aCost)
 
def Duplicate (self, aItem, aIncrementPadNumbers, aAddToModule=False)
 
def Add3DModel (self, a3DModel)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Clone (self)
 
def RunOnChildren (self, aFunction)
 
def GetAllDrawingLayers (self, aLayers, aCount, aIncludePads=True)
 
def ViewGetLayers (self, aLayers, aCount)
 
def ViewGetLOD (self, aLayer, aView)
 
def ViewBBox (self)
 
def CopyNetlistSettings (self, aModule, aCopyLocalSettings)
 
def IsLibNameValid (aName)
 
def StringLibNameInvalidChars (aUserReadable)
 
def SetInitialComments (self, aInitialComments)
 
def CoverageRatio (self, aCollector)
 
def GetInitialComments (self)
 
def GetPolyCourtyardFront (self)
 
def GetPolyCourtyardBack (self)
 
def BuildPolyCourtyard (self)
 
def SwapData (self, aImage)
 
def Pads (self)
 
def GraphicalItems (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
def __init__ (self, args, kwargs)
 
def AddNative (self, aItem, aMode=ADD_INSERT)
 
def RemoveNative (self, aItem)
 
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 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, args)
 
def Rotate (self, args)
 
def Flip (self, args)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
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 (self, aMask=-1)
 
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)
 

Public Attributes

 this
 

Static Public Attributes

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

Detailed Description

Proxy of C++ MODULE class.

Definition at line 19601 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.MODULE.__init__ (   self,
  args 
)
__init__(MODULE self, BOARD parent) -> MODULE
__init__(MODULE self, MODULE aModule) -> MODULE

Definition at line 19614 of file pcbnew.py.

Member Function Documentation

def pcbnew.MODULE.Add3DModel (   self,
  a3DModel 
)
Add3DModel(MODULE self, MODULE_3D_SETTINGS a3DModel)

Definition at line 20156 of file pcbnew.py.

def pcbnew.MODULE.AddNative (   self,
  aItem,
  aMode = ADD_INSERT 
)
AddNative(MODULE self, BOARD_ITEM aItem, ADD_MODE aMode=ADD_INSERT)
AddNative(MODULE self, BOARD_ITEM aItem)

Definition at line 19645 of file pcbnew.py.

def pcbnew.MODULE.Back (   self)
Back(MODULE self) -> MODULE

Definition at line 19640 of file pcbnew.py.

def pcbnew.MODULE.BuildPolyCourtyard (   self)
BuildPolyCourtyard(MODULE self) -> bool

Definition at line 20260 of file pcbnew.py.

def pcbnew.MODULE.CalculateBoundingBox (   self)
CalculateBoundingBox(MODULE self)

Definition at line 19663 of file pcbnew.py.

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

Definition at line 19627 of file pcbnew.py.

def pcbnew.MODULE.ClearAllNets (   self)
ClearAllNets(MODULE self)

Definition at line 19658 of file pcbnew.py.

def pcbnew.MODULE.Clone (   self)
Clone(MODULE self) -> EDA_ITEM

Definition at line 20181 of file pcbnew.py.

def pcbnew.MODULE.CopyNetlistSettings (   self,
  aModule,
  aCopyLocalSettings 
)
CopyNetlistSettings(MODULE self, MODULE aModule, bool aCopyLocalSettings)

Definition at line 20214 of file pcbnew.py.

def pcbnew.MODULE.CoverageRatio (   self,
  aCollector 
)
CoverageRatio(MODULE self, GENERAL_COLLECTOR const & aCollector) -> double

Definition at line 20240 of file pcbnew.py.

def pcbnew.MODULE.Draw (   self,
  args 
)
Draw(MODULE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
Draw(MODULE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode)

Definition at line 19965 of file pcbnew.py.

def pcbnew.MODULE.DrawAncre (   self,
  panel,
  DC,
  offset,
  dim_ancre,
  draw_mode 
)
DrawAncre(MODULE self, EDA_DRAW_PANEL * panel, wxDC * DC, wxPoint offset, int dim_ancre, GR_DRAWMODE draw_mode)

Definition at line 20008 of file pcbnew.py.

def pcbnew.MODULE.DrawEdgesOnly (   self,
  panel,
  DC,
  offset,
  draw_mode 
)
DrawEdgesOnly(MODULE self, EDA_DRAW_PANEL * panel, wxDC * DC, wxPoint offset, GR_DRAWMODE draw_mode)

Definition at line 20003 of file pcbnew.py.

def pcbnew.MODULE.DrawOutlinesWhenMoving (   self,
  aPanel,
  aDC,
  aMoveVector 
)
DrawOutlinesWhenMoving(MODULE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, wxPoint aMoveVector)

Definition at line 19973 of file pcbnew.py.

def pcbnew.MODULE.Duplicate (   self,
  aItem,
  aIncrementPadNumbers,
  aAddToModule = False 
)
Duplicate(MODULE self, BOARD_ITEM aItem, bool aIncrementPadNumbers, bool aAddToModule=False) -> BOARD_ITEM
Duplicate(MODULE self, BOARD_ITEM aItem, bool aIncrementPadNumbers) -> BOARD_ITEM

Definition at line 20148 of file pcbnew.py.

def pcbnew.MODULE.FindPadByName (   self,
  aPadName 
)
FindPadByName(MODULE self, wxString aPadName) -> D_PAD

Definition at line 20074 of file pcbnew.py.

def pcbnew.MODULE.Flip (   self,
  aCentre 
)
Flip(MODULE self, wxPoint aCentre)

Definition at line 19897 of file pcbnew.py.

def pcbnew.MODULE.GetAllDrawingLayers (   self,
  aLayers,
  aCount,
  aIncludePads = True 
)
GetAllDrawingLayers(MODULE self, int [] aLayers, int & aCount, bool aIncludePads=True)
GetAllDrawingLayers(MODULE self, int [] aLayers, int & aCount)

Definition at line 20191 of file pcbnew.py.

def pcbnew.MODULE.GetArea (   self)
GetArea(MODULE self) -> double

Definition at line 20113 of file pcbnew.py.

def pcbnew.MODULE.GetAttributes (   self)
GetAttributes(MODULE self) -> int

Definition at line 19862 of file pcbnew.py.

def pcbnew.MODULE.GetBoundingBox (   self)
GetBoundingBox(MODULE self) -> EDA_RECT

Definition at line 19678 of file pcbnew.py.

def pcbnew.MODULE.GetBoundingPoly (   self)
GetBoundingPoly(MODULE self) -> SHAPE_POLY_SET

Definition at line 19673 of file pcbnew.py.

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

Definition at line 20166 of file pcbnew.py.

def pcbnew.MODULE.GetDescription (   self)
GetDescription(MODULE self) -> wxString

Definition at line 19762 of file pcbnew.py.

def pcbnew.MODULE.GetFlag (   self)
GetFlag(MODULE self) -> int

Definition at line 19882 of file pcbnew.py.

def pcbnew.MODULE.GetFootprintRect (   self)
GetFootprintRect(MODULE self) -> EDA_RECT

Definition at line 19668 of file pcbnew.py.

def pcbnew.MODULE.GetFPID (   self)
GetFPID(MODULE self) -> LIB_ID

Definition at line 19752 of file pcbnew.py.

def pcbnew.MODULE.GetInitialComments (   self)
GetInitialComments(MODULE self) -> wxArrayString const *

Definition at line 20245 of file pcbnew.py.

def pcbnew.MODULE.GetKeywords (   self)
GetKeywords(MODULE self) -> wxString

Definition at line 19772 of file pcbnew.py.

def pcbnew.MODULE.GetLastEditTime (   self)
GetLastEditTime(MODULE self) -> timestamp_t

Definition at line 19960 of file pcbnew.py.

def pcbnew.MODULE.GetLink (   self)
GetLink(MODULE self) -> timestamp_t

Definition at line 20118 of file pcbnew.py.

def pcbnew.MODULE.GetLocalClearance (   self)
GetLocalClearance(MODULE self) -> int

Definition at line 19802 of file pcbnew.py.

def pcbnew.MODULE.GetLocalSolderMaskMargin (   self)
GetLocalSolderMaskMargin(MODULE self) -> int

Definition at line 19792 of file pcbnew.py.

def pcbnew.MODULE.GetLocalSolderPasteMargin (   self)
GetLocalSolderPasteMargin(MODULE self) -> int

Definition at line 19812 of file pcbnew.py.

def pcbnew.MODULE.GetLocalSolderPasteMarginRatio (   self)
GetLocalSolderPasteMarginRatio(MODULE self) -> double

Definition at line 19822 of file pcbnew.py.

def pcbnew.MODULE.GetMenuImage (   self)
GetMenuImage(MODULE self) -> BITMAP_DEF

Definition at line 20176 of file pcbnew.py.

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

Definition at line 20013 of file pcbnew.py.

def pcbnew.MODULE.GetNextPadName (   self,
  aFillSequenceGaps 
)
GetNextPadName(MODULE self, bool aFillSequenceGaps) -> wxString

Definition at line 20108 of file pcbnew.py.

def pcbnew.MODULE.GetOrientation (   self)
GetOrientation(MODULE self) -> double

Definition at line 19737 of file pcbnew.py.

def pcbnew.MODULE.GetOrientationDegrees (   self)
GetOrientationDegrees(MODULE self) -> double

Definition at line 19742 of file pcbnew.py.

def pcbnew.MODULE.GetOrientationRadians (   self)
GetOrientationRadians(MODULE self) -> double

Definition at line 19747 of file pcbnew.py.

def pcbnew.MODULE.GetPad (   self,
  args 
)
GetPad(MODULE self, wxPoint aPosition, LSET aLayerMask) -> D_PAD
GetPad(MODULE self, wxPoint aPosition) -> D_PAD

Definition at line 20079 of file pcbnew.py.

def pcbnew.MODULE.GetPadCount (   self,
  args 
)
GetPadCount(MODULE self, INCLUDE_NPTH_T aIncludeNPTH) -> unsigned int
GetPadCount(MODULE self) -> unsigned int

Definition at line 20092 of file pcbnew.py.

def pcbnew.MODULE.GetPath (   self)
GetPath(MODULE self) -> wxString

Definition at line 19782 of file pcbnew.py.

def pcbnew.MODULE.GetPlacementCost180 (   self)
GetPlacementCost180(MODULE self) -> int

Definition at line 20128 of file pcbnew.py.

def pcbnew.MODULE.GetPlacementCost90 (   self)
GetPlacementCost90(MODULE self) -> int

Definition at line 20138 of file pcbnew.py.

def pcbnew.MODULE.GetPolyCourtyardBack (   self)
GetPolyCourtyardBack(MODULE self) -> SHAPE_POLY_SET

Definition at line 20255 of file pcbnew.py.

def pcbnew.MODULE.GetPolyCourtyardFront (   self)
GetPolyCourtyardFront(MODULE self) -> SHAPE_POLY_SET

Definition at line 20250 of file pcbnew.py.

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

Definition at line 19722 of file pcbnew.py.

def pcbnew.MODULE.GetReference (   self)
GetReference(MODULE self) -> wxString

Definition at line 20033 of file pcbnew.py.

def pcbnew.MODULE.GetReferencePrefix (   self)
GetReferencePrefix(MODULE self) -> wxString

Definition at line 20043 of file pcbnew.py.

def pcbnew.MODULE.GetSelectMenuText (   self)
GetSelectMenuText(MODULE self) -> wxString

Definition at line 20171 of file pcbnew.py.

def pcbnew.MODULE.GetThermalGap (   self)
GetThermalGap(MODULE self) -> int

Definition at line 19857 of file pcbnew.py.

def pcbnew.MODULE.GetThermalWidth (   self)
GetThermalWidth(MODULE self) -> int

Definition at line 19847 of file pcbnew.py.

def pcbnew.MODULE.GetTopLeftPad (   self)
GetTopLeftPad(MODULE self) -> D_PAD

Definition at line 20087 of file pcbnew.py.

def pcbnew.MODULE.GetUniquePadCount (   self,
  args 
)
GetUniquePadCount(MODULE self, INCLUDE_NPTH_T aIncludeNPTH) -> unsigned int
GetUniquePadCount(MODULE self) -> unsigned int

Definition at line 20100 of file pcbnew.py.

def pcbnew.MODULE.GetValue (   self)
GetValue(MODULE self) -> wxString

Definition at line 20048 of file pcbnew.py.

def pcbnew.MODULE.GetZoneConnection (   self)
GetZoneConnection(MODULE self) -> ZoneConnection

Definition at line 19837 of file pcbnew.py.

def pcbnew.MODULE.GraphicalItems (   self)
GraphicalItems(MODULE self) -> DLIST_ITERATOR_WRAPPER< BOARD_ITEM >

Definition at line 19704 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.MODULE.GraphicalItems (   self)

Definition at line 20272 of file pcbnew.py.

def pcbnew.MODULE.GraphicalItemsList (   self,
  args 
)
GraphicalItemsList(MODULE self) -> BOARD_ITEM_List
GraphicalItemsList(MODULE self) -> BOARD_ITEM_List

Definition at line 19691 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.MODULE.HitTest (   self,
  args 
)
HitTest(MODULE self, wxPoint aPosition) -> bool
HitTest(MODULE self, EDA_RECT aRect, bool aContained=True, int aAccuracy=0) -> bool
HitTest(MODULE self, EDA_RECT aRect, bool aContained=True) -> bool
HitTest(MODULE self, EDA_RECT aRect) -> bool

Definition at line 20023 of file pcbnew.py.

def pcbnew.MODULE.HitTestAccurate (   self,
  aPosition 
)
HitTestAccurate(MODULE self, wxPoint aPosition) -> bool

Definition at line 20018 of file pcbnew.py.

def pcbnew.MODULE.IncrementFlag (   self)
IncrementFlag(MODULE self)

Definition at line 19877 of file pcbnew.py.

def pcbnew.MODULE.IsFlipped (   self)
IsFlipped(MODULE self) -> bool

Definition at line 19907 of file pcbnew.py.

def pcbnew.MODULE.IsLibNameValid (   aName)
IsLibNameValid(wxString aName) -> bool

Definition at line 20219 of file pcbnew.py.

def pcbnew.MODULE.IsLocked (   self)
IsLocked(MODULE self) -> bool

Definition at line 19912 of file pcbnew.py.

def pcbnew.MODULE.IsPlaced (   self)
IsPlaced(MODULE self) -> bool

Definition at line 19922 of file pcbnew.py.

def pcbnew.MODULE.Models (   self,
  args 
)
Models(MODULE self) -> std::list< MODULE_3D_SETTINGS >
Models(MODULE self) -> std::list< MODULE_3D_SETTINGS > const &

Definition at line 19709 of file pcbnew.py.

def pcbnew.MODULE.Move (   self,
  aMoveVector 
)
Move(MODULE self, wxPoint aMoveVector)

Definition at line 19887 of file pcbnew.py.

def pcbnew.MODULE.MoveAnchorPosition (   self,
  aMoveVector 
)
MoveAnchorPosition(MODULE self, wxPoint aMoveVector)

Definition at line 19902 of file pcbnew.py.

def pcbnew.MODULE.NeedsPlaced (   self)
NeedsPlaced(MODULE self) -> bool

Definition at line 19932 of file pcbnew.py.

def pcbnew.MODULE.Next (   self)
Next(MODULE self) -> MODULE

Definition at line 19635 of file pcbnew.py.

def pcbnew.MODULE.Pads (   self)
Pads(MODULE self) -> DLIST_ITERATOR_WRAPPER< D_PAD >

Definition at line 19699 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.MODULE.Pads (   self)

Definition at line 20271 of file pcbnew.py.

def pcbnew.MODULE.PadsList (   self,
  args 
)
PadsList(MODULE self) -> PAD_List
PadsList(MODULE self) -> PAD_List

Definition at line 19683 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.MODULE.PadsLocked (   self)
PadsLocked(MODULE self) -> bool

Definition at line 19942 of file pcbnew.py.

def pcbnew.MODULE.Reference (   self,
  args 
)
Reference(MODULE self) -> TEXTE_MODULE
Reference(MODULE self) -> TEXTE_MODULE

Definition at line 20066 of file pcbnew.py.

def pcbnew.MODULE.RemoveNative (   self,
  aItem 
)
RemoveNative(MODULE self, BOARD_ITEM aItem)

Definition at line 19653 of file pcbnew.py.

def pcbnew.MODULE.Rotate (   self,
  aRotCentre,
  aAngle 
)
Rotate(MODULE self, wxPoint aRotCentre, double aAngle)

Definition at line 19892 of file pcbnew.py.

def pcbnew.MODULE.RunOnChildren (   self,
  aFunction 
)
RunOnChildren(MODULE self, std::function< void (BOARD_ITEM *) > const & aFunction)

Definition at line 20186 of file pcbnew.py.

def pcbnew.MODULE.SetAttributes (   self,
  aAttributes 
)
SetAttributes(MODULE self, int aAttributes)

Definition at line 19867 of file pcbnew.py.

def pcbnew.MODULE.SetDescription (   self,
  aDoc 
)
SetDescription(MODULE self, wxString aDoc)

Definition at line 19767 of file pcbnew.py.

def pcbnew.MODULE.SetFlag (   self,
  aFlag 
)
SetFlag(MODULE self, int aFlag)

Definition at line 19872 of file pcbnew.py.

def pcbnew.MODULE.SetFPID (   self,
  aFPID 
)
SetFPID(MODULE self, LIB_ID aFPID)

Definition at line 19757 of file pcbnew.py.

def pcbnew.MODULE.SetInitialComments (   self,
  aInitialComments 
)
SetInitialComments(MODULE self, wxArrayString * aInitialComments)

Definition at line 20235 of file pcbnew.py.

def pcbnew.MODULE.SetIsPlaced (   self,
  isPlaced 
)
SetIsPlaced(MODULE self, bool isPlaced)

Definition at line 19927 of file pcbnew.py.

def pcbnew.MODULE.SetKeywords (   self,
  aKeywords 
)
SetKeywords(MODULE self, wxString aKeywords)

Definition at line 19777 of file pcbnew.py.

def pcbnew.MODULE.SetLastEditTime (   self,
  args 
)
SetLastEditTime(MODULE self, timestamp_t aTime)
SetLastEditTime(MODULE self)

Definition at line 19952 of file pcbnew.py.

def pcbnew.MODULE.SetLink (   self,
  aLink 
)
SetLink(MODULE self, timestamp_t aLink)

Definition at line 20123 of file pcbnew.py.

def pcbnew.MODULE.SetLocalClearance (   self,
  aClearance 
)
SetLocalClearance(MODULE self, int aClearance)

Definition at line 19807 of file pcbnew.py.

def pcbnew.MODULE.SetLocalSolderMaskMargin (   self,
  aMargin 
)
SetLocalSolderMaskMargin(MODULE self, int aMargin)

Definition at line 19797 of file pcbnew.py.

def pcbnew.MODULE.SetLocalSolderPasteMargin (   self,
  aMargin 
)
SetLocalSolderPasteMargin(MODULE self, int aMargin)

Definition at line 19817 of file pcbnew.py.

def pcbnew.MODULE.SetLocalSolderPasteMarginRatio (   self,
  aRatio 
)
SetLocalSolderPasteMarginRatio(MODULE self, double aRatio)

Definition at line 19827 of file pcbnew.py.

def pcbnew.MODULE.SetLocked (   self,
  isLocked 
)
SetLocked(MODULE self, bool isLocked)

Definition at line 19917 of file pcbnew.py.

def pcbnew.MODULE.SetNeedsPlaced (   self,
  needsPlaced 
)
SetNeedsPlaced(MODULE self, bool needsPlaced)

Definition at line 19937 of file pcbnew.py.

def pcbnew.MODULE.SetOrientation (   self,
  newangle 
)
SetOrientation(MODULE self, double newangle)

Definition at line 19727 of file pcbnew.py.

def pcbnew.MODULE.SetOrientationDegrees (   self,
  aOrientation 
)
SetOrientationDegrees(MODULE self, double aOrientation)

Definition at line 19732 of file pcbnew.py.

def pcbnew.MODULE.SetPadsLocked (   self,
  aPadsLocked 
)
SetPadsLocked(MODULE self, bool aPadsLocked)

Definition at line 19947 of file pcbnew.py.

def pcbnew.MODULE.SetPath (   self,
  aPath 
)
SetPath(MODULE self, wxString aPath)

Definition at line 19787 of file pcbnew.py.

def pcbnew.MODULE.SetPlacementCost180 (   self,
  aCost 
)
SetPlacementCost180(MODULE self, int aCost)

Definition at line 20133 of file pcbnew.py.

def pcbnew.MODULE.SetPlacementCost90 (   self,
  aCost 
)
SetPlacementCost90(MODULE self, int aCost)

Definition at line 20143 of file pcbnew.py.

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

Definition at line 19717 of file pcbnew.py.

def pcbnew.MODULE.SetReference (   self,
  aReference 
)
SetReference(MODULE self, wxString aReference)

Definition at line 20038 of file pcbnew.py.

def pcbnew.MODULE.SetThermalGap (   self,
  aGap 
)
SetThermalGap(MODULE self, int aGap)

Definition at line 19852 of file pcbnew.py.

def pcbnew.MODULE.SetThermalWidth (   self,
  aWidth 
)
SetThermalWidth(MODULE self, int aWidth)

Definition at line 19842 of file pcbnew.py.

def pcbnew.MODULE.SetValue (   self,
  aValue 
)
SetValue(MODULE self, wxString aValue)

Definition at line 20053 of file pcbnew.py.

def pcbnew.MODULE.SetZoneConnection (   self,
  aType 
)
SetZoneConnection(MODULE self, ZoneConnection aType)

Definition at line 19832 of file pcbnew.py.

def pcbnew.MODULE.StringLibNameInvalidChars (   aUserReadable)
StringLibNameInvalidChars(bool aUserReadable) -> wxChar const *

Definition at line 20227 of file pcbnew.py.

def pcbnew.MODULE.SwapData (   self,
  aImage 
)
SwapData(MODULE self, BOARD_ITEM aImage)

Definition at line 20265 of file pcbnew.py.

def pcbnew.MODULE.TransformGraphicShapesWithClearanceToPolygonSet (   self,
  aLayer,
  aCornerBuffer,
  aInflateValue,
  aCircleToSegmentsCount,
  aCorrectionFactor,
  aCircleToSegmentsCountForTexts = 0,
  aIncludeText = True 
)
TransformGraphicShapesWithClearanceToPolygonSet(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor, int aCircleToSegmentsCountForTexts=0, bool aIncludeText=True)
TransformGraphicShapesWithClearanceToPolygonSet(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor, int aCircleToSegmentsCountForTexts=0)
TransformGraphicShapesWithClearanceToPolygonSet(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor)

Definition at line 19986 of file pcbnew.py.

def pcbnew.MODULE.TransformGraphicTextWithClearanceToPolygonSet (   self,
  aLayer,
  aCornerBuffer,
  aInflateValue,
  aCircleToSegmentsCount,
  aCorrectionFactor,
  aCircleToSegmentsCountForTexts = 0 
)
TransformGraphicTextWithClearanceToPolygonSet(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor, int aCircleToSegmentsCountForTexts=0)
TransformGraphicTextWithClearanceToPolygonSet(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor)

Definition at line 19995 of file pcbnew.py.

def pcbnew.MODULE.TransformPadsShapesWithClearanceToPolygon (   self,
  aLayer,
  aCornerBuffer,
  aInflateValue,
  aCircleToSegmentsCount,
  aCorrectionFactor,
  aSkipNPTHPadsWihNoCopper = False 
)
TransformPadsShapesWithClearanceToPolygon(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor, bool aSkipNPTHPadsWihNoCopper=False)
TransformPadsShapesWithClearanceToPolygon(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor)

Definition at line 19978 of file pcbnew.py.

def pcbnew.MODULE.Value (   self,
  args 
)
Value(MODULE self) -> TEXTE_MODULE
Value(MODULE self) -> TEXTE_MODULE

Definition at line 20058 of file pcbnew.py.

def pcbnew.MODULE.ViewBBox (   self)
ViewBBox(MODULE self) -> BOX2I const

Definition at line 20209 of file pcbnew.py.

def pcbnew.MODULE.ViewGetLayers (   self,
  aLayers,
  aCount 
)
ViewGetLayers(MODULE self, int [] aLayers, int & aCount)

Definition at line 20199 of file pcbnew.py.

def pcbnew.MODULE.ViewGetLOD (   self,
  aLayer,
  aView 
)
ViewGetLOD(MODULE self, int aLayer, KIGFX::VIEW * aView) -> unsigned int

Definition at line 20204 of file pcbnew.py.

def pcbnew.MODULE.Visit (   self,
  inspector,
  testData,
  scanTypes 
)
Visit(MODULE self, INSPECTOR inspector, void * testData, KICAD_T const [] scanTypes) -> SEARCH_RESULT

Definition at line 20161 of file pcbnew.py.

Member Data Documentation

pcbnew.MODULE.ClassOf = staticmethod(ClassOf)
static

Definition at line 19632 of file pcbnew.py.

pcbnew.MODULE.IsLibNameValid = staticmethod(IsLibNameValid)
static

Definition at line 20224 of file pcbnew.py.

pcbnew.MODULE.StringLibNameInvalidChars = staticmethod(StringLibNameInvalidChars)
static

Definition at line 20232 of file pcbnew.py.

pcbnew.MODULE.this

Definition at line 19623 of file pcbnew.py.


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