Inheritance diagram for pcbnew.BOARD:

[legend]

Public Member Functions
	__init__ (self, args, *kwargs)

	SetBoardUse (self, aUse)

	GetBoardUse (self)

	IncrementTimeStamp (self)

	GetTimeStamp (self)

	IsFootprintHolder (self)

	SetFileName (self, aFileName)

	GetFileName (self)

	Footprints (self)

	Zones (self)

	GetUniqueZoneName (self, aBaseName, aExclude=None)

	Generators (self)

	BoardOutline (self, *args)

	UpdateBoardOutline (self)

	Markers (self)

	Points (self)

	Drawings (self, *args)

	Tracks (self, *args)

	GetItemSet (self)

	Groups (self)

	AllConnectedItems (self)

	GetProperties (self)

	SetProperties (self, aProps)

	GetCurrentVariant (self)

	SetCurrentVariant (self, aVariant)

	GetVariantNames (self)

	SetVariantNames (self, aNames)

	HasVariant (self, aVariantName)

	AddVariant (self, aVariantName)

	DeleteVariant (self, aVariantName)

	RenameVariant (self, aOldName, aNewName)

	CopyVariant (self, *args)

	GetVariantDescription (self, aVariantName)

	SetVariantDescription (self, aVariantName, aDescription)

	GetVariantNamesForUI (self)

	GetContextualTextVars (self, aVars)

	ResolveTextVar (self, token, aDepth)

	IsEmpty (self)

	SetFileFormatVersionAtLoad (self, aVersion)

	GetFileFormatVersionAtLoad (self)

	SetGenerator (self, aGenerator)

	GetGenerator (self)

	AddNative (self, *args)

	RemoveNative (self, *args)

	RemoveAll (self, *args)

	HasItemsOnLayer (self, aLayer)

	RemoveAllItemsOnLayer (self, aLayer)

	BulkRemoveStaleTeardrops (self, aCommit)

	FinalizeBulkAdd (self, aNewItems)

	FinalizeBulkRemove (self, aRemovedItems)

	FixupEmbeddedData (self)

	RunOnNestedEmbeddedFiles (self, aFunction)

	CacheTriangulation (self, *args)

	GetFirstFootprint (self)

	DeleteAllFootprints (self)

	DetachAllFootprints (self)

	ResolveItem (self, aID, aAllowNullptrReturn=False)

	RebindItemUuid (self, aItem, aNewId)

	RepairDuplicateItemUuids (self)

	FillItemMap (self, aMap)

	ConvertCrossReferencesToKIIDs (self, aSource)

	ConvertKIIDsToCrossReferences (self, aSource)

	GetConnectivity (self)

	BuildConnectivity (self, aReporter=None)

	DeleteMARKERs (self, *args)

	GetProject (self)

	SetProject (self, aProject, aReferenceOnly=False)

	ClearProject (self)

	ResolveDRCExclusions (self, aCreateMarkers)

	RecordDRCExclusions (self)

	UpdateRatsnestExclusions (self)

	ResetNetHighLight (self)

	GetHighLightNetCodes (self)

	SetHighLightNet (self, aNetCode, aMulti=False)

	IsHighLightNetON (self)

	HighLightON (self, aValue=True)

	HighLightOFF (self)

	GetCopperLayerCount (self)

	SetCopperLayerCount (self, aCount)

	GetUserDefinedLayerCount (self)

	SetUserDefinedLayerCount (self, aCount)

	GetCopperLayerStackMaxId (self)

	FlipLayer (self, aLayer)

	LayerDepth (self, aStartLayer, aEndLayer)

	GetEnabledLayers (self)

	SetEnabledLayers (self, aLayerMask)

	IsLayerEnabled (self, aLayer)

	IsLayerVisible (self, aLayer)

	GetVisibleLayers (self)

	SetVisibleLayers (self, aLayerMask)

	GetVisibleElements (self)

	SetVisibleElements (self, aMask)

	SetVisibleAlls (self)

	IsElementVisible (self, aLayer)

	SetElementVisibility (self, aLayer, aNewState)

	IsFootprintLayerVisible (self, aLayer)

	GetDesignSettings (self)

	SetDesignSettings (self, aSettings)

	InvalidateClearanceCache (self, aUuid)

	InitializeClearanceCache (self)

	GetStackupOrDefault (self)

	GetPageSettings (self)

	SetPageSettings (self, aPageSettings)

	GetPlotOptions (self)

	SetPlotOptions (self, aOptions)

	GetTitleBlock (self, *args)

	SetTitleBlock (self, aTitleBlock)

	GetUserUnits (self)

	SetUserUnits (self, aUnits)

	UpdateUserUnits (self, aItem, aView)

	GetBoardPolygonOutlines (self, aOutlines, aInferOutlineIfNecessary, aErrorHandler=None, aAllowUseArcsInPolygons=False, aIncludeNPTHAsOutlines=False)

	GetOutlinesChainingEpsilon (self)

	SetOutlinesChainingEpsilon (self, aValue)

	ConvertBrdLayerToPolygonalContours (self, aLayer, aOutlines, aRenderSettings=None)

	GetLayerID (self, aLayerName)

	GetLayerName (self, aLayer)

	SetLayerName (self, aLayer, aLayerName)

	SetLayerDescr (self, aIndex, aLayer)

	IsFrontLayer (self, aLayer)

	IsBackLayer (self, aLayer)

	GetLayerType (self, aLayer)

	SetLayerType (self, aLayer, aLayerType)

	GetNodesCount (self, aNet=-1)

	GetPads (self)

	BuildListOfNets (self)

	FindNet (self, *args)

	MatchDpSuffix (self, aNetName, aComplementNet)

	DpCoupledNet (self, aNet)

	GetNetInfo (self)

	RemoveUnusedNets (self, aCommit)

	GetNetCount (self)

	GetPadWithPressFitAttrCount (self)

	GetPadWithCastellatedAttrCount (self)

	ComputeBoundingBox (self, aBoardEdgesOnly=False, aPhysicalLayersOnly=False)

	GetBoardEdgesBoundingBox (self)

	FindFootprintByReference (self, aReference)

	FindFootprintByPath (self, aPath)

	GetNetClassAssignmentCandidates (self)

	SynchronizeNetsAndNetClasses (self, aResetTrackAndViaSizes)

	SynchronizeComponentClasses (self, aNewSheetPaths)

	SynchronizeProperties (self)

	SynchronizeTuningProfileProperties (self)

	GetClass (self)

	SetAreasNetCodesFromNetNames (self)

	GetArea (self, index)

	GetZoneList (self, aIncludeZonesInFootprints=False)

	GetAreaCount (self)

	AddArea (self, aNewZonesList, aNetcode, aLayer, aStartPointPosition, aHatch)

	TestZoneIntersection (self, aZone1, aZone2)

	GetPad (self, *args)

	GetSortedPadListByXthenYCoord (self, aVector, aNetCode=-1)

	GetTrackLength (self, aTrack)

	TracksInNet (self, aNetCode)

	GetFootprint (self, aPosition, aActiveLayer, aVisibleOnly, aIgnoreLocked=False)

	GetMaxClearanceValue (self)

	MapNets (self, aDestBoard)

	SanitizeNetcodes (self)

	AddListener (self, aListener)

	RemoveListener (self, aListener)

	RemoveAllListeners (self)

	OnItemChanged (self, aItem)

	OnItemsChanged (self, aItems)

	OnItemsCompositeUpdate (self, aAddedItems, aRemovedItems, aChangedItems)

	OnRatsnestChanged (self)

	GroupsSanityCheck (self, repair=False)

	GroupsSanityCheckInternal (self, repair)

	LegacyTeardrops (self)

	SetLegacyTeardrops (self, aFlag)

	GetEmbeddedFiles (self, *args)

	SetEmbeddedFilesDelegate (self, aDelegate)

	GetFonts (self)

	EmbedFonts (self)

	GetLengthCalculation (self)

	GetComponentClassManager (self)

	ProjectElementType (self)

	SaveToHistory (self, aProjectPath, aFileData)

	GetHistoryLifetimeToken (self)

	GetItemByIdCache (self)

	IsItemIndexedById (self, aItem)

	GetCachedItemById (self, aId)

	CacheItemById (self, aItem)

	UncacheItemById (self, aId)

	CacheItemSubtreeById (self, aItem)

	CacheChildrenById (self, aParent)

	UncacheItemSubtreeById (self, aItem)

	UncacheChildrenById (self, aParent)

	UncacheItemByPtr (self, aItem)

	CacheAndReturnItemById (self, aId, aItem)

	ClearItemByIdCache (self)

	__init__ (self, *args)

	GetFootprints (self)

	GetDrawings (self)

	GetTracks (self)

	Save (self, filename)

	GetNetClasses (self)

	GetCurrentNetClassName (self)

	GetViasDimensionsList (self)

	GetTrackWidthList (self)

	GetNetsByName (self)

	GetNetsByNetcode (self)

	GetNetcodeFromNetname (self, netname)

	GetAllNetClasses (self)

Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
	__init__ (self, args, *kwargs)

	DeleteNative (self, aItem)

	Add (self, item)

	Remove (self, item)

	Delete (self, item)

