KiCad PCB EDA Suite
netinfo.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) 2009 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25/*
26 * Classes to handle info on nets
27 */
28
29#ifndef CLASS_NETINFO_
30#define CLASS_NETINFO_
31
32#include <macros_swig.h>
33#include <gr_basic.h>
34#include <netclass.h>
35#include <board_item.h>
36#include <string_utils.h>
37
38
39
40class wxDC;
41class LINE_READER;
42class EDA_DRAW_FRAME;
43class PAD;
44class PCB_TRACK;
45class BOARD;
46class BOARD_ITEM;
47class MSG_PANEL_ITEM;
48class PCB_BASE_FRAME;
49
50
51/*****************************/
52/* flags for a RATSNEST_ITEM */
53/*****************************/
54#define CH_VISIBLE 1 /* Visible */
55#define CH_UNROUTABLE 2 /* Don't use autorouter. */
56#define CH_ROUTE_REQ 4 /* Must be routed by the autorouter. */
57#define CH_ACTIF 8 /* Not routed. */
58#define LOCAL_RATSNEST_ITEM 0x8000 /* Line between two pads of a single footprint. */
59
60DECL_VEC_FOR_SWIG( PADS_VEC, PAD* )
61DECL_VEC_FOR_SWIG( TRACKS_VEC, PCB_TRACK* )
62
63
67{
68public:
69
70 NETINFO_ITEM( BOARD* aParent, const wxString& aNetName = wxEmptyString, int aNetCode = -1 );
72
73 static inline bool ClassOf( const EDA_ITEM* aItem )
74 {
75 return aItem && PCB_NETINFO_T == aItem->Type();
76 }
77
78 wxString GetClass() const override
79 {
80 return wxT( "NETINFO_ITEM" );
81 }
82
83#if defined(DEBUG)
84 void Show( int nestLevel, std::ostream& os ) const override
85 {
86 }
87#endif
88
89 const BOX2I GetBoundingBox() const override;
90
91 VECTOR2I GetPosition() const override
92 {
93 static VECTOR2I dummy( 0, 0 );
94 return dummy;
95 }
96
97 void SetPosition( const VECTOR2I& aPos ) override
98 {
99 }
100
101 EDA_ITEM* Clone() const override
102 {
103 return new NETINFO_ITEM( *this );
104 }
105
106 void SetNetClass( const std::shared_ptr<NETCLASS>& aNetClass );
107
112 NETCLASS* GetNetClass() { return m_netClass.get(); }
113
114 int GetNetCode() const { return m_netCode; }
115 void SetNetCode( int aNetCode ) { m_netCode = aNetCode; }
116
120 const wxString& GetNetname() const { return m_netname; }
121
125 const wxString& GetShortNetname() const { return m_shortNetname; }
126
130 const wxString& GetUnescapedShortNetname() const { return m_unescapedShortNetname; }
131
136 {
137 return m_shortNetname.StartsWith( wxT( "Net-(" ) )
138 || m_shortNetname.StartsWith( wxT( "unconnected-(" ) );
139 }
140
145 void SetNetname( const wxString& aNewName )
146 {
147 m_netname = aNewName;
148
149 if( aNewName.Contains( wxT( "/" ) ) )
150 m_shortNetname = aNewName.AfterLast( '/' );
151 else
152 m_shortNetname = aNewName;
153
154 m_unescapedShortNetname = UnescapeString( m_shortNetname );
155 }
156
157 bool IsCurrent() const { return m_isCurrent; }
158 void SetIsCurrent( bool isCurrent ) { m_isCurrent = isCurrent; }
159
166 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
167
171 void Clear();
172
174 {
175 return m_parent;
176 }
177
178 bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
179
180private:
181 friend class NETINFO_LIST;
182
184 wxString m_netname;
185 wxString m_shortNetname;
187
188 std::shared_ptr<NETCLASS> m_netClass;
189
193
195};
196
197
199{
200public:
202 {
203 m_board = nullptr;
204 }
205
206
210 void SetBoard( const BOARD* aBoard )
211 {
212 m_board = aBoard;
213 Update();
214 }
215
221 void Update();
222
231 int Translate( int aNetCode ) const;
232
236 {
237 public:
238 iterator( std::map<int, int>::const_iterator aIter, const NETINFO_MAPPING* aMapping ) :
239 m_iterator( aIter ), m_mapping( aMapping )
240 {
241 }
242
245 {
246 ++m_iterator;
247
248 return *this;
249 }
250
253 {
254 iterator ret = *this;
255 ++m_iterator;
256
257 return ret;
258 }
259
260 NETINFO_ITEM* operator*() const;
261
262 NETINFO_ITEM* operator->() const;
263
264 bool operator!=( const iterator& aOther ) const
265 {
266 return m_iterator != aOther.m_iterator;
267 }
268
269 bool operator==( const iterator& aOther ) const
270 {
271 return m_iterator == aOther.m_iterator;
272 }
273
274 private:
275 std::map<int, int>::const_iterator m_iterator;
277 };
278
286 {
287 return iterator( m_netMapping.begin(), this );
288 }
289
296 iterator end() const
297 {
298 return iterator( m_netMapping.end(), this );
299 }
300
304 int GetSize() const
305 {
306 return m_netMapping.size();
307 }
308
309private:
310 const BOARD* m_board;
311 std::map<int, int> m_netMapping;
313};
314
315
316#if 0
317// waiting for swig to support std::unordered_map, see
318// http://www.swig.org/Doc3.0/CPlusPlus11.html
319// section 7.3.3
320#include <hashtables.h>
321DECL_HASH_FOR_SWIG( NETNAMES_MAP, wxString, NETINFO_ITEM* )
322DECL_HASH_FOR_SWIG( NETCODES_MAP, int, NETINFO_ITEM* )
323#else
324// use std::map for now
325DECL_MAP_FOR_SWIG( NETNAMES_MAP, wxString, NETINFO_ITEM* )
326DECL_MAP_FOR_SWIG( NETCODES_MAP, int, NETINFO_ITEM* )
327#endif
328
333{
334 friend class BOARD;
335
336public:
337 NETINFO_LIST( BOARD* aParent );
339
344 NETINFO_ITEM* GetNetItem( int aNetCode ) const;
345
350 NETINFO_ITEM* GetNetItem( const wxString& aNetName ) const;
351
356 unsigned GetNetCount() const { return m_netNames.size(); }
357
362 void AppendNet( NETINFO_ITEM* aNewElement );
363
367 void RemoveNet( NETINFO_ITEM* aNet );
368 void RemoveUnusedNets();
369
375 const NETNAMES_MAP& NetsByName() const { return m_netNames; }
376
378 const NETCODES_MAP& NetsByNetcode() const { return m_netCodes; }
379
382 static const int UNCONNECTED;
383
386 static const int ORPHANED;
387
391 {
392 static NETINFO_ITEM* g_orphanedItem;
393
394 if( !g_orphanedItem )
395 g_orphanedItem = new NETINFO_ITEM( nullptr, wxEmptyString, NETINFO_LIST::UNCONNECTED );
396
397 return g_orphanedItem;
398 }
399
400#if defined(DEBUG)
401 void Show() const;
402#endif
403
404#ifndef SWIG
408 {
409 public:
410 iterator( NETNAMES_MAP::const_iterator aIter ) : m_iterator( aIter )
411 {
412 }
413
416 {
417 ++m_iterator;
418 return *this;
419 }
420
423 {
424 iterator ret = *this;
425 ++m_iterator;
426 return ret;
427 }
428
430 {
431 return m_iterator->second;
432 }
433
435 {
436 return m_iterator->second;
437 }
438
439 bool operator!=( const iterator& aOther ) const
440 {
441 return m_iterator != aOther.m_iterator;
442 }
443
444 bool operator==( const iterator& aOther ) const
445 {
446 return m_iterator == aOther.m_iterator;
447 }
448
449 private:
450 NETNAMES_MAP::const_iterator m_iterator;
451 };
452
454 {
455 return iterator( m_netNames.begin() );
456 }
457
458 iterator end() const
459 {
460 return iterator( m_netNames.end() );
461 }
462#endif
463
465 {
466 return m_parent;
467 }
468
469private:
473 void clear();
474
480 void buildListOfNets();
481
485 int getFreeNetCode();
486
488
489 NETNAMES_MAP m_netNames;
490 NETCODES_MAP m_netCodes;
491
493};
494
495#endif // CLASS_NETINFO_
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:58
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:265
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:81
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
A collection of nets and the parameters used to route or test these nets.
Definition: netclass.h:47
Handle the data for a net.
Definition: netinfo.h:67
bool HasAutoGeneratedNetname()
Definition: netinfo.h:135
wxString m_shortNetname
Short net name, like vout from /sheet/subsheet/vout.
Definition: netinfo.h:185
void SetNetname(const wxString &aNewName)
Set the long netname to aNetName, the short netname to the last token in the long netname's path,...
Definition: netinfo.h:145
wxString GetClass() const override
Return the class name.
Definition: netinfo.h:78
const wxString & GetShortNetname() const
Definition: netinfo.h:125
static bool ClassOf(const EDA_ITEM *aItem)
Definition: netinfo.h:73
BOARD * GetParent() const
Definition: netinfo.h:173
const wxString & GetNetname() const
Definition: netinfo.h:120
void SetNetCode(int aNetCode)
Definition: netinfo.h:115
NETCLASS * GetNetClass()
Definition: netinfo.h:112
int GetNetCode() const
Definition: netinfo.h:114
wxString m_unescapedShortNetname
Unescaped short net name.
Definition: netinfo.h:186
VECTOR2I GetPosition() const override
Definition: netinfo.h:91
int m_netCode
A number equivalent to the net name.
Definition: netinfo.h:183
std::shared_ptr< NETCLASS > m_netClass
Definition: netinfo.h:188
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: netinfo.h:101
wxString m_netname
Full net name like /sheet/subsheet/vout used by Eeschema.
Definition: netinfo.h:184
void SetIsCurrent(bool isCurrent)
Definition: netinfo.h:158
bool m_isCurrent
Indicates the net is currently in use.
Definition: netinfo.h:190
bool IsCurrent() const
Definition: netinfo.h:157
const wxString & GetUnescapedShortNetname() const
Definition: netinfo.h:130
void SetPosition(const VECTOR2I &aPos) override
Definition: netinfo.h:97
BOARD * m_parent
The parent board the net belongs to.
Definition: netinfo.h:194
iterator operator++(int)
post-increment operator
Definition: netinfo.h:422
bool operator==(const iterator &aOther) const
Definition: netinfo.h:444
NETNAMES_MAP::const_iterator m_iterator
Definition: netinfo.h:450
bool operator!=(const iterator &aOther) const
Definition: netinfo.h:439
const iterator & operator++()
pre-increment operator
Definition: netinfo.h:415
iterator(NETNAMES_MAP::const_iterator aIter)
Definition: netinfo.h:410
NETINFO_ITEM * operator->() const
Definition: netinfo.h:434
NETINFO_ITEM * operator*() const
Definition: netinfo.h:429
Container for NETINFO_ITEM elements, which are the nets.
Definition: netinfo.h:333
int getFreeNetCode()
Return the first available net code that is not used by any other net.
static const int UNCONNECTED
Constant that forces initialization of a netinfo item to the NETINFO_ITEM ORPHANED (typically -1) whe...
Definition: netinfo.h:382
NETCODES_MAP m_netCodes
map of <int, NETINFO_ITEM*> is NOT owner
Definition: netinfo.h:490
void RemoveUnusedNets()
static const int ORPHANED
NETINFO_ITEM meaning that there was no net assigned for an item, as there was no board storing net li...
Definition: netinfo.h:386
iterator begin() const
Definition: netinfo.h:453
int m_newNetCode
possible value for new net code assignment
Definition: netinfo.h:492
BOARD * GetParent() const
Definition: netinfo.h:464
static NETINFO_ITEM * OrphanedItem()
Wrapper class, so you can iterate through NETINFO_ITEM*s, not std::pair<int/wxString,...
Definition: netinfo.h:390
unsigned GetNetCount() const
Definition: netinfo.h:356
void RemoveNet(NETINFO_ITEM *aNet)
Remove a net from the net list.
BOARD * m_parent
Definition: netinfo.h:487
NETINFO_ITEM * GetNetItem(int aNetCode) const
NETINFO_LIST(BOARD *aParent)
void clear()
Delete the list of nets (and free memory).
const NETCODES_MAP & NetsByNetcode() const
Return the netcode map, at least for python.
Definition: netinfo.h:378
NETNAMES_MAP m_netNames
map of <wxString, NETINFO_ITEM*>, is NETINFO_ITEM owner
Definition: netinfo.h:489
void AppendNet(NETINFO_ITEM *aNewElement)
Add aNewElement to the end of the net list.
const NETNAMES_MAP & NetsByName() const
Return the name map, at least for python.
Definition: netinfo.h:375
iterator end() const
Definition: netinfo.h:458
void buildListOfNets()
Rebuild the list of NETINFO_ITEMs.
NETINFO_ITEM * operator->() const
const NETINFO_MAPPING * m_mapping
Definition: netinfo.h:276
std::map< int, int >::const_iterator m_iterator
Definition: netinfo.h:275
bool operator!=(const iterator &aOther) const
Definition: netinfo.h:264
iterator(std::map< int, int >::const_iterator aIter, const NETINFO_MAPPING *aMapping)
Definition: netinfo.h:238
iterator operator++(int)
post-increment operator
Definition: netinfo.h:252
NETINFO_ITEM * operator*() const
const iterator & operator++()
pre-increment operator
Definition: netinfo.h:244
bool operator==(const iterator &aOther) const
Definition: netinfo.h:269
void SetBoard(const BOARD *aBoard)
Set a BOARD object that is used to prepare the net code map.
Definition: netinfo.h:210
int Translate(int aNetCode) const
Translate net number according to the map prepared by Update() function.
int GetSize() const
Definition: netinfo.h:304
iterator end() const
Return iterator to the last entry in the mapping.
Definition: netinfo.h:296
void Update()
Prepare a mapping for net codes so they can be saved as consecutive numbers.
const BOARD * m_board
Board for which mapping is prepared.
Definition: netinfo.h:310
iterator begin() const
Return iterator to the first entry in the mapping.
Definition: netinfo.h:285
std::map< int, int > m_netMapping
Map that allows saving net codes with consecutive numbers (for compatibility reasons)
Definition: netinfo.h:311
Definition: pad.h:59
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
#define DECL_HASH_FOR_SWIG(TypeName, KeyType, ValueType)
Declare a std::unordered_map but no swig template.
Definition: hashtables.h:73
This file contains macros just for swig binding.
#define DECL_MAP_FOR_SWIG(TypeName, KeyType, ValueType)
Definition: macros_swig.h:52
#define DECL_VEC_FOR_SWIG(TypeName, MemberType)
Declare a std::vector but no swig template.
Definition: macros_swig.h:50
std::vector< FAB_LAYER_COLOR > dummy
wxString UnescapeString(const wxString &aSource)
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
Definition: typeinfo.h:114