KiCad PCB EDA Suite
Loading...
Searching...
No Matches
LAYER_UTILS Namespace Reference

Utility functions for dealing with layers in the context of a PCB board.s. More...

Functions

wxString AccumulateNames (const LSEQ &aLayers, const BOARD *aBoard)
 Accumulate layer names from a layer set into a comma separated string.
 
wxString AccumulateNames (const LSET &aLayers, const BOARD *aBoard)
 Accumulate layer names from a layer set into a comma separated string, in UI order.
 

Detailed Description

Utility functions for dealing with layers in the context of a PCB board.s.

This includes functions that need access to the board to get layer names, and other more complex, but reusable operations that either shouldn't be in LSET/LSEQ's interface or need access to Pcbnew types.

Function Documentation

◆ AccumulateNames() [1/2]

wxString LAYER_UTILS::AccumulateNames ( const LSEQ & aLayers,
const BOARD * aBoard )

Accumulate layer names from a layer set into a comma separated string.

Parameters
aLayersis the list of layers to accumulate.
aBoardis the board to get layer names from, if null the default names are used.

Definition at line 27 of file layer_utils.cpp.

References BOARD::GetLayerName(), LayerName(), and result.

Referenced by AccumulateNames(), footprintVsBoardStackup(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ AccumulateNames() [2/2]

wxString LAYER_UTILS::AccumulateNames ( const LSET & aLayers,
const BOARD * aBoard )
inline

Accumulate layer names from a layer set into a comma separated string, in UI order.

Definition at line 56 of file layer_utils.h.

References AccumulateNames(), and LSET::UIOrder().