KiCad PCB EDA Suite
array_pad_name_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 CHANGELOG.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 <class_module.h>
30 
37 {
38 public:
43  ARRAY_PAD_NAME_PROVIDER( const MODULE* aMod, const ARRAY_OPTIONS& aArrayOpts );
44 
48  wxString GetNextPadName();
49 
50 private:
57  wxString getNextName( int& aIndex, const std::set<wxString>& aExisting );
58 
60  std::set<wxString> m_existing_pad_names;
62 };
63 
64 #endif // PCBNEW_ARRAY_PAD_NAME_PROVIDER__H
std::set< wxString > m_existing_pad_names
wxString GetNextPadName()
Get the next available pad name.
Simple class that sequentially provides names from an ARRAY_OPTIONS object, making sure that they do ...
const ARRAY_OPTIONS & m_arrayOpts
Options that govern the setup of an "array" of multiple item.
Definition: array_options.h:34
wxString getNextName(int &aIndex, const std::set< wxString > &aExisting)
Get the next name from a given index/list combo.
Module description (excepted pads)
ARRAY_PAD_NAME_PROVIDER(const MODULE *aMod, const ARRAY_OPTIONS &aArrayOpts)