KiCad PCB EDA Suite
array_pad_number_provider.cpp
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
25
26#include <pad.h>
27
28
30 const ARRAY_OPTIONS& aArrayOpts )
31 : m_arrayOpts( aArrayOpts )
32{
33 // start by numbering the first new item
35
36 // construct the set of existing pad numbers
37 if( aArrayOpts.GetNumberingStartIsSpecified() )
38 {
39 // if we start from a specified point, we don't look at existing
40 // names, so it's just an empty "reserved" set
41 }
42 else
43 {
44 // no footprint, no reserved names either
45 if( aFootprint )
46 {
47 // reserve the name of each existing pad
48 for( PAD* pad : aFootprint->Pads() )
49 m_existing_pad_numbers.insert( pad->GetNumber() );
50 }
51 }
52}
53
54
56{
58}
59
60
62 const std::set<wxString>& aExisting )
63{
64 wxString next_number;
65
66 do
67 {
68 next_number = m_arrayOpts.GetItemNumber( aIndex );
69 aIndex++;
70 } while( aExisting.count( next_number ) != 0 );
71
72 return next_number;
73}
Options that govern the setup of an "array" of multiple item.
Definition: array_options.h:37
virtual wxString GetItemNumber(int n) const =0
Get the position number (name) for the n'th array point.
bool GetNumberingStartIsSpecified() const
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
PADS & Pads()
Definition: footprint.h:175
Definition: pad.h:59