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

def __init__ (self, *args)
 
def Contains (self, aLayer)
 
def CuStack (self)
 
def TechAndUserUIOrder (self)
 
def UIOrder (self)
 
def Seq (self, *args)
 
def SeqStackupTop2Bottom (self, aSelectedLayer=UNDEFINED_LAYER)
 
def SeqStackupForPlotting (self)
 
def RunOnLayers (self, aFunction)
 
def ExtractLayer (self)
 
def Flip (self, aCopperLayersCount=0)
 
def ClearCopperLayers (self)
 
def ClearNonCopperLayers (self)
 
def ClearUserDefinedLayers (self)
 
def addLayer (self, aLayer)
 
def removeLayer (self, aLayer)
 
def addLayerSet (self, aLayerSet)
 
def removeLayerSet (self, aLayerSet)
 
def FmtHex (self)
 
def FmtBin (self)
 
def ParseHex (self, aString)
 
def AddLayer (self, layer)
 
def AddLayerSet (self, layers)
 
def RemoveLayer (self, layer)
 
def RemoveLayerSet (self, layers)
 
def __init__ (self, *args, **kwargs)
 

Static Public Member Functions

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

Properties

property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BASE_SET
property 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 9629 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def 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

Reimplemented from pcbnew.BASE_SET.

Definition at line 9635 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ addLayer()

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

Definition at line 9821 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddLayer()

def pcbnew.LSET.AddLayer (   self,
  layer 
)

Definition at line 9849 of file pcbnew.py.

◆ addLayerSet()

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

Definition at line 9829 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddLayerSet()

def pcbnew.LSET.AddLayerSet (   self,
  layers 
)

Definition at line 9852 of file pcbnew.py.

◆ AllBoardTechMask()

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

Definition at line 9726 of file pcbnew.py.

◆ AllCuMask()

def pcbnew.LSET.AllCuMask (   aCuLayerCount = 32)
static 
AllCuMask(int aCuLayerCount=32) -> LSET

Definition at line 9681 of file pcbnew.py.

◆ AllLayersMask()

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

Definition at line 9696 of file pcbnew.py.

◆ AllNonCuMask()

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

Definition at line 9691 of file pcbnew.py.

◆ AllTechMask()

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

Definition at line 9721 of file pcbnew.py.

◆ BackAssembly()

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

Definition at line 9676 of file pcbnew.py.

◆ BackBoardTechMask()

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

Definition at line 9716 of file pcbnew.py.

◆ BackMask()

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

Definition at line 9736 of file pcbnew.py.

◆ BackTechMask()

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

Definition at line 9711 of file pcbnew.py.

◆ ClearCopperLayers()

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

Definition at line 9809 of file pcbnew.py.

◆ ClearNonCopperLayers()

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

Definition at line 9813 of file pcbnew.py.

◆ ClearUserDefinedLayers()

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

Definition at line 9817 of file pcbnew.py.

◆ Contains()

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

Definition at line 9646 of file pcbnew.py.

◆ CuStack()

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

Definition at line 9765 of file pcbnew.py.

◆ ExternalCuMask()

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

Definition at line 9686 of file pcbnew.py.

◆ ExtractLayer()

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

Definition at line 9796 of file pcbnew.py.

◆ Flip()

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

Definition at line 9800 of file pcbnew.py.

◆ FmtBin()

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

Definition at line 9841 of file pcbnew.py.

◆ FmtHex()

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

Definition at line 9837 of file pcbnew.py.

◆ ForbiddenFootprintLayers()

def pcbnew.LSET.ForbiddenFootprintLayers ( )
static 
ForbiddenFootprintLayers() -> LSET

Definition at line 9761 of file pcbnew.py.

◆ FrontAssembly()

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

Definition at line 9671 of file pcbnew.py.

◆ FrontBoardTechMask()

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

Definition at line 9706 of file pcbnew.py.

◆ FrontMask()

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

Definition at line 9731 of file pcbnew.py.

◆ FrontTechMask()

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

Definition at line 9701 of file pcbnew.py.

◆ InternalCuMask()

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

Definition at line 9666 of file pcbnew.py.

◆ IsBetween()

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

Definition at line 9661 of file pcbnew.py.

◆ LayerCount()

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

Definition at line 9805 of file pcbnew.py.

◆ Name()

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

Definition at line 9651 of file pcbnew.py.

◆ NameToLayer()

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

Definition at line 9656 of file pcbnew.py.

◆ ParseHex()

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

Definition at line 9845 of file pcbnew.py.

◆ PhysicalLayersMask()

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

Definition at line 9751 of file pcbnew.py.

◆ removeLayer()

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

Definition at line 9825 of file pcbnew.py.

Here is the caller graph for this function:

◆ RemoveLayer()

def pcbnew.LSET.RemoveLayer (   self,
  layer 
)

Definition at line 9855 of file pcbnew.py.

◆ removeLayerSet()

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

Definition at line 9833 of file pcbnew.py.

Here is the caller graph for this function:

◆ RemoveLayerSet()

def pcbnew.LSET.RemoveLayerSet (   self,
  layers 
)

Definition at line 9858 of file pcbnew.py.

◆ RunOnLayers()

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

Definition at line 9792 of file pcbnew.py.

◆ Seq()

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

Definition at line 9777 of file pcbnew.py.

Here is the caller graph for this function:

◆ SeqStackupForPlotting()

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

Definition at line 9788 of file pcbnew.py.

◆ SeqStackupTop2Bottom()

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

Definition at line 9784 of file pcbnew.py.

◆ SideSpecificMask()

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

Definition at line 9741 of file pcbnew.py.

◆ TechAndUserUIOrder()

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

Definition at line 9769 of file pcbnew.py.

◆ UIOrder()

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

Definition at line 9773 of file pcbnew.py.

◆ UserDefinedLayersMask()

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

Definition at line 9756 of file pcbnew.py.

◆ UserMask()

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

Definition at line 9746 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 9632 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Sat Feb 22 2025 00:08:19 for KiCad Pcbnew Python Scripting by doxygen 1.9.6