Public Member Functions inherited from pcbnew.BOARD_ITEM
	__init__ (self, args, *kwargs)

	CopyFrom (self, aOther)

	IsGroupableType (self)

	GetX (self)

	GetY (self)

	GetCenter (self)

	SetX (self, aX)

	SetY (self, aY)

	IsConnected (self)

	Similarity (self, aItem)

	__eq__ (self, aItem)

	IsOnCopperLayer (self)

	HasHole (self)

	HasDrilledHole (self)

	IsTented (self, aLayer)

	GetEffectiveShape (self, *args)

	GetEffectiveHoleShape (self)

	RunOnChildren (self, aFunction, aMode)

	GetParent (self)

	GetParentFootprint (self)

	SetUuidDirect (self, aUuid)

	ResetUuidDirect (self)

	SetUuid (self, aUuid)

	ResetUuid (self)

	GetFPRelativePosition (self)

	SetFPRelativePosition (self, aPos)

	HasLineStroke (self)

	GetStroke (self)

	SetStroke (self, aStroke)

	GetFontMetrics (self)

	GetLayer (self)

	BoardLayerCount (self)

	BoardCopperLayerCount (self)

	BoardLayerSet (self)

	GetLayerSet (self)

	SetLayerSet (self, aLayers)

	IsSideSpecific (self)

	SetLayer (self, aLayer)

	Duplicate (self, addToParentGroup, aCommit=None)

	SwapItemData (self, aImage)

	IsOnLayer (self, aLayer)

	IsKnockout (self)

	SetIsKnockout (self, aKnockout)

	IsIndexedInBoard (self)

	GetMaxError (self)

	StyleFromSettings (self, settings, aCheckSide)

	DeleteStructure (self)

	Move (self, aMoveVector)

	Rotate (self, aRotCentre, aAngle)

	Flip (self, aCentre, aFlipDirection)

	Mirror (self, aCentre, aFlipDirection)

	Normalize (self)

	NormalizeForCompare (self)

	GetBoard (self, *args)

	GetParentAsString (self)

	TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)

	TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aRenderSettings=None)

	LayerMaskDescribe (self)

	Cast (self)

	Duplicate (self)

	SetPos (self, p)

	SetStartEnd (self, start, end)

Public Member Functions inherited from pcbnew.EDA_ITEM
	__init__ (self, args, *kwargs)

	Type (self)

	SetParent (self, aParent)

	SetParentGroup (self, aGroup)

	GetParentGroup (self)

	GetParentGroupId (self)

	HasSelectedAncestorGroup (self)

	IsLocked (self)

	SetLocked (self, aLocked)

	IsModified (self)

	IsNew (self)

	IsMoving (self)

	IsSelected (self)

	IsEntered (self)

	IsBrightened (self)

	IsRollover (self)

	GetRolloverPos (self)

	SetIsRollover (self, aIsRollover, aMousePos)

	SetSelected (self)

	SetBrightened (self)

	ClearSelected (self)

	ClearBrightened (self)

	SetModified (self)

	SetFlags (self, aMask)

	XorFlags (self, aMask)

	ClearFlags (self, *args)

	GetFlags (self)

	HasFlag (self, aFlag)

	GetEditFlags (self)

	ClearEditFlags (self)

	GetTempFlags (self)

	ClearTempFlags (self)

	RenderAsBitmap (self, aWorldScale)

	SetIsShownAsBitmap (self, aBitmap)

	IsShownAsBitmap (self)

	IsType (self, aScanTypes)

	SetForceVisible (self, aEnable)

	IsForceVisible (self)

	GetMsgPanelInfo (self, aFrame, aList)

	GetFriendlyName (self)

	HitTest (self, *args)

	GetBoundingBox (self)

	GetPosition (self)

	SetPosition (self, aPos)

	GetFocusPosition (self)

	GetSortPosition (self)

	Clone (self)

	Visit (self, inspector, testData, aScanTypes)

	GetTypeDesc (self)

	GetItemDescription (self, aUnitsProvider, aFull)

	DisambiguateItemDescription (self, aUnitsProvider, aFull)

	GetMenuImage (self)

	Matches (self, aSearchData, aAuxData)

	Replace (self, *args)

	IsReplaceable (self)

	__lt__ (self, aItem)

	ViewBBox (self)

	ViewGetLayers (self)

	GetEmbeddedFonts (self)

	PyGetClass (self)

Static Public Member Functions
	ClassOf (aItem)

	MakeUniqueZoneName (aBaseName, aInUse)

	GetStandardLayerName (aLayerId)

Static Public Member Functions inherited from pcbnew.EDA_ITEM
	Sort (aLeft, aRight)

Public Attributes
	this = this

Static Public Attributes
dict	netclassmap = {k:v for k,v in self.GetNetClasses().items()}

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

	INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE

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

	m_LegacyVisibleLayers = property(_pcbnew.BOARD_m_LegacyVisibleLayers_get, _pcbnew.BOARD_m_LegacyVisibleLayers_set, doc=)

	m_LegacyVisibleItems = property(_pcbnew.BOARD_m_LegacyVisibleItems_get, _pcbnew.BOARD_m_LegacyVisibleItems_set, doc=)

	m_LegacyDesignSettingsLoaded = property(_pcbnew.BOARD_m_LegacyDesignSettingsLoaded_get, _pcbnew.BOARD_m_LegacyDesignSettingsLoaded_set, doc=)

	m_LegacyCopperEdgeClearanceLoaded = property(_pcbnew.BOARD_m_LegacyCopperEdgeClearanceLoaded_get, _pcbnew.BOARD_m_LegacyCopperEdgeClearanceLoaded_set, doc=)

	m_LegacyNetclassesLoaded = property(_pcbnew.BOARD_m_LegacyNetclassesLoaded_get, _pcbnew.BOARD_m_LegacyNetclassesLoaded_set, doc=)

	m_ZoneBBoxCache = property(_pcbnew.BOARD_m_ZoneBBoxCache_get, _pcbnew.BOARD_m_ZoneBBoxCache_set, doc=)

	m_maxClearanceValue = property(_pcbnew.BOARD_m_maxClearanceValue_get, _pcbnew.BOARD_m_maxClearanceValue_set, doc=)

	m_ZonesByNameCache = property(_pcbnew.BOARD_m_ZonesByNameCache_get, _pcbnew.BOARD_m_ZonesByNameCache_set, doc=)

	m_DeflatedZoneOutlineCache = property(_pcbnew.BOARD_m_DeflatedZoneOutlineCache_get, _pcbnew.BOARD_m_DeflatedZoneOutlineCache_set, doc=)

	m_SolderMaskBridges = property(_pcbnew.BOARD_m_SolderMaskBridges_get, _pcbnew.BOARD_m_SolderMaskBridges_set, doc=)

	m_ZoneIsolatedIslandsMap = property(_pcbnew.BOARD_m_ZoneIsolatedIslandsMap_get, _pcbnew.BOARD_m_ZoneIsolatedIslandsMap_set, doc=)

Properties inherited from pcbnew.BOARD_ITEM_CONTAINER
	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 class.

Definition at line 21905 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init() [1/2]

pcbnew.BOARD.__init__	(		self,
		*	args,
		**	kwargs )

Definition at line 21910 of file pcbnew.py.

◆ init() [2/2]

pcbnew.BOARD.__init__	(		self,
		*	args )

Definition at line 22724 of file pcbnew.py.

Member Function Documentation

◆ AddArea()

pcbnew.BOARD.AddArea	(	self,
		aNewZonesList,
		aNetcode,
		aLayer,
		aStartPointPosition,
		aHatch )

AddArea(BOARD self, PICKED_ITEMS_LIST * aNewZonesList, int aNetcode, PCB_LAYER_ID aLayer, VECTOR2I aStartPointPosition, ZONE_BORDER_DISPLAY_STYLE aHatch) -> ZONE

Definition at line 22542 of file pcbnew.py.

◆ AddListener()

pcbnew.BOARD.AddListener	(		self,
			aListener )

AddListener(BOARD self, BOARD_LISTENER aListener)

Definition at line 22587 of file pcbnew.py.

◆ AddNative()

pcbnew.BOARD.AddNative	(		self,
		*	args )

AddNative(BOARD self, BOARD_ITEM aItem, ADD_MODE aMode=INSERT, bool aSkipConnectivity=False)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 22103 of file pcbnew.py.

◆ AddVariant()

pcbnew.BOARD.AddVariant	(		self,
			aVariantName )

AddVariant(BOARD self, wxString aVariantName)

Definition at line 22041 of file pcbnew.py.

◆ AllConnectedItems()

pcbnew.BOARD.AllConnectedItems ( self )

AllConnectedItems(BOARD self) -> std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const

Definition at line 22009 of file pcbnew.py.

◆ BoardOutline()

