KiCad PCB EDA Suite
array_pad_name_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 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 
25 
26 #include <class_pad.h>
27 
28 
30  const MODULE* aMod, 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 module, no reserved names either
45  if( aMod )
46  {
47  // reserve the name of each existing pad
48  for( auto pad : aMod->Pads() )
49  {
50  m_existing_pad_names.insert( pad->GetName() );
51  }
52  }
53  }
54 }
55 
56 
58 {
60 }
61 
62 
63 wxString ARRAY_PAD_NAME_PROVIDER::getNextName( int& aIndex, const std::set<wxString>& aExisting )
64 {
65  wxString next_name;
66 
67  do
68  {
69  next_name = m_arrayOpts.GetItemNumber( aIndex );
70  aIndex++;
71  } while( aExisting.count( next_name ) != 0 );
72 
73  return next_name;
74 }
PADS & Pads()
Definition: class_module.h:163
std::set< wxString > m_existing_pad_names
wxString GetNextPadName()
Get the next available pad name.
const ARRAY_OPTIONS & m_arrayOpts
Options that govern the setup of an "array" of multiple item.
Definition: array_options.h:36
virtual wxString GetItemNumber(int n) const =0
Get the position number (name) for the n'th array point.
Pad object description.
wxString getNextName(int &aIndex, const std::set< wxString > &aExisting)
Get the next name from a given index/list combo.
ARRAY_PAD_NAME_PROVIDER(const MODULE *aMod, const ARRAY_OPTIONS &aArrayOpts)
bool GetNumberingStartIsSpecified() const