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

Public Member Functions

def __init__ (self, args)
 
def Name (aLayerId)
 
def InternalCuMask ()
 
def AllCuMask (args)
 
def ExternalCuMask ()
 
def AllNonCuMask ()
 
def AllLayersMask ()
 
def FrontTechMask ()
 
def FrontBoardTechMask ()
 
def BackTechMask ()
 
def BackBoardTechMask ()
 
def AllTechMask ()
 
def AllBoardTechMask ()
 
def FrontMask ()
 
def BackMask ()
 
def UserMask ()
 
def CuStack (self)
 
def Technicals (self, args)
 
def Users (self)
 
def UIOrder (self)
 
def Seq (self, args)
 
def SeqStackupBottom2Top (self)
 
def FmtHex (self)
 
def ParseHex (self, aStart, aCount)
 
def FmtBin (self)
 
def ExtractLayer (self)
 
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)
 
- Public Member Functions inherited from pcbnew.BASE_SET
def __init__ (self, args, kwargs)
 

Public Attributes

 this
 

Static Public Attributes

tuple Name = staticmethod(Name)
 
tuple InternalCuMask = staticmethod(InternalCuMask)
 
tuple AllCuMask = staticmethod(AllCuMask)
 
tuple ExternalCuMask = staticmethod(ExternalCuMask)
 
tuple AllNonCuMask = staticmethod(AllNonCuMask)
 
tuple AllLayersMask = staticmethod(AllLayersMask)
 
tuple FrontTechMask = staticmethod(FrontTechMask)
 
tuple FrontBoardTechMask = staticmethod(FrontBoardTechMask)
 
tuple BackTechMask = staticmethod(BackTechMask)
 
tuple BackBoardTechMask = staticmethod(BackBoardTechMask)
 
tuple AllTechMask = staticmethod(AllTechMask)
 
tuple AllBoardTechMask = staticmethod(AllBoardTechMask)
 
tuple FrontMask = staticmethod(FrontMask)
 
tuple BackMask = staticmethod(BackMask)
 
tuple UserMask = staticmethod(UserMask)
 

Detailed Description

Class LSET is a set of LAYER_IDs.

It can be converted to numerous purpose LSEQs using the various member
functions, most of which are based on Seq(). The advantage of
converting to LSEQ using purposeful code, is it removes any dependency
on order/sequence inherent in this set.

C++ includes: layers_id_colors_and_visibility.h 

Definition at line 29822 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.LSET.__init__ (   self,
  args 
)
__init__(LSET self) -> LSET
__init__(LSET self, BASE_SET aOther) -> LSET
__init__(LSET self, LAYER_ID aLayer) -> LSET
__init__(LSET self, LAYER_ID const * aArray, unsigned int aCount) -> LSET
__init__(LSET self, unsigned int aIdCount, int aFirst) -> LSET

LSET::LSET(unsigned aIdCount, int
aFirst,...)

Constructor LSET( unsigned, LAYER_ID, ...) takes one or more LAYER_IDs
in the argument list to construct the set.

Typically only used in static construction.

Parameters:
-----------

aIdCount:  is the number of LAYER_IDs which follow.

aFirst:  is the first included in aIdCount and must always be present,
and can be followed by any number of additional LAYER_IDs so long as
aIdCount accurately reflects the count.

Parameter is 'int' to avoid va_start undefined behavior. 

Definition at line 29845 of file pcbnew.py.

Member Function Documentation

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

Definition at line 30145 of file pcbnew.py.

def pcbnew.LSET.AddLayer (   self,
  layer 
)

Definition at line 30165 of file pcbnew.py.

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

Definition at line 30155 of file pcbnew.py.

def pcbnew.LSET.AddLayerSet (   self,
  layers 
)

Definition at line 30168 of file pcbnew.py.

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

Definition at line 29969 of file pcbnew.py.

def pcbnew.LSET.AllCuMask (   args)
AllCuMask(int aCuLayerCount) -> LSET
AllCuMask() -> LSET

Definition at line 29894 of file pcbnew.py.

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

Definition at line 29921 of file pcbnew.py.

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

Definition at line 29913 of file pcbnew.py.

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

Definition at line 29961 of file pcbnew.py.

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

Definition at line 29953 of file pcbnew.py.

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

Definition at line 29985 of file pcbnew.py.

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

Definition at line 29945 of file pcbnew.py.

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

LSEQ LSET::CuStack() const

Function CuStack returns a sequence of copper layers in starting from
the front/top and extending to the back/bottom.

This specific sequence is depended upon in numerous places. 

Definition at line 30001 of file pcbnew.py.

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

Definition at line 29905 of file pcbnew.py.

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

LAYER_ID
LSET::ExtractLayer() const

Find the first set LAYER_ID.

Returns UNDEFINED_LAYER if more than one is set or UNSELECTED_LAYER if
none is set. 

Definition at line 30130 of file pcbnew.py.

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

std::string LSET::FmtBin() const

Function FmtBin returns a binary string showing contents of this LSEQ.

Definition at line 30118 of file pcbnew.py.

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