pcbnew.BOARD.BoardOutline	(		self,
		*	args )

    BoardOutline(BOARD self) -> PCB_BOARD_OUTLINE
    BoardOutline(BOARD self) -> PCB_BOARD_OUTLINE const *

Definition at line 21968 of file pcbnew.py.

◆ BuildConnectivity()

pcbnew.BOARD.BuildConnectivity	(		self,
			aReporter = None )

BuildConnectivity(BOARD self, PROGRESS_REPORTER * aReporter=None) -> bool

Definition at line 22192 of file pcbnew.py.

◆ BuildListOfNets()

pcbnew.BOARD.BuildListOfNets ( self )

BuildListOfNets(BOARD self)

Definition at line 22447 of file pcbnew.py.

◆ BulkRemoveStaleTeardrops()

pcbnew.BOARD.BulkRemoveStaleTeardrops	(		self,
			aCommit )

BulkRemoveStaleTeardrops(BOARD self, BOARD_COMMIT & aCommit)

Definition at line 22128 of file pcbnew.py.

◆ CacheAndReturnItemById()

pcbnew.BOARD.CacheAndReturnItemById	(	self,
		aId,
		aItem )

CacheAndReturnItemById(BOARD self, KIID aId, BOARD_ITEM aItem) -> BOARD_ITEM

Definition at line 22710 of file pcbnew.py.

◆ CacheChildrenById()

pcbnew.BOARD.CacheChildrenById	(		self,
			aParent )

CacheChildrenById(BOARD self, BOARD_ITEM aParent)

Definition at line 22694 of file pcbnew.py.

◆ CacheItemById()

pcbnew.BOARD.CacheItemById	(		self,
			aItem )

CacheItemById(BOARD self, BOARD_ITEM aItem)

Definition at line 22682 of file pcbnew.py.

◆ CacheItemSubtreeById()

pcbnew.BOARD.CacheItemSubtreeById	(		self,
			aItem )

CacheItemSubtreeById(BOARD self, BOARD_ITEM aItem)

Definition at line 22690 of file pcbnew.py.

◆ CacheTriangulation()

pcbnew.BOARD.CacheTriangulation	(		self,
		*	args )

CacheTriangulation(BOARD self, PROGRESS_REPORTER * aReporter=None, ZONES aZones={})

Definition at line 22148 of file pcbnew.py.

◆ ClassOf()

pcbnew.BOARD.ClassOf ( aItem )

static

ClassOf(EDA_ITEM aItem) -> bool

Definition at line 21915 of file pcbnew.py.

◆ ClearItemByIdCache()

pcbnew.BOARD.ClearItemByIdCache ( self )

ClearItemByIdCache(BOARD self)

Definition at line 22714 of file pcbnew.py.

◆ ClearProject()

pcbnew.BOARD.ClearProject ( self )

ClearProject(BOARD self)

Definition at line 22211 of file pcbnew.py.

◆ ComputeBoundingBox()

pcbnew.BOARD.ComputeBoundingBox	(	self,
		aBoardEdgesOnly = False,
		aPhysicalLayersOnly = False )

ComputeBoundingBox(BOARD self, bool aBoardEdgesOnly=False, bool aPhysicalLayersOnly=False) -> BOX2I

Definition at line 22486 of file pcbnew.py.

◆ ConvertBrdLayerToPolygonalContours()

pcbnew.BOARD.ConvertBrdLayerToPolygonalContours	(	self,
		aLayer,
		aOutlines,
		aRenderSettings = None )

ConvertBrdLayerToPolygonalContours(BOARD self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aOutlines, KIGFX::RENDER_SETTINGS * aRenderSettings=None)

Definition at line 22398 of file pcbnew.py.

◆ ConvertCrossReferencesToKIIDs()

pcbnew.BOARD.ConvertCrossReferencesToKIIDs	(		self,
			aSource )

ConvertCrossReferencesToKIIDs(BOARD self, wxString aSource) -> wxString

Definition at line 22180 of file pcbnew.py.

◆ ConvertKIIDsToCrossReferences()

pcbnew.BOARD.ConvertKIIDsToCrossReferences	(		self,
			aSource )

ConvertKIIDsToCrossReferences(BOARD self, wxString aSource) -> wxString

Definition at line 22184 of file pcbnew.py.

◆ CopyVariant()

pcbnew.BOARD.CopyVariant	(		self,
		*	args )

CopyVariant(BOARD self, wxString aOldName, wxString aNewName, wxString aNewDescription=wxEmptyString)

Definition at line 22053 of file pcbnew.py.

◆ DeleteAllFootprints()

pcbnew.BOARD.DeleteAllFootprints ( self )

DeleteAllFootprints(BOARD self)

Definition at line 22156 of file pcbnew.py.

◆ DeleteMARKERs()

pcbnew.BOARD.DeleteMARKERs	(		self,
		*	args )

    DeleteMARKERs(BOARD self)
    DeleteMARKERs(BOARD self, bool aWarningsAndErrors, bool aExclusions)

Definition at line 22196 of file pcbnew.py.

◆ DeleteVariant()

pcbnew.BOARD.DeleteVariant	(		self,
			aVariantName )

DeleteVariant(BOARD self, wxString aVariantName)

Definition at line 22045 of file pcbnew.py.

◆ DetachAllFootprints()

pcbnew.BOARD.DetachAllFootprints ( self )

DetachAllFootprints(BOARD self)

Definition at line 22160 of file pcbnew.py.

◆ DpCoupledNet()

pcbnew.BOARD.DpCoupledNet	(		self,
			aNet )

DpCoupledNet(BOARD self, NETINFO_ITEM aNet) -> NETINFO_ITEM

Definition at line 22462 of file pcbnew.py.

◆ Drawings()

pcbnew.BOARD.Drawings	(		self,
		*	args )

    Drawings(BOARD self) -> DRAWINGS
    Drawings(BOARD self) -> DRAWINGS

Definition at line 21987 of file pcbnew.py.

◆ EmbedFonts()

pcbnew.BOARD.EmbedFonts ( self )

EmbedFonts(BOARD self)

Definition at line 22646 of file pcbnew.py.

◆ FillItemMap()

pcbnew.BOARD.FillItemMap	(		self,
			aMap )

FillItemMap(BOARD self, std::map< KIID,EDA_ITEM *,std::less< KIID >,std::allocator< std::pair< KIID const,EDA_ITEM * > > > & aMap)

Definition at line 22176 of file pcbnew.py.

◆ FinalizeBulkAdd()

pcbnew.BOARD.FinalizeBulkAdd	(		self,
			aNewItems )

FinalizeBulkAdd(BOARD self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aNewItems)

Definition at line 22132 of file pcbnew.py.

◆ FinalizeBulkRemove()

pcbnew.BOARD.FinalizeBulkRemove	(		self,
			aRemovedItems )

FinalizeBulkRemove(BOARD self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aRemovedItems)

Definition at line 22136 of file pcbnew.py.

◆ FindFootprintByPath()

pcbnew.BOARD.FindFootprintByPath	(		self,
			aPath )

FindFootprintByPath(BOARD self, KIID_PATH aPath) -> FOOTPRINT

Definition at line 22498 of file pcbnew.py.

◆ FindFootprintByReference()

pcbnew.BOARD.FindFootprintByReference	(		self,
			aReference )

FindFootprintByReference(BOARD self, wxString aReference) -> FOOTPRINT

Definition at line 22494 of file pcbnew.py.

◆ FindNet()

pcbnew.BOARD.FindNet	(		self,
		*	args )

    FindNet(BOARD self, int aNetcode) -> NETINFO_ITEM
    FindNet(BOARD self, wxString aNetname) -> NETINFO_ITEM

Definition at line 22451 of file pcbnew.py.

◆ FixupEmbeddedData()

pcbnew.BOARD.FixupEmbeddedData ( self )

FixupEmbeddedData(BOARD self)

Definition at line 22140 of file pcbnew.py.

◆ FlipLayer()

pcbnew.BOARD.FlipLayer	(		self,
			aLayer )

FlipLayer(BOARD self, PCB_LAYER_ID aLayer) -> PCB_LAYER_ID

Definition at line 22271 of file pcbnew.py.

◆ Footprints()

pcbnew.BOARD.Footprints ( self )

Footprints(BOARD self) -> FOOTPRINTS

Definition at line 21947 of file pcbnew.py.

◆ Generators()

pcbnew.BOARD.Generators ( self )

Generators(BOARD self) -> GENERATORS

Definition at line 21964 of file pcbnew.py.

◆ GetAllNetClasses()

pcbnew.BOARD.GetAllNetClasses ( self )

Return a dictionary like object with net_class_name as key and NETCLASSPTR as value
GetNetClasses(BOARD self) -> { wxString net_class_name : NETCLASSPTR }
Include the "Default" netclass also.

Definition at line 22772 of file pcbnew.py.

◆ GetArea()

pcbnew.BOARD.GetArea	(		self,
			index )

GetArea(BOARD self, int index) -> ZONE

Definition at line 22530 of file pcbnew.py.

