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 FmtHex (self)
 
def ParseHex (self, *args)
 
def FmtBin (self)
 
def ExtractLayer (self)
 
def Flip (self, aCopperLayersCount=0)
 
def addLayer (self, aLayer)
 
def removeLayer (self, aLayer)
 
def addLayerSet (self, aLayerSet)
 
def removeLayerSet (self, aLayerSet)
 
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 UserDefinedLayers ()
 
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 9466 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, LSEQ aSeq) -> LSET
    __init__(LSET self, LAYER_RANGE const & aRange) -> LSET

Reimplemented from pcbnew.BASE_SET.

Definition at line 9472 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 9660 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddLayer()

def pcbnew.LSET.AddLayer (   self,
  layer 
)

Definition at line 9676 of file pcbnew.py.

◆ addLayerSet()

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

Definition at line 9668 of file pcbnew.py.

Here is the caller graph for this function:

◆ AddLayerSet()

def pcbnew.LSET.AddLayerSet (   self,
  layers 
)

Definition at line 9679 of file pcbnew.py.

◆ AllBoardTechMask()

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

Definition at line 9562 of file pcbnew.py.

◆ AllCuMask()

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

Definition at line 9517 of file pcbnew.py.

◆ AllLayersMask()

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

Definition at line 9532 of file pcbnew.py.

◆ AllNonCuMask()

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

Definition at line 9527 of file pcbnew.py.

◆ AllTechMask()

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

Definition at line 9557 of file pcbnew.py.

◆ BackAssembly()

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

Definition at line 9512 of file pcbnew.py.

◆ BackBoardTechMask()

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

Definition at line 9552 of file pcbnew.py.

◆ BackMask()

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

Definition at line 9572 of file pcbnew.py.

◆ BackTechMask()

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

Definition at line 9547 of file pcbnew.py.

◆ Contains()

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

Definition at line 9482 of file pcbnew.py.

◆ CuStack()

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

Definition at line 9601 of file pcbnew.py.

◆ ExternalCuMask()

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

Definition at line 9522 of file pcbnew.py.

◆ ExtractLayer()

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

Definition at line 9647 of file pcbnew.py.

◆ Flip()

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

Definition at line 9651 of file pcbnew.py.

◆ FmtBin()

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

Definition at line 9643 of file pcbnew.py.

◆ FmtHex()

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

Definition at line 9632 of file pcbnew.py.

◆ ForbiddenFootprintLayers()

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

Definition at line 9597 of file pcbnew.py.

◆ FrontAssembly()

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

Definition at line 9507 of file pcbnew.py.

◆ FrontBoardTechMask()

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

Definition at line 9542 of file pcbnew.py.

◆ FrontMask()

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

Definition at line 9567 of file pcbnew.py.

◆ FrontTechMask()

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

Definition at line 9537 of file pcbnew.py.

◆ InternalCuMask()

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

Definition at line 9502 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 9497 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 9656 of file pcbnew.py.

◆ Name()

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

Definition at line 9487 of file pcbnew.py.

◆ NameToLayer()

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

Definition at line 9492 of file pcbnew.py.

◆ ParseHex()

def pcbnew.LSET.ParseHex (   self,
*  args 
) 
    ParseHex(LSET self, char const * aStart, int aCount) -> int
    ParseHex(LSET self, string str) -> int

Definition at line 9636 of file pcbnew.py.

Here is the caller graph for this function:

◆ PhysicalLayersMask()

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

Definition at line 9587 of file pcbnew.py.

◆ removeLayer()

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

Definition at line 9664 of file pcbnew.py.

Here is the caller graph for this function:

◆ RemoveLayer()

def pcbnew.LSET.RemoveLayer (   self,
  layer 
)

Definition at line 9682 of file pcbnew.py.

◆ removeLayerSet()

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

Definition at line 9672 of file pcbnew.py.

Here is the caller graph for this function:

◆ RemoveLayerSet()

def pcbnew.LSET.RemoveLayerSet (   self,
  layers 
)

Definition at line 9685 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 9628 of file pcbnew.py.

◆ Seq()

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

Definition at line 9613 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 9624 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 9620 of file pcbnew.py.

◆ SideSpecificMask()

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

Definition at line 9577 of file pcbnew.py.

◆ TechAndUserUIOrder()

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

Definition at line 9605 of file pcbnew.py.

◆ UIOrder()

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

Definition at line 9609 of file pcbnew.py.

◆ UserDefinedLayers()

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

Definition at line 9592 of file pcbnew.py.

◆ UserMask()

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

Definition at line 9582 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 9469 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Thu Nov 21 2024 00:11:02 for KiCad Pcbnew Python Scripting by doxygen 1.9.6