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

Public Member Functions

 __init__ (self, *args)
 
 Contains (self, aLayer)
 
 ContainsAll (self, aLayers)
 
 CuStack (self)
 
 TechAndUserUIOrder (self)
 
 UIOrder (self)
 
 Seq (self, *args)
 
 SeqStackupTop2Bottom (self, aSelectedLayer=UNDEFINED_LAYER)
 
 SeqStackupForPlotting (self)
 
 RunOnLayers (self, aFunction)
 
 ExtractLayer (self)
 
 FlipStandardLayers (self, aCopperLayersCount=0)
 
 ClearCopperLayers (self)
 
 ClearNonCopperLayers (self)
 
 ClearUserDefinedLayers (self)
 
 addLayer (self, aLayer)
 
 removeLayer (self, aLayer)
 
 addLayerSet (self, aLayerSet)
 
 removeLayerSet (self, aLayerSet)
 
 FmtHex (self)
 
 FmtBin (self)
 
 ParseHex (self, aString)
 
 AddLayer (self, layer)
 
 AddLayerSet (self, layers)
 
 RemoveLayer (self, layer)
 
 RemoveLayerSet (self, layers)
 
- Public Member Functions inherited from pcbnew.BASE_SET
 __init__ (self, *args, **kwargs)
 

Static Public Member Functions

 Name (aLayerId)
 
 NameToLayer (aName)
 
 IsBetween (aStart, aEnd, aLayer)
 
 InternalCuMask ()
 
 FrontAssembly ()
 
 BackAssembly ()
 
 AllCuMask (*args)
 
 ExternalCuMask ()
 
 AllNonCuMask ()
 
 AllLayersMask ()
 
 FrontTechMask ()
 
 FrontBoardTechMask ()
 
 BackTechMask ()
 
 BackBoardTechMask ()
 
 AllTechMask ()
 
 AllBoardTechMask ()
 
 FrontMask ()
 
 BackMask ()
 
 SideSpecificMask ()
 
 UserMask ()
 
 PhysicalLayersMask ()
 
 UserDefinedLayersMask (aUserDefinedLayerCount=45)
 
 LayerCount (aStart, aEnd, aCopperLayerCount)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BASE_SET
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

Proxy of C++ LSET class.

Definition at line 10183 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.LSET.__init__ ( self,
* args ) 
    __init__(LSET self) -> LSET
    __init__(LSET self, BASE_SET aOther) -> LSET
    __init__(LSET self, std::initializer_list< PCB_LAYER_ID > aList) -> LSET
    __init__(LSET self, base_seqVect aList) -> LSET
    __init__(LSET self, LSEQ aSeq) -> LSET
    __init__(LSET self, LAYER_RANGE const & aRange) -> LSET

Definition at line 10189 of file pcbnew.py.

Member Function Documentation

◆ AddLayer()

pcbnew.LSET.AddLayer ( self,
layer )

Definition at line 10405 of file pcbnew.py.

◆ addLayer()

pcbnew.LSET.addLayer ( self,
aLayer ) 
addLayer(LSET self, PCB_LAYER_ID aLayer) -> LSET

Definition at line 10377 of file pcbnew.py.

◆ AddLayerSet()

pcbnew.LSET.AddLayerSet ( self,
layers )

Definition at line 10408 of file pcbnew.py.

◆ addLayerSet()

pcbnew.LSET.addLayerSet ( self,
aLayerSet ) 
addLayerSet(LSET self, LSET aLayerSet) -> LSET

Definition at line 10385 of file pcbnew.py.

◆ AllBoardTechMask()

pcbnew.LSET.AllBoardTechMask ( )
static 
AllBoardTechMask() -> LSET

Definition at line 10287 of file pcbnew.py.

◆ AllCuMask()

pcbnew.LSET.AllCuMask ( * args)
static 
    AllCuMask(int aCuLayerCount) -> LSET
    AllCuMask() -> LSET

Definition at line 10239 of file pcbnew.py.

◆ AllLayersMask()

pcbnew.LSET.AllLayersMask ( )
static 
AllLayersMask() -> LSET

Definition at line 10257 of file pcbnew.py.

◆ AllNonCuMask()

pcbnew.LSET.AllNonCuMask ( )
static 
AllNonCuMask() -> LSET