◆ GetAreaCount()

pcbnew.BOARD.GetAreaCount ( self )

GetAreaCount(BOARD self) -> int

Definition at line 22538 of file pcbnew.py.

◆ GetBoardEdgesBoundingBox()

pcbnew.BOARD.GetBoardEdgesBoundingBox ( self )

GetBoardEdgesBoundingBox(BOARD self) -> BOX2I

Definition at line 22490 of file pcbnew.py.

◆ GetBoardPolygonOutlines()

pcbnew.BOARD.GetBoardPolygonOutlines	(	self,
		aOutlines,
		aInferOutlineIfNecessary,
		aErrorHandler = None,
		aAllowUseArcsInPolygons = False,
		aIncludeNPTHAsOutlines = False )

GetBoardPolygonOutlines(BOARD self, SHAPE_POLY_SET aOutlines, bool aInferOutlineIfNecessary, OUTLINE_ERROR_HANDLER * aErrorHandler=None, bool aAllowUseArcsInPolygons=False, bool aIncludeNPTHAsOutlines=False) -> bool

Definition at line 22386 of file pcbnew.py.

◆ GetBoardUse()

pcbnew.BOARD.GetBoardUse ( self )

GetBoardUse(BOARD self) -> BOARD_USE

Definition at line 21923 of file pcbnew.py.

◆ GetCachedItemById()

pcbnew.BOARD.GetCachedItemById	(		self,
			aId )

GetCachedItemById(BOARD self, KIID aId) -> BOARD_ITEM

Definition at line 22678 of file pcbnew.py.

◆ GetClass()

pcbnew.BOARD.GetClass ( self )

