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, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#pragma once
25
26#include <wx/string.h>
27
28#include <board.h>
29#include <lseq.h>
30#include <lset.h>
31
32
40namespace LAYER_UTILS
41{
42
50wxString AccumulateNames( const LSEQ& aLayers, const BOARD* aBoard );
51
56inline wxString AccumulateNames( const LSET& aLayers, const BOARD* aBoard )
57{
58 return AccumulateNames( aLayers.UIOrder(), aBoard );
59}
60
61} // namespace LAYER_UTILS
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:317
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:726
Utility functions for dealing with layers in the context of a PCB board.s.
Definition layer_utils.h:41
wxString AccumulateNames(const LSEQ &aLayers, const BOARD *aBoard)
Accumulate layer names from a layer set into a comma separated string.