Definition at line 10252 of file pcbnew.py.

◆ AllTechMask()

pcbnew.LSET.AllTechMask ( )
static 
AllTechMask() -> LSET

Definition at line 10282 of file pcbnew.py.

◆ BackAssembly()

pcbnew.LSET.BackAssembly ( )
static 
BackAssembly() -> LSET

Definition at line 10234 of file pcbnew.py.

◆ BackBoardTechMask()

pcbnew.LSET.BackBoardTechMask ( )
static 
BackBoardTechMask() -> LSET

Definition at line 10277 of file pcbnew.py.

◆ BackMask()

pcbnew.LSET.BackMask ( )
static 
BackMask() -> LSET

Definition at line 10297 of file pcbnew.py.

◆ BackTechMask()

pcbnew.LSET.BackTechMask ( )
static 
BackTechMask() -> LSET

Definition at line 10272 of file pcbnew.py.

◆ ClearCopperLayers()

pcbnew.LSET.ClearCopperLayers ( self) 
ClearCopperLayers(LSET self) -> LSET

Definition at line 10365 of file pcbnew.py.

◆ ClearNonCopperLayers()

pcbnew.LSET.ClearNonCopperLayers ( self) 
ClearNonCopperLayers(LSET self) -> LSET

Definition at line 10369 of file pcbnew.py.

◆ ClearUserDefinedLayers()

pcbnew.LSET.ClearUserDefinedLayers ( self) 
ClearUserDefinedLayers(LSET self) -> LSET

Definition at line 10373 of file pcbnew.py.

◆ Contains()

pcbnew.LSET.Contains ( self,
aLayer ) 
Contains(LSET self, PCB_LAYER_ID aLayer) -> bool

Definition at line 10200 of file pcbnew.py.

◆ ContainsAll()

pcbnew.LSET.ContainsAll ( self,
aLayers ) 
ContainsAll(LSET self, LSET aLayers) -> bool

Definition at line 10204 of file pcbnew.py.

◆ CuStack()

pcbnew.LSET.CuStack ( self) 
CuStack(LSET self) -> LSEQ

Definition at line 10321 of file pcbnew.py.

◆ ExternalCuMask()

pcbnew.LSET.ExternalCuMask ( )
static 
ExternalCuMask() -> LSET

Definition at line 10247 of file pcbnew.py.

◆ ExtractLayer()

pcbnew.LSET.ExtractLayer ( self) 
ExtractLayer(LSET self) -> PCB_LAYER_ID

Definition at line 10352 of file pcbnew.py.

◆ FlipStandardLayers()

pcbnew.LSET.FlipStandardLayers ( self,
aCopperLayersCount = 0 ) 
FlipStandardLayers(LSET self, int aCopperLayersCount=0) -> LSET

Definition at line 10356 of file pcbnew.py.

◆ FmtBin()

pcbnew.LSET.FmtBin ( self) 
FmtBin(LSET self) -> string

Definition at line 10397 of file pcbnew.py.

◆ FmtHex()

pcbnew.LSET.FmtHex ( self) 
FmtHex(LSET self) -> string

Definition at line 10393 of file pcbnew.py.

◆ FrontAssembly()

pcbnew.LSET.FrontAssembly ( )
static 
FrontAssembly() -> LSET

Definition at line 10229 of file pcbnew.py.

◆ FrontBoardTechMask()

pcbnew.LSET.FrontBoardTechMask ( )
static 
FrontBoardTechMask() -> LSET

Definition at line 10267 of file pcbnew.py.

◆ FrontMask()

pcbnew.LSET.FrontMask ( )
static 
FrontMask() -> LSET

Definition at line 10292 of file pcbnew.py.

◆ FrontTechMask()

pcbnew.LSET.FrontTechMask ( )
static 
FrontTechMask() -> LSET

Definition at line 10262 of file pcbnew.py.

◆ InternalCuMask()

pcbnew.LSET.InternalCuMask ( )
static 
InternalCuMask() -> LSET

Definition at line 10224 of file pcbnew.py.

◆ IsBetween()

pcbnew.LSET.IsBetween ( aStart,
aEnd,
aLayer )
static 
IsBetween(PCB_LAYER_ID aStart, PCB_LAYER_ID aEnd, PCB_LAYER_ID aLayer) -> bool