GetClass(BOARD self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 22522 of file pcbnew.py.

◆ GetComponentClassManager()

pcbnew.BOARD.GetComponentClassManager ( self )

GetComponentClassManager(BOARD self) -> COMPONENT_CLASS_MANAGER &

Definition at line 22654 of file pcbnew.py.

◆ GetConnectivity()

pcbnew.BOARD.GetConnectivity ( self )

GetConnectivity(BOARD self) -> std::shared_ptr< CONNECTIVITY_DATA >

Definition at line 22188 of file pcbnew.py.

◆ GetContextualTextVars()

pcbnew.BOARD.GetContextualTextVars	(		self,
			aVars )

GetContextualTextVars(BOARD self, wxArrayString * aVars)

Definition at line 22069 of file pcbnew.py.

◆ GetCopperLayerCount()

pcbnew.BOARD.GetCopperLayerCount ( self )

GetCopperLayerCount(BOARD self) -> int

Definition at line 22251 of file pcbnew.py.

◆ GetCopperLayerStackMaxId()

pcbnew.BOARD.GetCopperLayerStackMaxId ( self )

GetCopperLayerStackMaxId(BOARD self) -> PCB_LAYER_ID

Definition at line 22267 of file pcbnew.py.

◆ GetCurrentNetClassName()

pcbnew.BOARD.GetCurrentNetClassName ( self )

Definition at line 22744 of file pcbnew.py.

◆ GetCurrentVariant()

pcbnew.BOARD.GetCurrentVariant ( self )

GetCurrentVariant(BOARD self) -> wxString

Definition at line 22021 of file pcbnew.py.

◆ GetDesignSettings()

pcbnew.BOARD.GetDesignSettings ( self )

GetDesignSettings(BOARD self) -> BOARD_DESIGN_SETTINGS

Definition at line 22327 of file pcbnew.py.

◆ GetDrawings()

pcbnew.BOARD.GetDrawings ( self )

Definition at line 22735 of file pcbnew.py.

◆ GetEmbeddedFiles()

pcbnew.BOARD.GetEmbeddedFiles	(		self,
		*	args )

    GetEmbeddedFiles(BOARD self) -> EMBEDDED_FILES
    GetEmbeddedFiles(BOARD self) -> EMBEDDED_FILES const *

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 22631 of file pcbnew.py.

◆ GetEnabledLayers()

pcbnew.BOARD.GetEnabledLayers ( self )

GetEnabledLayers(BOARD self) -> LSET

Definition at line 22279 of file pcbnew.py.

◆ GetFileFormatVersionAtLoad()

pcbnew.BOARD.GetFileFormatVersionAtLoad ( self )

GetFileFormatVersionAtLoad(BOARD self) -> int

Definition at line 22091 of file pcbnew.py.

◆ GetFileName()

pcbnew.BOARD.GetFileName ( self )

GetFileName(BOARD self) -> wxString

Definition at line 21943 of file pcbnew.py.

◆ GetFirstFootprint()

pcbnew.BOARD.GetFirstFootprint ( self )

GetFirstFootprint(BOARD self) -> FOOTPRINT

Definition at line 22152 of file pcbnew.py.

◆ GetFonts()

pcbnew.BOARD.GetFonts ( self )

GetFonts(BOARD self) -> std::set< KIFONT::OUTLINE_FONT *,std::less< KIFONT::OUTLINE_FONT * >,std::allocator< KIFONT::OUTLINE_FONT * > >

Definition at line 22642 of file pcbnew.py.

◆ GetFootprint()

pcbnew.BOARD.GetFootprint	(	self,
		aPosition,
		aActiveLayer,
		aVisibleOnly,
		aIgnoreLocked = False )

GetFootprint(BOARD self, VECTOR2I aPosition, PCB_LAYER_ID aActiveLayer, bool aVisibleOnly, bool aIgnoreLocked=False) -> FOOTPRINT

Definition at line 22571 of file pcbnew.py.

◆ GetFootprints()

pcbnew.BOARD.GetFootprints ( self )

Definition at line 22734 of file pcbnew.py.

◆ GetGenerator()

pcbnew.BOARD.GetGenerator ( self )

GetGenerator(BOARD self) -> wxString

Definition at line 22099 of file pcbnew.py.

◆ GetHighLightNetCodes()

pcbnew.BOARD.GetHighLightNetCodes ( self )

GetHighLightNetCodes(BOARD self) -> std::set< int,std::less< int >,std::allocator< int > > const &

Definition at line 22231 of file pcbnew.py.

◆ GetHistoryLifetimeToken()

pcbnew.BOARD.GetHistoryLifetimeToken ( self )

GetHistoryLifetimeToken(BOARD self) -> std::weak_ptr< void >

Definition at line 22666 of file pcbnew.py.

◆ GetItemByIdCache()

pcbnew.BOARD.GetItemByIdCache ( self )

GetItemByIdCache(BOARD self) -> std::unordered_map< KIID,BOARD_ITEM * > const &

Definition at line 22670 of file pcbnew.py.

◆ GetItemSet()

pcbnew.BOARD.GetItemSet ( self )

GetItemSet(BOARD self) -> BOARD_ITEM_SET const

Definition at line 22001 of file pcbnew.py.

◆ GetLayerID()

pcbnew.BOARD.GetLayerID	(		self,
			aLayerName )

GetLayerID(BOARD self, wxString aLayerName) -> PCB_LAYER_ID

Definition at line 22402 of file pcbnew.py.

◆ GetLayerName()

pcbnew.BOARD.GetLayerName	(		self,
			aLayer )

GetLayerName(BOARD self, PCB_LAYER_ID aLayer) -> wxString

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 22406 of file pcbnew.py.

◆ GetLayerType()

pcbnew.BOARD.GetLayerType	(		self,
			aLayer )

GetLayerType(BOARD self, PCB_LAYER_ID aLayer) -> LAYER_T

Definition at line 22431 of file pcbnew.py.

◆ GetLengthCalculation()

pcbnew.BOARD.GetLengthCalculation ( self )

GetLengthCalculation(BOARD self) -> LENGTH_DELAY_CALCULATION *

Definition at line 22650 of file pcbnew.py.

◆ GetMaxClearanceValue()

pcbnew.BOARD.GetMaxClearanceValue ( self )

GetMaxClearanceValue(BOARD self) -> int

Definition at line 22575 of file pcbnew.py.

◆ GetNetClassAssignmentCandidates()

pcbnew.BOARD.GetNetClassAssignmentCandidates ( self )

GetNetClassAssignmentCandidates(BOARD self) -> STRINGSET

Definition at line 22502 of file pcbnew.py.

◆ GetNetClasses()

pcbnew.BOARD.GetNetClasses ( self )

Definition at line 22741 of file pcbnew.py.

◆ GetNetcodeFromNetname()

pcbnew.BOARD.GetNetcodeFromNetname	(		self,
			netname )

Given a netname, return its netcode

Definition at line 22765 of file pcbnew.py.

◆ GetNetCount()

pcbnew.BOARD.GetNetCount ( self )

GetNetCount(BOARD self) -> unsigned int

Definition at line 22474 of file pcbnew.py.

◆ GetNetInfo()

pcbnew.BOARD.GetNetInfo ( self )

GetNetInfo(BOARD self) -> NETINFO_LIST

Definition at line 22466 of file pcbnew.py.

◆ GetNetsByName()

pcbnew.BOARD.GetNetsByName ( self )

Return a dictionary like object with key:wxString netname and value:NETINFO_ITEM

Definition at line 22753 of file pcbnew.py.

◆ GetNetsByNetcode()

pcbnew.BOARD.GetNetsByNetcode ( self )

Return a dictionary like object with key:int netcode and value:NETINFO_ITEM

Definition at line 22759 of file pcbnew.py.

◆ GetNodesCount()

pcbnew.BOARD.GetNodesCount	(		self,
			aNet = -1 )

GetNodesCount(BOARD self, int aNet=-1) -> unsigned int

Definition at line 22439 of file pcbnew.py.

◆ GetOutlinesChainingEpsilon()

pcbnew.BOARD.GetOutlinesChainingEpsilon ( self )

GetOutlinesChainingEpsilon(BOARD self) -> int

Definition at line 22390 of file pcbnew.py.

◆ GetPad()

pcbnew.BOARD.GetPad	(		self,
		*	args )

    GetPad(BOARD self, VECTOR2I aPosition, LSET aLayerMask) -> PAD
    GetPad(BOARD self, VECTOR2I aPosition) -> PAD
    GetPad(BOARD self, PCB_TRACK aTrace, ENDPOINT_T aEndPoint) -> PAD
    GetPad(BOARD self, PADS_VEC aPadList, VECTOR2I aPosition, LSET aLayerMask) -> PAD

Definition at line 22550 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetPads()

pcbnew.BOARD.GetPads ( self )

GetPads(BOARD self) -> PADS_VEC

Definition at line 22443 of file pcbnew.py.

◆ GetPadWithCastellatedAttrCount()

pcbnew.BOARD.GetPadWithCastellatedAttrCount ( self )

GetPadWithCastellatedAttrCount(BOARD self) -> int

Definition at line 22482 of file pcbnew.py.

◆ GetPadWithPressFitAttrCount()

pcbnew.BOARD.GetPadWithPressFitAttrCount ( self )

GetPadWithPressFitAttrCount(BOARD self) -> int

Definition at line 22478 of file pcbnew.py.

◆ GetPageSettings()

pcbnew.BOARD.GetPageSettings ( self )

GetPageSettings(BOARD self) -> PAGE_INFO const &

Definition at line 22347 of file pcbnew.py.

◆ GetPlotOptions()

pcbnew.BOARD.GetPlotOptions ( self )

GetPlotOptions(BOARD self) -> PCB_PLOT_PARAMS

Definition at line 22355 of file pcbnew.py.

◆ GetProject()

pcbnew.BOARD.GetProject ( self )

GetProject(BOARD self) -> PROJECT *

Definition at line 22203 of file pcbnew.py.

◆ GetProperties()

pcbnew.BOARD.GetProperties ( self )

GetProperties(BOARD self) -> MAP_STRING_STRING

Definition at line 22013 of file pcbnew.py.

◆ GetSortedPadListByXthenYCoord()

pcbnew.BOARD.GetSortedPadListByXthenYCoord	(	self,
		aVector,
		aNetCode = -1 )

GetSortedPadListByXthenYCoord(BOARD self, PADS_VEC aVector, int aNetCode=-1)

Definition at line 22559 of file pcbnew.py.

◆ GetStackupOrDefault()

pcbnew.BOARD.GetStackupOrDefault ( self )

GetStackupOrDefault(BOARD self) -> BOARD_STACKUP

Definition at line 22343 of file pcbnew.py.

◆ GetStandardLayerName()

pcbnew.BOARD.GetStandardLayerName ( aLayerId )

static

GetStandardLayerName(PCB_LAYER_ID aLayerId) -> wxString

Definition at line 22415 of file pcbnew.py.

◆ GetTimeStamp()

pcbnew.BOARD.GetTimeStamp ( self )

GetTimeStamp(BOARD self) -> int

Definition at line 21931 of file pcbnew.py.

◆ GetTitleBlock()

pcbnew.BOARD.GetTitleBlock	(		self,
		*	args )

    GetTitleBlock(BOARD self) -> TITLE_BLOCK
    GetTitleBlock(BOARD self) -> TITLE_BLOCK

Definition at line 22363 of file pcbnew.py.

◆ GetTrackLength()

pcbnew.BOARD.GetTrackLength	(		self,
			aTrack )

GetTrackLength(BOARD self, PCB_TRACK aTrack) -> std::tuple< int,double,double,double,double >

Definition at line 22563 of file pcbnew.py.

◆ GetTracks()

pcbnew.BOARD.GetTracks ( self )

Definition at line 22736 of file pcbnew.py.

◆ GetTrackWidthList()

pcbnew.BOARD.GetTrackWidthList ( self )

Definition at line 22750 of file pcbnew.py.

◆ GetUniqueZoneName()

pcbnew.BOARD.GetUniqueZoneName	(	self,
		aBaseName,
		aExclude = None )

GetUniqueZoneName(BOARD self, wxString aBaseName, ZONE aExclude=None) -> wxString

Definition at line 21955 of file pcbnew.py.

◆ GetUserDefinedLayerCount()

pcbnew.BOARD.GetUserDefinedLayerCount ( self )

GetUserDefinedLayerCount(BOARD self) -> int

Definition at line 22259 of file pcbnew.py.

◆ GetUserUnits()

pcbnew.BOARD.GetUserUnits ( self )

GetUserUnits(BOARD self) -> EDA_UNITS

Definition at line 22374 of file pcbnew.py.

◆ GetVariantDescription()

pcbnew.BOARD.GetVariantDescription	(		self,
			aVariantName )

GetVariantDescription(BOARD self, wxString aVariantName) -> wxString

Definition at line 22057 of file pcbnew.py.

◆ GetVariantNames()

pcbnew.BOARD.GetVariantNames ( self )

GetVariantNames(BOARD self) -> std::vector< wxString,std::allocator< wxString > > const &

Definition at line 22029 of file pcbnew.py.

◆ GetVariantNamesForUI()

pcbnew.BOARD.GetVariantNamesForUI ( self )

GetVariantNamesForUI(BOARD self) -> wxArrayString

Definition at line 22065 of file pcbnew.py.

◆ GetViasDimensionsList()

pcbnew.BOARD.GetViasDimensionsList ( self )

Definition at line 22747 of file pcbnew.py.

◆ GetVisibleElements()

pcbnew.BOARD.GetVisibleElements ( self )

GetVisibleElements(BOARD self) -> GAL_SET

Definition at line 22303 of file pcbnew.py.

◆ GetVisibleLayers()

pcbnew.BOARD.GetVisibleLayers ( self )

GetVisibleLayers(BOARD self) -> LSET

Definition at line 22295 of file pcbnew.py.

◆ GetZoneList()

pcbnew.BOARD.GetZoneList	(		self,
			aIncludeZonesInFootprints = False )

GetZoneList(BOARD self, bool aIncludeZonesInFootprints=False) -> std::list< ZONE *,std::allocator< ZONE * > >

Definition at line 22534 of file pcbnew.py.

◆ Groups()

pcbnew.BOARD.Groups ( self )

Groups(BOARD self) -> GROUPS

Definition at line 22005 of file pcbnew.py.

◆ GroupsSanityCheck()

pcbnew.BOARD.GroupsSanityCheck	(		self,
			repair = False )

GroupsSanityCheck(BOARD self, bool repair=False) -> wxString

Definition at line 22615 of file pcbnew.py.

◆ GroupsSanityCheckInternal()

pcbnew.BOARD.GroupsSanityCheckInternal	(		self,
			repair )

GroupsSanityCheckInternal(BOARD self, bool repair) -> wxString

Definition at line 22619 of file pcbnew.py.

◆ HasItemsOnLayer()

pcbnew.BOARD.HasItemsOnLayer	(		self,
			aLayer )

HasItemsOnLayer(BOARD self, PCB_LAYER_ID aLayer) -> bool

Definition at line 22120 of file pcbnew.py.

◆ HasVariant()

pcbnew.BOARD.HasVariant	(		self,
			aVariantName )

HasVariant(BOARD self, wxString aVariantName) -> bool

Definition at line 22037 of file pcbnew.py.

◆ HighLightOFF()

pcbnew.BOARD.HighLightOFF ( self )

HighLightOFF(BOARD self)

Definition at line 22247 of file pcbnew.py.

◆ HighLightON()

pcbnew.BOARD.HighLightON	(		self,
			aValue = True )

HighLightON(BOARD self, bool aValue=True)

Definition at line 22243 of file pcbnew.py.

◆ IncrementTimeStamp()

pcbnew.BOARD.IncrementTimeStamp ( self )

IncrementTimeStamp(BOARD self)

Definition at line 21927 of file pcbnew.py.

◆ InitializeClearanceCache()

pcbnew.BOARD.InitializeClearanceCache ( self )

InitializeClearanceCache(BOARD self)

Definition at line 22339 of file pcbnew.py.

◆ InvalidateClearanceCache()

pcbnew.BOARD.InvalidateClearanceCache	(		self,
			aUuid )

InvalidateClearanceCache(BOARD self, KIID aUuid)

Definition at line 22335 of file pcbnew.py.

◆ IsBackLayer()

pcbnew.BOARD.IsBackLayer	(		self,
			aLayer )

IsBackLayer(BOARD self, PCB_LAYER_ID aLayer) -> bool

Definition at line 22427 of file pcbnew.py.

◆ IsElementVisible()

pcbnew.BOARD.IsElementVisible	(		self,
			aLayer )

IsElementVisible(BOARD self, GAL_LAYER_ID aLayer) -> bool

Definition at line 22315 of file pcbnew.py.

◆ IsEmpty()

pcbnew.BOARD.IsEmpty ( self )

IsEmpty(BOARD self) -> bool

Definition at line 22083 of file pcbnew.py.

◆ IsFootprintHolder()

pcbnew.BOARD.IsFootprintHolder ( self )

IsFootprintHolder(BOARD self) -> bool

Definition at line 21935 of file pcbnew.py.

◆ IsFootprintLayerVisible()

pcbnew.BOARD.IsFootprintLayerVisible	(		self,
			aLayer )

IsFootprintLayerVisible(BOARD self, PCB_LAYER_ID aLayer) -> bool

Definition at line 22323 of file pcbnew.py.

◆ IsFrontLayer()

pcbnew.BOARD.IsFrontLayer	(		self,
			aLayer )

IsFrontLayer(BOARD self, PCB_LAYER_ID aLayer) -> bool

Definition at line 22423 of file pcbnew.py.

◆ IsHighLightNetON()

pcbnew.BOARD.IsHighLightNetON ( self )

IsHighLightNetON(BOARD self) -> bool

Definition at line 22239 of file pcbnew.py.

◆ IsItemIndexedById()

pcbnew.BOARD.IsItemIndexedById	(		self,
			aItem )

IsItemIndexedById(BOARD self, BOARD_ITEM aItem) -> bool

Definition at line 22674 of file pcbnew.py.

◆ IsLayerEnabled()

pcbnew.BOARD.IsLayerEnabled	(		self,
			aLayer )

IsLayerEnabled(BOARD self, PCB_LAYER_ID aLayer) -> bool

Definition at line 22287 of file pcbnew.py.

◆ IsLayerVisible()

pcbnew.BOARD.IsLayerVisible	(		self,
			aLayer )

IsLayerVisible(BOARD self, PCB_LAYER_ID aLayer) -> bool

Definition at line 22291 of file pcbnew.py.

◆ LayerDepth()

pcbnew.BOARD.LayerDepth	(	self,
		aStartLayer,
		aEndLayer )

LayerDepth(BOARD self, PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer) -> int

Definition at line 22275 of file pcbnew.py.

◆ LegacyTeardrops()

pcbnew.BOARD.LegacyTeardrops ( self )

LegacyTeardrops(BOARD self) -> bool

Definition at line 22623 of file pcbnew.py.

◆ MakeUniqueZoneName()

pcbnew.BOARD.MakeUniqueZoneName	(		aBaseName,
			aInUse )

static

MakeUniqueZoneName(wxString aBaseName, std::function< bool (wxString const &) > const & aInUse) -> wxString

Definition at line 21960 of file pcbnew.py.

◆ MapNets()

pcbnew.BOARD.MapNets	(		self,
			aDestBoard )

MapNets(BOARD self, BOARD aDestBoard)

Definition at line 22579 of file pcbnew.py.

◆ Markers()

pcbnew.BOARD.Markers ( self )

Markers(BOARD self) -> MARKERS

Definition at line 21979 of file pcbnew.py.

◆ MatchDpSuffix()

pcbnew.BOARD.MatchDpSuffix	(	self,
		aNetName,
		aComplementNet )

MatchDpSuffix(BOARD self, wxString aNetName, wxString aComplementNet) -> int

Definition at line 22458 of file pcbnew.py.

◆ OnItemChanged()

pcbnew.BOARD.OnItemChanged	(		self,
			aItem )

OnItemChanged(BOARD self, BOARD_ITEM aItem)

Definition at line 22599 of file pcbnew.py.

◆ OnItemsChanged()

pcbnew.BOARD.OnItemsChanged	(		self,
			aItems )

OnItemsChanged(BOARD self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aItems)

Definition at line 22603 of file pcbnew.py.

◆ OnItemsCompositeUpdate()

pcbnew.BOARD.OnItemsCompositeUpdate	(	self,
		aAddedItems,
		aRemovedItems,
		aChangedItems )

OnItemsCompositeUpdate(BOARD self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aAddedItems, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aRemovedItems, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > & aChangedItems)

Definition at line 22607 of file pcbnew.py.

◆ OnRatsnestChanged()

pcbnew.BOARD.OnRatsnestChanged ( self )

OnRatsnestChanged(BOARD self)

Definition at line 22611 of file pcbnew.py.

◆ Points()

pcbnew.BOARD.Points ( self )

Points(BOARD self) -> PCB_POINTS

Definition at line 21983 of file pcbnew.py.

◆ ProjectElementType()

pcbnew.BOARD.ProjectElementType ( self )

ProjectElementType(BOARD self) -> PROJECT::ELEM

Definition at line 22658 of file pcbnew.py.

◆ RebindItemUuid()

pcbnew.BOARD.RebindItemUuid	(	self,
		aItem,
		aNewId )

RebindItemUuid(BOARD self, BOARD_ITEM aItem, KIID aNewId)

Definition at line 22168 of file pcbnew.py.

◆ RecordDRCExclusions()

pcbnew.BOARD.RecordDRCExclusions ( self )

RecordDRCExclusions(BOARD self)

Definition at line 22219 of file pcbnew.py.

◆ RemoveAll()

pcbnew.BOARD.RemoveAll	(		self,
		*	args )

    RemoveAll(BOARD self, std::initializer_list< KICAD_T > aTypes={ PCB_NETINFO_T, PCB_MARKER_T,
                                                                  PCB_GROUP_T, PCB_ZONE_T,
                                                                  PCB_GENERATOR_T, PCB_FOOTPRINT_T,
                                                                  PCB_TRACE_T, PCB_SHAPE_T })

Definition at line 22111 of file pcbnew.py.

◆ RemoveAllItemsOnLayer()

pcbnew.BOARD.RemoveAllItemsOnLayer	(		self,
			aLayer )

RemoveAllItemsOnLayer(BOARD self, PCB_LAYER_ID aLayer) -> bool

Definition at line 22124 of file pcbnew.py.

◆ RemoveAllListeners()

pcbnew.BOARD.RemoveAllListeners ( self )

RemoveAllListeners(BOARD self)

Definition at line 22595 of file pcbnew.py.

◆ RemoveListener()

pcbnew.BOARD.RemoveListener	(		self,
			aListener )

RemoveListener(BOARD self, BOARD_LISTENER aListener)

Definition at line 22591 of file pcbnew.py.

◆ RemoveNative()

pcbnew.BOARD.RemoveNative	(		self,
		*	args )

RemoveNative(BOARD self, BOARD_ITEM aBoardItem, REMOVE_MODE aMode=NORMAL)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 22107 of file pcbnew.py.

◆ RemoveUnusedNets()

pcbnew.BOARD.RemoveUnusedNets	(		self,
			aCommit )

RemoveUnusedNets(BOARD self, BOARD_COMMIT * aCommit)

Definition at line 22470 of file pcbnew.py.

◆ RenameVariant()

pcbnew.BOARD.RenameVariant	(	self,
		aOldName,
		aNewName )

RenameVariant(BOARD self, wxString aOldName, wxString aNewName)

Definition at line 22049 of file pcbnew.py.

◆ RepairDuplicateItemUuids()

pcbnew.BOARD.RepairDuplicateItemUuids ( self )

RepairDuplicateItemUuids(BOARD self) -> int

Definition at line 22172 of file pcbnew.py.

◆ ResetNetHighLight()

pcbnew.BOARD.ResetNetHighLight ( self )

ResetNetHighLight(BOARD self)

Definition at line 22227 of file pcbnew.py.

◆ ResolveDRCExclusions()

pcbnew.BOARD.ResolveDRCExclusions	(		self,
			aCreateMarkers )

ResolveDRCExclusions(BOARD self, bool aCreateMarkers) -> MARKERS

Definition at line 22215 of file pcbnew.py.

◆ ResolveItem()

pcbnew.BOARD.ResolveItem	(	self,
		aID,
		aAllowNullptrReturn = False )

ResolveItem(BOARD self, KIID aID, bool aAllowNullptrReturn=False) -> BOARD_ITEM

Definition at line 22164 of file pcbnew.py.

◆ ResolveTextVar()

pcbnew.BOARD.ResolveTextVar	(	self,
		token,
		aDepth )

ResolveTextVar(BOARD self, wxString token, int aDepth) -> bool

Definition at line 22073 of file pcbnew.py.

◆ RunOnNestedEmbeddedFiles()

pcbnew.BOARD.RunOnNestedEmbeddedFiles	(		self,
			aFunction )

RunOnNestedEmbeddedFiles(BOARD self, std::function< void (EMBEDDED_FILES *) > const & aFunction)

Definition at line 22144 of file pcbnew.py.

◆ SanitizeNetcodes()

pcbnew.BOARD.SanitizeNetcodes ( self )

SanitizeNetcodes(BOARD self)

Definition at line 22583 of file pcbnew.py.

◆ Save()

pcbnew.BOARD.Save	(		self,
			filename )

Definition at line 22738 of file pcbnew.py.

◆ SaveToHistory()

pcbnew.BOARD.SaveToHistory	(	self,
		aProjectPath,
		aFileData )

SaveToHistory(BOARD self, wxString aProjectPath, std::vector< HISTORY_FILE_DATA,std::allocator< HISTORY_FILE_DATA > > & aFileData)

Definition at line 22662 of file pcbnew.py.

◆ SetAreasNetCodesFromNetNames()

pcbnew.BOARD.SetAreasNetCodesFromNetNames ( self )

SetAreasNetCodesFromNetNames(BOARD self) -> int

Definition at line 22526 of file pcbnew.py.

◆ SetBoardUse()

pcbnew.BOARD.SetBoardUse	(		self,
			aUse )

SetBoardUse(BOARD self, BOARD_USE aUse)

Definition at line 21919 of file pcbnew.py.

◆ SetCopperLayerCount()

pcbnew.BOARD.SetCopperLayerCount	(		self,
			aCount )

SetCopperLayerCount(BOARD self, int aCount)

Definition at line 22255 of file pcbnew.py.

◆ SetCurrentVariant()

pcbnew.BOARD.SetCurrentVariant	(		self,
			aVariant )

SetCurrentVariant(BOARD self, wxString aVariant)

Definition at line 22025 of file pcbnew.py.

◆ SetDesignSettings()

pcbnew.BOARD.SetDesignSettings	(		self,
			aSettings )

SetDesignSettings(BOARD self, BOARD_DESIGN_SETTINGS aSettings)

Definition at line 22331 of file pcbnew.py.

◆ SetElementVisibility()

pcbnew.BOARD.SetElementVisibility	(	self,
		aLayer,
		aNewState )

SetElementVisibility(BOARD self, GAL_LAYER_ID aLayer, bool aNewState)

Definition at line 22319 of file pcbnew.py.

◆ SetEmbeddedFilesDelegate()

pcbnew.BOARD.SetEmbeddedFilesDelegate	(		self,
			aDelegate )

SetEmbeddedFilesDelegate(BOARD self, EMBEDDED_FILES * aDelegate)

Definition at line 22638 of file pcbnew.py.

◆ SetEnabledLayers()

pcbnew.BOARD.SetEnabledLayers	(		self,
			aLayerMask )

SetEnabledLayers(BOARD self, LSET aLayerMask)

Definition at line 22283 of file pcbnew.py.

◆ SetFileFormatVersionAtLoad()

pcbnew.BOARD.SetFileFormatVersionAtLoad	(		self,
			aVersion )

SetFileFormatVersionAtLoad(BOARD self, int aVersion)

Definition at line 22087 of file pcbnew.py.

◆ SetFileName()

pcbnew.BOARD.SetFileName	(		self,
			aFileName )

SetFileName(BOARD self, wxString aFileName)

Definition at line 21939 of file pcbnew.py.

◆ SetGenerator()

pcbnew.BOARD.SetGenerator	(		self,
			aGenerator )

SetGenerator(BOARD self, wxString aGenerator)

Definition at line 22095 of file pcbnew.py.

◆ SetHighLightNet()

pcbnew.BOARD.SetHighLightNet	(	self,
		aNetCode,
		aMulti = False )

SetHighLightNet(BOARD self, int aNetCode, bool aMulti=False)

Definition at line 22235 of file pcbnew.py.

◆ SetLayerDescr()

pcbnew.BOARD.SetLayerDescr	(	self,
		aIndex,
		aLayer )

SetLayerDescr(BOARD self, PCB_LAYER_ID aIndex, LAYER aLayer) -> bool

Definition at line 22419 of file pcbnew.py.

◆ SetLayerName()

pcbnew.BOARD.SetLayerName	(	self,
		aLayer,
		aLayerName )

SetLayerName(BOARD self, PCB_LAYER_ID aLayer, wxString aLayerName) -> bool

Definition at line 22410 of file pcbnew.py.

◆ SetLayerType()

pcbnew.BOARD.SetLayerType	(	self,
		aLayer,
		aLayerType )

SetLayerType(BOARD self, PCB_LAYER_ID aLayer, LAYER_T aLayerType) -> bool

Definition at line 22435 of file pcbnew.py.

◆ SetLegacyTeardrops()

pcbnew.BOARD.SetLegacyTeardrops	(		self,
			aFlag )

SetLegacyTeardrops(BOARD self, bool aFlag)

Definition at line 22627 of file pcbnew.py.

◆ SetOutlinesChainingEpsilon()

pcbnew.BOARD.SetOutlinesChainingEpsilon	(		self,
			aValue )

SetOutlinesChainingEpsilon(BOARD self, int aValue)

Definition at line 22394 of file pcbnew.py.

◆ SetPageSettings()

pcbnew.BOARD.SetPageSettings	(		self,
			aPageSettings )

SetPageSettings(BOARD self, PAGE_INFO const & aPageSettings)

Definition at line 22351 of file pcbnew.py.

◆ SetPlotOptions()

pcbnew.BOARD.SetPlotOptions	(		self,
			aOptions )

SetPlotOptions(BOARD self, PCB_PLOT_PARAMS aOptions)

Definition at line 22359 of file pcbnew.py.

◆ SetProject()

pcbnew.BOARD.SetProject	(	self,
		aProject,
		aReferenceOnly = False )

SetProject(BOARD self, PROJECT * aProject, bool aReferenceOnly=False)

Definition at line 22207 of file pcbnew.py.

◆ SetProperties()

pcbnew.BOARD.SetProperties	(		self,
			aProps )

SetProperties(BOARD self, MAP_STRING_STRING aProps)

Definition at line 22017 of file pcbnew.py.

◆ SetTitleBlock()

pcbnew.BOARD.SetTitleBlock	(		self,
			aTitleBlock )

SetTitleBlock(BOARD self, TITLE_BLOCK aTitleBlock)

Definition at line 22370 of file pcbnew.py.

◆ SetUserDefinedLayerCount()

pcbnew.BOARD.SetUserDefinedLayerCount	(		self,
			aCount )

SetUserDefinedLayerCount(BOARD self, int aCount)

Definition at line 22263 of file pcbnew.py.

◆ SetUserUnits()

pcbnew.BOARD.SetUserUnits	(		self,
			aUnits )

SetUserUnits(BOARD self, EDA_UNITS aUnits)

Definition at line 22378 of file pcbnew.py.

◆ SetVariantDescription()

pcbnew.BOARD.SetVariantDescription	(	self,
		aVariantName,
		aDescription )

SetVariantDescription(BOARD self, wxString aVariantName, wxString aDescription)

Definition at line 22061 of file pcbnew.py.

◆ SetVariantNames()

pcbnew.BOARD.SetVariantNames	(		self,
			aNames )

SetVariantNames(BOARD self, std::vector< wxString,std::allocator< wxString > > const & aNames)

Definition at line 22033 of file pcbnew.py.

◆ SetVisibleAlls()

pcbnew.BOARD.SetVisibleAlls ( self )

SetVisibleAlls(BOARD self)

Definition at line 22311 of file pcbnew.py.

◆ SetVisibleElements()

pcbnew.BOARD.SetVisibleElements	(		self,
			aMask )

SetVisibleElements(BOARD self, GAL_SET aMask)

Definition at line 22307 of file pcbnew.py.

◆ SetVisibleLayers()

pcbnew.BOARD.SetVisibleLayers	(		self,
			aLayerMask )

SetVisibleLayers(BOARD self, LSET aLayerMask)

Definition at line 22299 of file pcbnew.py.

◆ SynchronizeComponentClasses()

pcbnew.BOARD.SynchronizeComponentClasses	(		self,
			aNewSheetPaths )

SynchronizeComponentClasses(BOARD self, std::unordered_set< wxString > const & aNewSheetPaths) -> bool

Definition at line 22510 of file pcbnew.py.

◆ SynchronizeNetsAndNetClasses()

pcbnew.BOARD.SynchronizeNetsAndNetClasses	(		self,
			aResetTrackAndViaSizes )

SynchronizeNetsAndNetClasses(BOARD self, bool aResetTrackAndViaSizes)

Definition at line 22506 of file pcbnew.py.

◆ SynchronizeProperties()

pcbnew.BOARD.SynchronizeProperties ( self )

SynchronizeProperties(BOARD self)

Definition at line 22514 of file pcbnew.py.

◆ SynchronizeTuningProfileProperties()

pcbnew.BOARD.SynchronizeTuningProfileProperties ( self )

SynchronizeTuningProfileProperties(BOARD self)

Definition at line 22518 of file pcbnew.py.

◆ TestZoneIntersection()

pcbnew.BOARD.TestZoneIntersection	(	self,
		aZone1,
		aZone2 )

TestZoneIntersection(BOARD self, ZONE aZone1, ZONE aZone2) -> bool

Definition at line 22546 of file pcbnew.py.

◆ Tracks()

pcbnew.BOARD.Tracks	(		self,
		*	args )

    Tracks(BOARD self) -> TRACKS
    Tracks(BOARD self) -> TRACKS

Definition at line 21994 of file pcbnew.py.

◆ TracksInNet()

pcbnew.BOARD.TracksInNet	(		self,
			aNetCode )

TracksInNet(BOARD self, int aNetCode) -> TRACKS

Definition at line 22567 of file pcbnew.py.

◆ UncacheChildrenById()

pcbnew.BOARD.UncacheChildrenById	(		self,
			aParent )

UncacheChildrenById(BOARD self, BOARD_ITEM aParent)

Definition at line 22702 of file pcbnew.py.

◆ UncacheItemById()

pcbnew.BOARD.UncacheItemById	(		self,
			aId )

UncacheItemById(BOARD self, KIID aId)

Definition at line 22686 of file pcbnew.py.

◆ UncacheItemByPtr()

pcbnew.BOARD.UncacheItemByPtr	(		self,
			aItem )

UncacheItemByPtr(BOARD self, BOARD_ITEM aItem)

Definition at line 22706 of file pcbnew.py.

◆ UncacheItemSubtreeById()

pcbnew.BOARD.UncacheItemSubtreeById	(		self,
			aItem )

UncacheItemSubtreeById(BOARD self, BOARD_ITEM aItem)

Definition at line 22698 of file pcbnew.py.

◆ UpdateBoardOutline()

pcbnew.BOARD.UpdateBoardOutline ( self )

UpdateBoardOutline(BOARD self)

Definition at line 21975 of file pcbnew.py.

◆ UpdateRatsnestExclusions()

pcbnew.BOARD.UpdateRatsnestExclusions ( self )

UpdateRatsnestExclusions(BOARD self)

Definition at line 22223 of file pcbnew.py.

◆ UpdateUserUnits()

pcbnew.BOARD.UpdateUserUnits	(	self,
		aItem,
		aView )

UpdateUserUnits(BOARD self, BOARD_ITEM aItem, KIGFX::VIEW * aView)

Definition at line 22382 of file pcbnew.py.

◆ Zones()

pcbnew.BOARD.Zones ( self )

Zones(BOARD self) -> ZONES

Definition at line 21951 of file pcbnew.py.

Member Data Documentation

◆ netclassmap

dict pcbnew.BOARD.netclassmap = {k:v for k,v in self.GetNetClasses().items()}

static

Definition at line 22781 of file pcbnew.py.

◆ this

pcbnew.BOARD.this = this

Definition at line 22730 of file pcbnew.py.

Property Documentation

◆ m_DeflatedZoneOutlineCache

pcbnew.BOARD.m_DeflatedZoneOutlineCache = property(_pcbnew.BOARD_m_DeflatedZoneOutlineCache_get, _pcbnew.BOARD_m_DeflatedZoneOutlineCache_set, doc=)

static

Definition at line 22720 of file pcbnew.py.

◆ m_LegacyCopperEdgeClearanceLoaded

pcbnew.BOARD.m_LegacyCopperEdgeClearanceLoaded = property(_pcbnew.BOARD_m_LegacyCopperEdgeClearanceLoaded_get, _pcbnew.BOARD_m_LegacyCopperEdgeClearanceLoaded_set, doc=)

static

Definition at line 22079 of file pcbnew.py.

◆ m_LegacyDesignSettingsLoaded

pcbnew.BOARD.m_LegacyDesignSettingsLoaded = property(_pcbnew.BOARD_m_LegacyDesignSettingsLoaded_get, _pcbnew.BOARD_m_LegacyDesignSettingsLoaded_set, doc=)

static

Definition at line 22078 of file pcbnew.py.

◆ m_LegacyNetclassesLoaded

pcbnew.BOARD.m_LegacyNetclassesLoaded = property(_pcbnew.BOARD_m_LegacyNetclassesLoaded_get, _pcbnew.BOARD_m_LegacyNetclassesLoaded_set, doc=)

static

Definition at line 22080 of file pcbnew.py.

◆ m_LegacyVisibleItems

pcbnew.BOARD.m_LegacyVisibleItems = property(_pcbnew.BOARD_m_LegacyVisibleItems_get, _pcbnew.BOARD_m_LegacyVisibleItems_set, doc=)

static

Definition at line 22077 of file pcbnew.py.

◆ m_LegacyVisibleLayers

pcbnew.BOARD.m_LegacyVisibleLayers = property(_pcbnew.BOARD_m_LegacyVisibleLayers_get, _pcbnew.BOARD_m_LegacyVisibleLayers_set, doc=)

static

Definition at line 22076 of file pcbnew.py.

◆ m_maxClearanceValue

pcbnew.BOARD.m_maxClearanceValue = property(_pcbnew.BOARD_m_maxClearanceValue_get, _pcbnew.BOARD_m_maxClearanceValue_set, doc=)

static

Definition at line 22718 of file pcbnew.py.

◆ m_SolderMaskBridges

pcbnew.BOARD.m_SolderMaskBridges = property(_pcbnew.BOARD_m_SolderMaskBridges_get, _pcbnew.BOARD_m_SolderMaskBridges_set, doc=)

static

Definition at line 22721 of file pcbnew.py.

◆ m_ZoneBBoxCache

pcbnew.BOARD.m_ZoneBBoxCache = property(_pcbnew.BOARD_m_ZoneBBoxCache_get, _pcbnew.BOARD_m_ZoneBBoxCache_set, doc=)

static

Definition at line 22717 of file pcbnew.py.

◆ m_ZoneIsolatedIslandsMap

pcbnew.BOARD.m_ZoneIsolatedIslandsMap = property(_pcbnew.BOARD_m_ZoneIsolatedIslandsMap_get, _pcbnew.BOARD_m_ZoneIsolatedIslandsMap_set, doc=)

static

Definition at line 22722 of file pcbnew.py.

◆ m_ZonesByNameCache

pcbnew.BOARD.m_ZonesByNameCache = property(_pcbnew.BOARD_m_ZonesByNameCache_get, _pcbnew.BOARD_m_ZonesByNameCache_set, doc=)

static

Definition at line 22719 of file pcbnew.py.

◆ thisown

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

static

Definition at line 21908 of file pcbnew.py.

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

pcbnew.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ AddArea()

◆ AddListener()

◆ AddNative()

◆ AddVariant()

◆ AllConnectedItems()

◆ BoardOutline()

◆ BuildConnectivity()

◆ BuildListOfNets()

◆ BulkRemoveStaleTeardrops()

◆ CacheAndReturnItemById()

◆ CacheChildrenById()

◆ CacheItemById()

◆ CacheItemSubtreeById()

◆ CacheTriangulation()

◆ ClassOf()

◆ ClearItemByIdCache()

◆ ClearProject()

◆ ComputeBoundingBox()

◆ ConvertBrdLayerToPolygonalContours()

◆ ConvertCrossReferencesToKIIDs()

◆ ConvertKIIDsToCrossReferences()

◆ CopyVariant()

◆ DeleteAllFootprints()

◆ DeleteMARKERs()

◆ DeleteVariant()

◆ DetachAllFootprints()

◆ DpCoupledNet()

◆ Drawings()

◆ EmbedFonts()

◆ FillItemMap()

◆ FinalizeBulkAdd()

◆ FinalizeBulkRemove()

◆ FindFootprintByPath()

◆ FindFootprintByReference()

◆ FindNet()

◆ FixupEmbeddedData()

◆ FlipLayer()

◆ Footprints()

◆ Generators()

◆ GetAllNetClasses()

◆ GetArea()

◆ GetAreaCount()

◆ GetBoardEdgesBoundingBox()

◆ GetBoardPolygonOutlines()

◆ GetBoardUse()

◆ GetCachedItemById()

◆ GetClass()

◆ GetComponentClassManager()

◆ GetConnectivity()

◆ GetContextualTextVars()

◆ GetCopperLayerCount()

◆ GetCopperLayerStackMaxId()

◆ GetCurrentNetClassName()

◆ GetCurrentVariant()

◆ GetDesignSettings()

◆ GetDrawings()

◆ GetEmbeddedFiles()

◆ GetEnabledLayers()

◆ GetFileFormatVersionAtLoad()

◆ GetFileName()

◆ GetFirstFootprint()

◆ GetFonts()

◆ GetFootprint()

◆ GetFootprints()

◆ GetGenerator()

◆ GetHighLightNetCodes()

◆ GetHistoryLifetimeToken()

◆ GetItemByIdCache()

◆ GetItemSet()

◆ GetLayerID()

◆ init() [1/2]

◆ init() [2/2]