KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2023 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
39class EDA_DRAW_FRAME;
40class PAD;
41class PCB_TRACK;
42class BOARD;
43class BOARD_ITEM;
44class BOARD_COMMIT;
45class MSG_PANEL_ITEM;
46class PCB_BASE_FRAME;
47
48
49DECL_VEC_FOR_SWIG( PADS_VEC, PAD* )
50DECL_VEC_FOR_SWIG( TRACKS_VEC, PCB_TRACK* )
51
52
56{
57public:
58
59 NETINFO_ITEM( BOARD* aParent, const wxString& aNetName = wxEmptyString, int aNetCode = -1 );
61
62 static inline bool ClassOf( const EDA_ITEM* aItem )
63 {
64 return aItem && PCB_NETINFO_T == aItem->Type();
65 }
66
67 wxString GetClass() const override
68 {
69 return wxT( "NETINFO_ITEM" );
70 }
71
72#if defined(DEBUG)
73 void Show( int nestLevel, std::ostream& os ) const override
74 {
75 }
76#endif
77
78 const BOX2I GetBoundingBox() const override;
79
80 VECTOR2I GetPosition() const override
81 {
82 static VECTOR2I dummy( 0, 0 );
83 return dummy;
84 }
85
86 void SetPosition( const VECTOR2I& aPos ) override
87 {
88 }
89
90 EDA_ITEM* Clone() const override
91 {
92 return new NETINFO_ITEM( *this );
93 }
94
95 void SetNetClass( const std::shared_ptr<NETCLASS>& aNetClass );
96
101 NETCLASS* GetNetClass() { return m_netClass.get(); }
102
106 std::shared_ptr<NETCLASS> GetNetClassSlow() { return m_netClass; }
107
108 int GetNetCode() const { return m_netCode; }
109 void SetNetCode( int aNetCode ) { m_netCode = aNetCode; }
110
114 const wxString& GetNetname() const { return m_netname; }
115
119 const wxString& GetShortNetname() const { return m_shortNetname; }
120
124 const wxString& GetUnescapedShortNetname() const { return m_unescapedShortNetname; }
125
130 {
131 return m_shortNetname.StartsWith( wxT( "Net-(" ) )
132 || m_shortNetname.StartsWith( wxT( "unconnected-(" ) );
133 }
134
139 void SetNetname( const wxString& aNewName )
140 {
141 m_netname = aNewName;
142
143 if( aNewName.Contains( wxT( "/" ) ) )
144 m_shortNetname = aNewName.AfterLast( '/' );
145 else
146 m_shortNetname = aNewName;
147
148 m_unescapedShortNetname = UnescapeString( m_shortNetname );
149 }
150
151 bool IsCurrent() const { return m_isCurrent; }
152 void SetIsCurrent( bool isCurrent ) { m_isCurrent = isCurrent; }
153
160 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
161
165 void Clear();
166
167 void SetParent( BOARD* aParent ) { m_parent = aParent; }
168 BOARD* GetParent() const // Replace EDA_ITEM::GetParent() with a more useful return-type
169 {
170 return m_parent;
171 }
172
173 bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
174
175 double Similarity( const BOARD_ITEM& aBoardItem ) const override
176 {
177 return 0.0;
178 }
179
180 bool operator==( const BOARD_ITEM& aBoardItem ) const override
181 {
182 return 0.0;
183 }
184
185protected:
186 // Hide base SetParent method to make the BOARD* method the prefered method for this class
188
189private:
190 friend class NETINFO_LIST;
191
193 wxString m_netname;
194 wxString m_shortNetname;
196
197 std::shared_ptr<NETCLASS> m_netClass;
198
202
204};
205
206
208{
209public:
211 {
212 m_board = nullptr;
213 }
214
215
219 void SetBoard( const BOARD* aBoard )
220 {
221 m_board = aBoard;
222 Update();
223 }
224
230 void Update();
231
240 int Translate( int aNetCode ) const;
241
245 {
246 public:
247 iterator( std::map<int, int>::const_iterator aIter, const NETINFO_MAPPING* aMapping ) :
248 m_iterator( aIter ), m_mapping( aMapping )
249 {
250 }
251
254 {
255 ++m_iterator;
256
257 return *this;
258 }
259
262 {
263 iterator ret = *this;
264 ++m_iterator;
265
266 return ret;
267 }
268
269 NETINFO_ITEM* operator*() const;
270
271 NETINFO_ITEM* operator->() const;
272
273 bool operator!=( const iterator& aOther ) const
274 {
275 return m_iterator != aOther.m_iterator;
276 }
277
278 bool operator==( const iterator& aOther ) const
279 {
280 return m_iterator == aOther.m_iterator;
281 }
282
283 private:
284 std::map<int, int>::const_iterator m_iterator;
286 };
287
295 {
296 return iterator( m_netMapping.begin(), this );
297 }
298
305 iterator end() const
306 {
307 return iterator( m_netMapping.end(), this );
308 }
309
313 int GetSize() const
314 {
315 return m_netMapping.size();
316 }
317
318private:
319 const BOARD* m_board;
320 std::map<int, int> m_netMapping;
322};
323
324
325#if 0
326// waiting for swig to support std::unordered_map, see
327// http://www.swig.org/Doc3.0/CPlusPlus11.html
328// section 7.3.3
329#include <hashtables.h>
330DECL_HASH_FOR_SWIG( NETNAMES_MAP, wxString, NETINFO_ITEM* )
331DECL_HASH_FOR_SWIG( NETCODES_MAP, int, NETINFO_ITEM* )
332#else
333// use std::map for now
334DECL_MAP_FOR_SWIG( NETNAMES_MAP, wxString, NETINFO_ITEM* )
335DECL_MAP_FOR_SWIG( NETCODES_MAP, int, NETINFO_ITEM* )
336#endif
337
342{
343 friend class BOARD;
344
345public:
346 NETINFO_LIST( BOARD* aParent );
348
353 NETINFO_ITEM* GetNetItem( int aNetCode ) const;
354
359 NETINFO_ITEM* GetNetItem( const wxString& aNetName ) const;
360
365 unsigned GetNetCount() const { return m_netNames.size(); }
366
368 const NETNAMES_MAP& NetsByName() const { return m_netNames; }
369
371 const NETCODES_MAP& NetsByNetcode() const { return m_netCodes; }
372
375 static const int UNCONNECTED;
376
379 static const int ORPHANED;
380
384 {
385 static NETINFO_ITEM* g_orphanedItem;
386
387 if( !g_orphanedItem )
388 g_orphanedItem = new NETINFO_ITEM( nullptr, wxEmptyString, NETINFO_LIST::UNCONNECTED );
389
390 return g_orphanedItem;
391 }
392
393#if defined(DEBUG)
394 void Show() const;
395#endif
396
397#ifndef SWIG
401 {
402 public:
403 iterator( NETNAMES_MAP::const_iterator aIter ) : m_iterator( aIter )
404 {
405 }
406
409 {
410 ++m_iterator;
411 return *this;
412 }
413
416 {
417 iterator ret = *this;
418 ++m_iterator;
419 return ret;
420 }
421
423 {
424 return m_iterator->second;
425 }
426
428 {
429 return m_iterator->second;
430 }
431
432 bool operator!=( const iterator& aOther ) const
433 {
434 return m_iterator != aOther.m_iterator;
435 }
436
437 bool operator==( const iterator& aOther ) const
438 {
439 return m_iterator == aOther.m_iterator;
440 }
441
442 private:
443 NETNAMES_MAP::const_iterator m_iterator;
444 };
445
447 {
448 return iterator( m_netNames.begin() );
449 }
450
451 iterator end() const
452 {
453 return iterator( m_netNames.end() );
454 }
455#endif
456
458 {
459 return m_parent;
460 }
461
462protected: // Access is through the BOARD, which is a friend class
467 void AppendNet( NETINFO_ITEM* aNewElement );
468
472 void RemoveNet( NETINFO_ITEM* aNet );
473 void RemoveUnusedNets( BOARD_COMMIT* aCommit );
474
475private:
479 void clear();
480
486 void buildListOfNets();
487
491 int getFreeNetCode();
492
494
495 NETNAMES_MAP m_netNames;
496 NETCODES_MAP m_netCodes;
497
499};
500
501#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:77
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:276
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
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:100
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:44
Handle the data for a net.
Definition: netinfo.h:56
bool HasAutoGeneratedNetname()
Definition: netinfo.h:129
wxString m_shortNetname
Short net name, like vout from /sheet/subsheet/vout.
Definition: netinfo.h:194
bool operator==(const BOARD_ITEM &aBoardItem) const override
Definition: netinfo.h:180
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:139
wxString GetClass() const override
Return the class name.
Definition: netinfo.h:67
double Similarity(const BOARD_ITEM &aBoardItem) const override
Return a measure of how likely the other object is to represent the same object.
Definition: netinfo.h:175
const wxString & GetShortNetname() const
Definition: netinfo.h:119
static bool ClassOf(const EDA_ITEM *aItem)
Definition: netinfo.h:62
BOARD * GetParent() const
Definition: netinfo.h:168
const wxString & GetNetname() const
Definition: netinfo.h:114
void SetNetCode(int aNetCode)
Definition: netinfo.h:109
NETCLASS * GetNetClass()
Definition: netinfo.h:101
std::shared_ptr< NETCLASS > GetNetClassSlow()
Definition: netinfo.h:106
int GetNetCode() const
Definition: netinfo.h:108
wxString m_unescapedShortNetname
Unescaped short net name.
Definition: netinfo.h:195
VECTOR2I GetPosition() const override
Definition: netinfo.h:80
int m_netCode
A number equivalent to the net name.
Definition: netinfo.h:192
std::shared_ptr< NETCLASS > m_netClass
Definition: netinfo.h:197
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: netinfo.h:90
void SetParent(BOARD *aParent)
Definition: netinfo.h:167
wxString m_netname
Full net name like /sheet/subsheet/vout used by Eeschema.
Definition: netinfo.h:193
void SetIsCurrent(bool isCurrent)
Definition: netinfo.h:152
bool m_isCurrent
Indicates the net is currently in use.
Definition: netinfo.h:199
bool IsCurrent() const
Definition: netinfo.h:151
const wxString & GetUnescapedShortNetname() const
Definition: netinfo.h:124
void SetPosition(const VECTOR2I &aPos) override
Definition: netinfo.h:86
BOARD * m_parent
The parent board the net belongs to.
Definition: netinfo.h:203
Wrapper class, so you can iterate through NETINFO_ITEM*s, not std::pair<int/wxString,...
Definition: netinfo.h:401
iterator operator++(int)
post-increment operator
Definition: netinfo.h:415
bool operator==(const iterator &aOther) const
Definition: netinfo.h:437
NETNAMES_MAP::const_iterator m_iterator
Definition: netinfo.h:443
bool operator!=(const iterator &aOther) const
Definition: netinfo.h:432
const iterator & operator++()
pre-increment operator
Definition: netinfo.h:408
iterator(NETNAMES_MAP::const_iterator aIter)
Definition: netinfo.h:403
NETINFO_ITEM * operator->() const
Definition: netinfo.h:427
NETINFO_ITEM * operator*() const
Definition: netinfo.h:422
Container for NETINFO_ITEM elements, which are the nets.
Definition: netinfo.h:342
int getFreeNetCode()
Return the first available net code that is not used by any other net.
void RemoveUnusedNets(BOARD_COMMIT *aCommit)
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
Definition: netinfo.h:375
NETCODES_MAP m_netCodes
map of <int, NETINFO_ITEM*> is NOT owner
Definition: netinfo.h:496
static const int ORPHANED
Constant that forces initialization of a netinfo item to the NETINFO_ITEM ORPHANED (typically -1) whe...
Definition: netinfo.h:379
iterator begin() const
Definition: netinfo.h:446
int m_newNetCode
possible value for new net code assignment
Definition: netinfo.h:498
BOARD * GetParent() const
Definition: netinfo.h:457
static NETINFO_ITEM * OrphanedItem()
NETINFO_ITEM meaning that there was no net assigned for an item, as there was no board storing net li...
Definition: netinfo.h:383
unsigned GetNetCount() const
Definition: netinfo.h:365
void RemoveNet(NETINFO_ITEM *aNet)
Remove a net from the net list.
BOARD * m_parent
Definition: netinfo.h:493
NETINFO_ITEM * GetNetItem(int aNetCode) const
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:371
NETNAMES_MAP m_netNames
map of <wxString, NETINFO_ITEM*>, is NETINFO_ITEM owner
Definition: netinfo.h:495
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:368
iterator end() const
Definition: netinfo.h:451
void buildListOfNets()
Rebuild the list of NETINFO_ITEMs.
Wrapper class, so you can iterate through NETINFO_ITEM*s, not std::pair<int/wxString,...
Definition: netinfo.h:245
NETINFO_ITEM * operator->() const
const NETINFO_MAPPING * m_mapping
Definition: netinfo.h:285
std::map< int, int >::const_iterator m_iterator
Definition: netinfo.h:284
bool operator!=(const iterator &aOther) const
Definition: netinfo.h:273
iterator(std::map< int, int >::const_iterator aIter, const NETINFO_MAPPING *aMapping)
Definition: netinfo.h:247
iterator operator++(int)
post-increment operator
Definition: netinfo.h:261
NETINFO_ITEM * operator*() const
const iterator & operator++()
pre-increment operator
Definition: netinfo.h:253
bool operator==(const iterator &aOther) const
Definition: netinfo.h:278
void SetBoard(const BOARD *aBoard)
Set a BOARD object that is used to prepare the net code map.
Definition: netinfo.h:219
int Translate(int aNetCode) const
Translate net number according to the map prepared by Update() function.
int GetSize() const
Definition: netinfo.h:313
iterator end() const
Return iterator to the last entry in the mapping.
Definition: netinfo.h:305
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:319
iterator begin() const
Return iterator to the first entry in the mapping.
Definition: netinfo.h:294
std::map< int, int > m_netMapping
Map that allows saving net codes with consecutive numbers (for compatibility reasons)
Definition: netinfo.h:320
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:109