Definition at line 10219 of file pcbnew.py.

◆ LayerCount()

pcbnew.LSET.LayerCount ( aStart,
aEnd,
aCopperLayerCount )
static 
LayerCount(PCB_LAYER_ID aStart, PCB_LAYER_ID aEnd, int aCopperLayerCount) -> int

Definition at line 10361 of file pcbnew.py.

◆ Name()

pcbnew.LSET.Name ( aLayerId)
static 
Name(PCB_LAYER_ID aLayerId) -> wxString

Definition at line 10209 of file pcbnew.py.

◆ NameToLayer()

pcbnew.LSET.NameToLayer ( aName)
static 
NameToLayer(wxString aName) -> int

Definition at line 10214 of file pcbnew.py.

◆ ParseHex()

pcbnew.LSET.ParseHex ( self,
aString ) 
ParseHex(LSET self, string aString) -> int

Definition at line 10401 of file pcbnew.py.

◆ PhysicalLayersMask()

pcbnew.LSET.PhysicalLayersMask ( )
static 
PhysicalLayersMask() -> LSET

Definition at line 10312 of file pcbnew.py.

◆ RemoveLayer()

pcbnew.LSET.RemoveLayer ( self,
layer )

Definition at line 10411 of file pcbnew.py.

◆ removeLayer()

pcbnew.LSET.removeLayer ( self,
aLayer ) 
removeLayer(LSET self, PCB_LAYER_ID aLayer) -> LSET

Definition at line 10381 of file pcbnew.py.

◆ RemoveLayerSet()

pcbnew.LSET.RemoveLayerSet ( self,
layers )

Definition at line 10414 of file pcbnew.py.

◆ removeLayerSet()

pcbnew.LSET.removeLayerSet ( self,
aLayerSet ) 
removeLayerSet(LSET self, LSET aLayerSet) -> LSET

Definition at line 10389 of file pcbnew.py.

◆ RunOnLayers()

pcbnew.LSET.RunOnLayers ( self,
aFunction ) 
RunOnLayers(LSET self, std::function< void (PCB_LAYER_ID) > const & aFunction)

Definition at line 10348 of file pcbnew.py.

◆ Seq()

pcbnew.LSET.Seq ( self,
* args ) 
    Seq(LSET self, LSEQ aSequence) -> LSEQ
    Seq(LSET self) -> LSEQ

Definition at line 10333 of file pcbnew.py.

◆ SeqStackupForPlotting()

pcbnew.LSET.SeqStackupForPlotting ( self) 
SeqStackupForPlotting(LSET self) -> LSEQ

Definition at line 10344 of file pcbnew.py.

◆ SeqStackupTop2Bottom()

pcbnew.LSET.SeqStackupTop2Bottom ( self,
aSelectedLayer = UNDEFINED_LAYER ) 
SeqStackupTop2Bottom(LSET self, PCB_LAYER_ID aSelectedLayer=UNDEFINED_LAYER) -> LSEQ

Definition at line 10340 of file pcbnew.py.

◆ SideSpecificMask()

pcbnew.LSET.SideSpecificMask ( )
static 
SideSpecificMask() -> LSET

Definition at line 10302 of file pcbnew.py.

◆ TechAndUserUIOrder()

pcbnew.LSET.TechAndUserUIOrder ( self) 
TechAndUserUIOrder(LSET self) -> LSEQ

Definition at line 10325 of file pcbnew.py.

◆ UIOrder()

pcbnew.LSET.UIOrder ( self) 
UIOrder(LSET self) -> LSEQ

Definition at line 10329 of file pcbnew.py.

◆ UserDefinedLayersMask()

pcbnew.LSET.UserDefinedLayersMask ( aUserDefinedLayerCount = 45)
static 
UserDefinedLayersMask(int aUserDefinedLayerCount=45) -> LSET

Definition at line 10317 of file pcbnew.py.

◆ UserMask()

pcbnew.LSET.UserMask ( )
static 
UserMask() -> LSET

Definition at line 10307 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 10186 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Wed Oct 21 2026 20:46:10 for KiCad Pcbnew Python Scripting by doxygen 1.13.2