KiCad PCB EDA Suite
Loading...
Searching...
No Matches
layer_utils.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20#pragma once
21
22#include <wx/string.h>
23
24#include <board.h>
25#include <footprint.h>
26#include <lseq.h>
27#include <lset.h>
28
29
37namespace LAYER_UTILS
38{
39
47wxString AccumulateNames( const LSEQ& aLayers, const BOARD* aBoard );
48
53inline wxString AccumulateNames( const LSET& aLayers, const BOARD* aBoard )
54{
55 return AccumulateNames( aLayers.UIOrder(), aBoard );
56}
57
62LSET GetAllFootprintLayers( const FOOTPRINT& aFootprint );
63
73LSET GetOrphanedFootprintLayers( const FOOTPRINT& aFootprint, const LSET& aCustomUserLayers );
74
75} // namespace LAYER_UTILS
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:372
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
Definition lseq.h:47
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
LSEQ UIOrder() const
Return the copper, technical and user layers in the order shown in layer widget.
Definition lset.cpp:739
Utility functions for dealing with layers in the context of a PCB board.s.
Definition layer_utils.h:38
wxString AccumulateNames(const LSEQ &aLayers, const BOARD *aBoard)
Accumulate layer names from a layer set into a comma separated string.
LSET GetAllFootprintLayers(const FOOTPRINT &aFootprint)
Return the union of layers referenced by every item inside the footprint (including graphic items,...
LSET GetOrphanedFootprintLayers(const FOOTPRINT &aFootprint, const LSET &aCustomUserLayers)
Compute the set of footprint-used layers that would be orphaned if the footprint's allowed layer set ...