KiCad PCB EDA Suite
array_pad_number_provider.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 (C) 2019 KiCad Developers, see AUTHORS.TXT for contributors.
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#ifndef PCBNEW_ARRAY_PAD_NAME_PROVIDER__H
25#define PCBNEW_ARRAY_PAD_NAME_PROVIDER__H
26
27
28#include <array_options.h>
29#include <footprint.h>
30
36{
37public:
42 ARRAY_PAD_NUMBER_PROVIDER( const FOOTPRINT* aFootprint, const ARRAY_OPTIONS& aArrayOpts );
43
47 wxString GetNextPadNumber();
48
49private:
56 wxString getNextNumber( int& aIndex, const std::set<wxString>& aExisting );
57
59 std::set<wxString> m_existing_pad_numbers;
61};
62
63#endif // PCBNEW_ARRAY_PAD_NAME_PROVIDER__H
Options that govern the setup of an "array" of multiple item.
Definition: array_options.h:37
Simple class that sequentially provides numbers from an ARRAY_OPTIONS object, making sure that they d...
ARRAY_PAD_NUMBER_PROVIDER(const FOOTPRINT *aFootprint, const ARRAY_OPTIONS &aArrayOpts)
wxString getNextNumber(int &aIndex, const std::set< wxString > &aExisting)
Get the next number from a given index/list combo.
wxString GetNextPadNumber()
Get the next available pad name.
std::set< wxString > m_existing_pad_numbers