KiCad PCB EDA Suite
netinfo_item.cpp
Go to the documentation of this file.
1 
5 /*
6  * This program source code file is part of KiCad, a free EDA CAD application.
7  *
8  * Copyright (C) 2012 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
9  * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
10  * Copyright (C) 1992-2012 KiCad Developers, see AUTHORS.txt for contributors.
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, you may find one here:
24  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
25  * or you may search the http://www.gnu.org website for the version 2 license,
26  * or you may write to the Free Software Foundation, Inc.,
27  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
28  */
29 
30 #include <fctsys.h>
31 #include <gr_basic.h>
32 #include <pcb_base_frame.h>
33 #include <common.h>
34 #include <kicad_string.h>
35 #include <pcbnew.h>
36 #include <richio.h>
37 #include <macros.h>
38 #include <msgpanel.h>
39 #include <base_units.h>
40 #include <class_board.h>
41 #include <class_module.h>
42 #include <class_track.h>
43 
44 
45 /*********************************************************/
46 /* class NETINFO_ITEM: handle data relative to a given net */
47 /*********************************************************/
48 
49 NETINFO_ITEM::NETINFO_ITEM( BOARD* aParent, const wxString& aNetName, int aNetCode ) :
50  BOARD_ITEM( aParent, PCB_NETINFO_T ),
51  m_NetCode( aNetCode ),
52  m_isCurrent( true ),
53  m_Netname( aNetName ),
54  m_ShortNetname( m_Netname.AfterLast( '/' ) )
55 {
56  m_parent = aParent;
57 
58  if( aParent )
60  else
61  m_NetClass = std::make_shared<NETCLASS>( "<invalid>" );
62 }
63 
64 
66 {
67  // m_NetClass is not owned by me.
68 }
69 
70 
71 void NETINFO_ITEM::SetClass( const NETCLASSPTR& aNetClass )
72 {
73  wxCHECK( m_parent, /* void */ );
74  m_NetClass = aNetClass ? aNetClass : m_parent->GetDesignSettings().GetNetClasses().GetDefault();
75 }
76 
77 
78 void NETINFO_ITEM::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
79 {
80  wxString txt;
81  double lengthnet = 0.0; // This is the length of tracks on pcb
82  double lengthPadToDie = 0.0; // this is the length of internal ICs connections
83 
84  aList.emplace_back( _( "Net Name" ), GetNetname(), RED );
85 
86  txt.Printf( wxT( "%d" ), GetNet() );
87  aList.emplace_back( _( "Net Code" ), txt, RED );
88 
89  // Warning: for netcode == NETINFO_LIST::ORPHANED, the parent or the board
90  // can be NULL
91  BOARD * board = m_parent ? m_parent->GetBoard() : NULL;
92 
93  if( board == NULL )
94  return;
95 
96  int count = 0;
97  for( auto mod : board->Modules() )
98  {
99  for( auto pad : mod->Pads() )
100  {
101  if( pad->GetNetCode() == GetNet() )
102  {
103  count++;
104  lengthPadToDie += pad->GetPadToDieLength();
105  }
106  }
107  }
108 
109  txt.Printf( wxT( "%d" ), count );
110  aList.emplace_back( _( "Pads" ), txt, DARKGREEN );
111 
112  count = 0;
113 
114  for( auto track : board->Tracks() )
115  {
116  if( track->Type() == PCB_VIA_T )
117  {
118  if( track->GetNetCode() == GetNet() )
119  count++;
120  }
121 
122  if( track->Type() == PCB_TRACE_T )
123  {
124  if( track->GetNetCode() == GetNet() )
125  lengthnet += track->GetLength();
126  }
127  }
128 
129  txt.Printf( wxT( "%d" ), count );
130  aList.emplace_back( _( "Vias" ), txt, BLUE );
131 
132  // Displays the full net length (tracks on pcb + internal ICs connections ):
133  txt = MessageTextFromValue( aFrame->GetUserUnits(), lengthnet + lengthPadToDie );
134  aList.emplace_back( _( "Net Length" ), txt, RED );
135 
136  // Displays the net length of tracks only:
137  txt = MessageTextFromValue( aFrame->GetUserUnits(), lengthnet );
138  aList.emplace_back( _( "On Board" ), txt, RED );
139 
140  // Displays the net length of internal ICs connections (wires inside ICs):
141  txt = MessageTextFromValue( aFrame->GetUserUnits(), lengthPadToDie, true );
142  aList.emplace_back( _( "In Package" ), txt, RED );
143 }
NETCLASSPTR m_NetClass
Definition: netinfo.h:81
Implementation of conversion functions that require both schematic and board internal units.
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:551
BOARD * m_parent
The parent board the net belongs to.
Definition: netinfo.h:83
The base class for create windows for drawing purpose.
A single base class (TRACK) represents both tracks and vias, with subclasses for curved tracks (ARC) ...
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
This file contains miscellaneous commonly used macros and functions.
Classes used in Pcbnew, CvPcb and GerbView.
#define NULL
MODULES & Modules()
Definition: class_board.h:266
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
const wxString & GetNetname() const
Function GetNetname.
Definition: netinfo.h:231
NETCLASSES & GetNetClasses() const
NETINFO_ITEM(BOARD *aParent, const wxString &aNetName=wxEmptyString, int aNetCode=-1)
NETINFO_ITEM class, to handle info on nets: netnames, net constraints.
Definition: color4d.h:59
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aUseMils, EDA_DATA_TYPE aType)
Definition: base_units.cpp:124
Definition: color4d.h:56
int GetNet() const
Function GetNet.
Definition: netinfo.h:223
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:180
#define _(s)
Definition: 3d_actions.cpp:33
class NETINFO_ITEM, a description of a net
Definition: typeinfo.h:104
void SetClass(const NETCLASSPTR &aNetClass)
Function SetClass sets aNetclass into this NET.
The common library.
NETCLASSPTR GetDefault() const
Function GetDefault.
Definition: netclass.h:265
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo returns the information about the NETINFO_ITEM in aList to display in the me...
Message panel definition file.
TRACKS & Tracks()
Definition: class_board.h:257
EDA_UNITS GetUserUnits() const
Return the user units currently in use.