std::string LSET::FmtHex() const

Function FmtHex returns a hex string showing contents of this LSEQ. 

Definition at line 30090 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 29937 of file pcbnew.py.

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

Definition at line 29977 of file pcbnew.py.

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

Definition at line 29929 of file pcbnew.py.

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

Definition at line 29886 of file pcbnew.py.

def pcbnew.LSET.Name (   aLayerId)
Name(LAYER_ID aLayerId) -> wxChar const *

Definition at line 29878 of file pcbnew.py.

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

int LSET::ParseHex(const char
*aStart, int aCount)

Function ParseHex understands the output of FmtHex() and replaces this
set's values with those given in the input string.

Parsing stops at the first non hex ASCII byte, except that marker
bytes output from FmtHex are not terminators. int - number of bytes
consumed 

Definition at line 30101 of file pcbnew.py.

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

Definition at line 30150 of file pcbnew.py.

def pcbnew.LSET.RemoveLayer (   self,
  layer 
)

Definition at line 30171 of file pcbnew.py.

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

Definition at line 30160 of file pcbnew.py.

def pcbnew.LSET.RemoveLayerSet (   self,
  layers 
)

Definition at line 30174 of file pcbnew.py.

def pcbnew.LSET.Seq (   self,
  args 
)
Seq(LSET self, LAYER_ID const * aWishListSequence, unsigned int aCount) -> LSEQ
Seq(LSET self) -> LSEQ

LSEQ LSET::Seq() const

Function Seq returns a LSEQ from this LSET in ascending LAYER_ID
order.

Each LSEQ element will be in the same sequence as in LAYER_ID and only
present in the resultant LSEQ if present in this set. Therefore the
sequence is subject to change, use it only when enumeration and not
order is important. 

Definition at line 30056 of file pcbnew.py.

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

LSEQ
LSET::SeqStackupBottom2Top() const

Function SeqStackBottom2Top returns the sequence that is typical for a
bottom-to-top stack-up.

For instance, to plot multiple layers in a single image, the top
layers output last. 

Definition at line 30074 of file pcbnew.py.

def pcbnew.LSET.Technicals (   self,
  args 
)
Technicals(LSET self, LSET aSubToOmit) -> LSEQ
Technicals(LSET self) -> LSEQ

LSEQ LSET::Technicals(LSET
aSubToOmit=LSET()) const

Function Technicals returns a sequence of technical layers.

A sequence provides a certain order.

Parameters:
-----------

aSubToOmit:  is the subset of the techical layers to omit, defaults to
none. 

Definition at line 30015 of file pcbnew.py.

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

LSEQ LSET::UIOrder() const 

Definition at line 30047 of file pcbnew.py.

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

Definition at line 29993 of file pcbnew.py.

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

LSEQ LSET::Users() const

*_User layers. 

Definition at line 30036 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.LSET.AllBoardTechMask = staticmethod(AllBoardTechMask)
static

Definition at line 29974 of file pcbnew.py.

tuple pcbnew.LSET.AllCuMask = staticmethod(AllCuMask)
static

Definition at line 29902 of file pcbnew.py.

tuple pcbnew.LSET.AllLayersMask = staticmethod(AllLayersMask)
static

Definition at line 29926 of file pcbnew.py.

tuple pcbnew.LSET.AllNonCuMask = staticmethod(AllNonCuMask)
static

Definition at line 29918 of file pcbnew.py.

tuple pcbnew.LSET.AllTechMask = staticmethod(AllTechMask)
static

Definition at line 29966 of file pcbnew.py.

tuple pcbnew.LSET.BackBoardTechMask = staticmethod(BackBoardTechMask)
static

Definition at line 29958 of file pcbnew.py.

tuple pcbnew.LSET.BackMask = staticmethod(BackMask)
static

Definition at line 29990 of file pcbnew.py.

tuple pcbnew.LSET.BackTechMask = staticmethod(BackTechMask)
static

Definition at line 29950 of file pcbnew.py.

tuple pcbnew.LSET.ExternalCuMask = staticmethod(ExternalCuMask)
static

Definition at line 29910 of file pcbnew.py.

tuple pcbnew.LSET.FrontBoardTechMask = staticmethod(FrontBoardTechMask)
static

Definition at line 29942 of file pcbnew.py.

tuple pcbnew.LSET.FrontMask = staticmethod(FrontMask)
static

Definition at line 29982 of file pcbnew.py.

tuple pcbnew.LSET.FrontTechMask = staticmethod(FrontTechMask)
static

Definition at line 29934 of file pcbnew.py.

tuple pcbnew.LSET.InternalCuMask = staticmethod(InternalCuMask)
static

Definition at line 29891 of file pcbnew.py.

tuple pcbnew.LSET.Name = staticmethod(Name)
static

Definition at line 29883 of file pcbnew.py.

pcbnew.LSET.this

Definition at line 29876 of file pcbnew.py.

tuple pcbnew.LSET.UserMask = staticmethod(UserMask)
static

Definition at line 29998 of file pcbnew.py.


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