KiCad PCB EDA Suite
Loading...
Searching...
No Matches
transline_ident.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) 2011-2014 Jean-Pierre Charras
5 * Copyright The 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 3
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 along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
24#include <wx/intl.h>
25#include <wx/arrstr.h>
26#include <wx/log.h>
27
28#include <kiface_base.h>
29#include <bitmaps.h>
30
31// transline specific functions:
32#include "transline/transline.h"
33#include "transline/microstrip.h"
34#include "transline/coplanar.h"
35#include "transline/rectwaveguide.h"
36#include "transline/coax.h"
37#include "transline/c_microstrip.h"
38#include "transline/stripline.h"
39#include "transline/twistedpair.h"
40#include "transline/c_stripline.h"
41
42#include "pcb_calculator_settings.h"
43#include "widgets/unit_selector.h"
44#include "transline_ident.h"
45#include <properties/property_mgr.h>
46#include <properties/property.h>
47
48
49TRANSLINE_PRM::TRANSLINE_PRM( PRM_TYPE aType, PRMS_ID aId, const char* aKeywordCfg, const wxString& aDlgLabel,
50 const wxString& aToolTip, double aValue, bool aConvUnit, int aDefaultUnit )
51{
52 m_Type = aType;
53 m_Id = aId;
54 m_DlgLabel = aDlgLabel;
55 m_KeyWord = aKeywordCfg;
56 m_ToolTip = aToolTip;
57 m_Value = aValue;
58 m_DefaultValue = aValue;
59 m_DefaultUnit = aDefaultUnit;
60 m_ConvUnit = aConvUnit;
61 m_ValueCtrl = nullptr;
62 m_UnitCtrl = nullptr;
63 m_UnitSelection = 0;
64 m_NormalizedValue = 0;
65 }
66
67
68double TRANSLINE_PRM::ToUserUnit()
69{
70 if( m_UnitCtrl && m_ConvUnit )
71 return 1.0 / ( (UNIT_SELECTOR*) m_UnitCtrl )->GetUnitScale();
72 else
73 return 1.0;
74}
75
76
77double TRANSLINE_PRM::FromUserUnit()
78{
79 if( m_UnitCtrl )
80 return ( (UNIT_SELECTOR*) m_UnitCtrl )->GetUnitScale();
81 else
82 return 1.0;
83}
84
85
86TRANSLINE_IDENT::TRANSLINE_IDENT( enum TRANSLINE_TYPE_ID aType )
87{
88 m_Type = aType; // The type of transline handled
89 m_BitmapName = BITMAPS::INVALID_BITMAP; // The icon to display
90 m_TLine = nullptr; // The TRANSLINE itself
91 m_HasPrmSelection = false; // true if selection of parameters must be enabled in dialog menu
92
93 // Same H_t tooltip text is used for the microstrip and coupled-microstrip blocks below.
94 const wxString coverHeightToolTip =
95 _( "Height from substrate top to grounded cover. Leave at the large default value "
96 "for no cover." );
97
98 // Add common prms:
99 // Default values are for FR4
100 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, EPSILONR_PRM,
101 "Er", wxT( "εr" ),
102 _( "Substrate relative permittivity (dielectric constant)" ),
103 4.5, false ) );
104 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, TAND_PRM,
105 "TanD", wxT( "tan δ" ),
106 _( "Dielectric loss (dissipation factor)" ),
107 2e-2, false ) );
108
109 // Default value is for copper
110 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, RHO_PRM,
111 "Rho", wxT( "ρ" ),
112 _( "Electrical resistivity or specific electrical resistance of "
113 "conductor (ohm*meter)" ),
114 1.72e-8, false ) );
115
116 // Default value is in GHz
117 AddPrm( new TRANSLINE_PRM( PRM_TYPE_FREQUENCY, FREQUENCY_PRM,
118 "Frequency", _( "Frequency" ),
119 _( "Frequency of the input signal" ), 1.0, true ) );
120
121
122 switch( m_Type )
123 {
124 case MICROSTRIP_TYPE: // microstrip
125 m_TLine = new MICROSTRIP_UI();
126 m_BitmapName = BITMAPS::microstrip;
127
128 m_Messages.Add( wxString::Format( _( "Effective %s:" ), wxT( "εr" ) ) );
129 m_Messages.Add( _( "Unit propagation delay:" ) );
130 m_Messages.Add( _( "Conductor losses:" ) );
131 m_Messages.Add( _( "Dielectric losses:" ) );
132 m_Messages.Add( _( "Skin depth:" ) );
133
134 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, H_PRM,
135 "H", "H", _( "Height of substrate" ), 0.2, true ) );
136 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, H_T_PRM,
137 "H_t", "H(top)", coverHeightToolTip, 1e20, true ) );
138 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, T_PRM,
139 "T", "T",
140 _( "Strip thickness" ), 0.035, true ) );
141 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, ROUGH_PRM,
142 "Rough", _( "Roughness" ),
143 _( "Conductor roughness" ), 0.0, true ) );
144 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MUR_PRM,
145 "mu Rel S", wxString::Format( wxT( "μr (%s)" ),
146 _( "substrate" ) ),
147 _( "Relative permeability (mu) of substrate" ), 1, false ) );
148 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MURC_PRM,
149 "mu Rel C", wxString::Format( wxT( "μr (%s)" ),
150 _( "conductor" ) ),
151 _( "Relative permeability (mu) of conductor" ), 1,
152 false ) );
153
154 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_WIDTH_PRM,
155 "W", "W", _( "Line width" ), 0.2, true ) );
156 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_LEN_PRM,
157 "L", "L", _( "Line length" ), 50.0, true ) );
158
159 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_PRM,
160 "Z0", "Z0", _( "Characteristic impedance" ), 50.0, true ) );
161 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, DUMMY_PRM ) );
162 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, ANG_L_PRM,
163 "Ang_l", "Ang_l", _( "Electrical length" ), 0.0, true ) );
164 break;
165
166 case CPW_TYPE: // coplanar waveguide
167 m_TLine = new COPLANAR_UI();
168 m_BitmapName = BITMAPS::cpw;
169 m_HasPrmSelection = true;
170
171 m_Messages.Add( wxString::Format( _( "Effective %s:" ), wxT( "εr" ) ) );
172 m_Messages.Add( _( "Unit propagation delay:" ) );
173 m_Messages.Add( _( "Conductor losses:" ) );
174 m_Messages.Add( _( "Dielectric losses:" ) );
175 m_Messages.Add( _( "Skin depth:" ) );
176
177 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, H_PRM,
178 "H", "H", _( "Height of substrate" ), 0.2, true ) );
179 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, T_PRM,
180 "T", "T", _( "Strip thickness" ), 0.035, true ) );
181 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MURC_PRM,
182 "mu Rel C", wxString::Format( wxT( "μ(%s)" ),
183 _( "conductor" ) ),
184 _( "Relative permeability (mu) of conductor" ), 1,
185 false ) );
186
187 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_WIDTH_PRM,
188 "W", "W", _( "Line width" ), 0.2, true ) );
189 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_S_PRM,
190 "S", "S", _( "Gap width" ), 0.2, true ) );
191 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_LEN_PRM,
192 "L", "L", _( "Line length" ), 50.0, true ) );
193
194 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_PRM,
195 "Z0", "Z0", _( "Characteristic impedance" ), 50.0, true ) );
196 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, DUMMY_PRM ) );
197 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, ANG_L_PRM,
198 "Ang_l", "Ang_l", _( "Electrical length" ), 0.0, true ) );
199 break;
200
201 case GROUNDED_CPW_TYPE: // grounded coplanar waveguide
202 m_TLine = new GROUNDEDCOPLANAR_UI();
203 m_BitmapName = BITMAPS::cpw_back;
204 m_HasPrmSelection = true;
205
206 m_Messages.Add( wxString::Format( _( "Effective %s:" ), wxT( "εr" ) ) );
207 m_Messages.Add( _( "Unit propagation delay:" ) );
208 m_Messages.Add( _( "Conductor losses:" ) );
209 m_Messages.Add( _( "Dielectric losses:" ) );
210 m_Messages.Add( _( "Skin depth:" ) );
211
212 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, H_PRM,
213 "H", "H", _( "Height of substrate" ), 0.2, true ) );
214 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, T_PRM,
215 "T", "T", _( "Strip thickness" ), 0.035, true ) );
216 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MURC_PRM,
217 "mu Rel C", wxString::Format( wxT( "μ(%s)" ),
218 _( "conductor" ) ),
219 _( "Relative permeability (mu) of conductor" ), 1,
220 false ) );
221
222 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_WIDTH_PRM,
223 "W", "W", _( "Line width" ), 0.2, true ) );
224 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_S_PRM,
225 "S", "S", _( "Gap width" ), 0.2, true ) );
226 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_LEN_PRM,
227 "L", "L", _( "Line length" ), 50.0, true ) );
228
229 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_PRM,
230 "Z0", "Z0", _( "Characteristic impedance" ), 50.0, true ) );
231 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, DUMMY_PRM ) );
232 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, ANG_L_PRM,
233 "Ang_l", "Ang_l", _( "Electrical length" ), 0, true ) );
234 break;
235
236
237 case RECTWAVEGUIDE_TYPE: // rectangular waveguide
238 m_TLine = new RECTWAVEGUIDE_UI();
239 m_BitmapName = BITMAPS::rectwaveguide;
240 m_HasPrmSelection = true;
241
242 m_Messages.Add( _( "ZF(H10) = Ey / Hx:" ) );
243 m_Messages.Add( wxString::Format( _( "Effective %s:" ), wxT( "εr" ) ) );
244 m_Messages.Add( _( "Conductor losses:" ) );
245 m_Messages.Add( _( "Dielectric losses:" ) );
246 m_Messages.Add( _( "TE-modes:" ) );
247 m_Messages.Add( _( "TM-modes:" ) );
248
249 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MUR_PRM,
250 "mu Rel I", wxString::Format( wxT( "μ(%s)" ),
251 _( "insulator" ) ),
252 _( "Relative permeability (mu) of insulator" ), 1, false ) );
253 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MURC_PRM,
254 "mu Rel C", wxString::Format( wxT( "μ(%s)" ),
255 _( "conductor" ) ),
256 _( "Relative permeability (mu) of conductor" ), 1,
257 false ) );
258
259 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_WIDTH_PRM,
260 "a", "a", _( "Width of waveguide" ), 10.0, true ) );
261 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_S_PRM,
262 "b", "b", _( "Height of waveguide" ), 5.0, true ) );
263 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_LEN_PRM,
264 "L", "L", _( "Waveguide length" ), 50.0, true ) );
265
266 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_PRM,
267 "Z0", "Z0", _( "Characteristic impedance" ), 50.0, true ) );
268 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, DUMMY_PRM ) );
269 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, ANG_L_PRM,
270 "Ang_l", "Ang_l", _( "Electrical length" ), 0, true ) );
271 break;
272
273 case COAX_TYPE: // coaxial cable
274 m_TLine = new COAX_UI();
275 m_BitmapName = BITMAPS::coax;
276 m_HasPrmSelection = true;
277
278 m_Messages.Add( wxString::Format( _( "Effective %s:" ), wxT( "εr" ) ) );
279 m_Messages.Add( _( "Conductor losses:" ) );
280 m_Messages.Add( _( "Dielectric losses:" ) );
281 m_Messages.Add( _( "TE-modes:" ) );
282 m_Messages.Add( _( "TM-modes:" ) );
283
284 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MUR_PRM,
285 "mu Rel I", wxString::Format( wxT( "μ(%s)" ),
286 _( "insulator" ) ),
287 _( "Relative permeability (mu) of insulator" ), 1, false ) );
288 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MURC_PRM,
289 "mu Rel C", wxString::Format( wxT( "μ(%s)" ),
290 _( "conductor" ) ),
291 _( "Relative permeability (mu) of conductor" ), 1,
292 false ) );
293
294 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_DIAM_IN_PRM,
295 "Din", _( "Din" ),
296 _( "Inner diameter (conductor)" ), 1.0, true ) );
297 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_DIAM_OUT_PRM,
298 "Dout", _( "Dout" ),
299 _( "Outer diameter (insulator)" ), 8.0, true ) );
300 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_LEN_PRM,
301 "L", "L", _( "Line length" ), 50.0, true ) );
302
303 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_PRM,
304 "Z0", "Z0", _( "Characteristic impedance" ), 50.0, true ) );
305 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, DUMMY_PRM ) );
306 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, ANG_L_PRM,
307 "Ang_l", "Ang_l", _( "Electrical length" ), 0.0, true ) );
308 break;
309
310 case C_MICROSTRIP_TYPE: // coupled microstrip
311 m_TLine = new C_MICROSTRIP();
312 m_BitmapName = BITMAPS::c_microstrip;
313 m_HasPrmSelection = true;
314
315 m_Messages.Add( wxString::Format( _( "Effective %s (even):" ), wxT( "εr" ) ) );
316 m_Messages.Add( wxString::Format( _( "Effective %s (odd):" ), wxT( "εr" ) ) );
317 m_Messages.Add( _( "Unit propagation delay (even):" ) );
318 m_Messages.Add( _( "Unit propagation delay (odd):" ) );
319 m_Messages.Add( _( "Conductor losses (even):" ) );
320 m_Messages.Add( _( "Conductor losses (odd):" ) );
321 m_Messages.Add( _( "Dielectric losses (even):" ) );
322 m_Messages.Add( _( "Dielectric losses (odd):" ) );
323 m_Messages.Add( _( "Skin depth:" ) );
324 m_Messages.Add( _( "Differential Impedance (Zd):" ) );
325
326 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, H_PRM,
327 "H", "H", _( "Height of substrate" ), 0.2, true ) );
328 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, H_T_PRM,
329 "H_t", "H_t", coverHeightToolTip, 1e20, true ) );
330 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, T_PRM,
331 "T", "T", _( "Strip thickness" ), 0.035, true ) );
332 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, ROUGH_PRM,
333 "Rough", _( "Roughness" ),
334 _( "Conductor roughness" ), 0.0, true ) );
335 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MURC_PRM,
336 "mu rel C", wxString::Format( wxT( "μ(%s)" ),
337 _( "conductor" ) ),
338 _( "Relative permeability (mu) of conductor" ), 1,
339 false ) );
340
341 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_WIDTH_PRM,
342 "W", "W", _( "Line width" ), 0.2, true ) );
343 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_S_PRM,
344 "S", "S", _( "Gap width" ), 0.2, true ) );
345 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_LEN_PRM,
346 "L", "L", _( "Line length" ), 50.0, true ) );
347
348 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_E_PRM, "Zeven", _( "Zeven" ),
349 _( "Even mode impedance (lines driven by common voltages)" ), 50.0, true ) );
350 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_O_PRM, "Zodd", _( "Zodd" ),
351 _( "Odd mode impedance (lines driven by opposite "
352 "(differential) voltages)" ),
353 50.0, true ) );
354 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, ANG_L_PRM, "Ang_l", "Ang_l", _( "Electrical length" ), 0.0, true ) );
355 break;
356
357 case C_STRIPLINE_TYPE: // Coupled stripline
358 m_TLine = new C_STRIPLINE();
359 m_BitmapName = BITMAPS::coupled_stripline;
360 m_HasPrmSelection = true;
361
362 m_Messages.Add( wxString::Format( _( "Effective %s (even):" ), wxT( "εr" ) ) );
363 m_Messages.Add( wxString::Format( _( "Effective %s (odd):" ), wxT( "εr" ) ) );
364 m_Messages.Add( _( "Unit propagation delay (even):" ) );
365 m_Messages.Add( _( "Unit propagation delay (odd):" ) );
366 m_Messages.Add( _( "Skin depth:" ) );
367 m_Messages.Add( _( "Differential Impedance (Zd):" ) );
368 m_Messages.Add( _( "Common-mode Impedance (Zcomm):" ) );
369 m_Messages.Add( _( "Coupling coefficient (kc):" ) );
370
371 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, H_PRM, "H", "H", _( "Height of substrate" ), 0.2, true ) );
372 // Zero default keeps the math layer on the centred fast path so existing designs that
373 // never touched 'a' remain bit-identical to the pre-offset behaviour.
374 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, STRIPLINE_A_PRM, "a", "a",
375 _( "Distance from track to closest ground plane "
376 "(default: centered)" ),
377 0.0, true ) );
378 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, T_PRM, "T", "T", _( "Strip thickness" ), 0.035, true ) );
379 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MURC_PRM, "mu rel C",
380 wxString::Format( wxT( "μ(%s)" ), _( "conductor" ) ),
381 _( "Relative permeability (mu) of conductor" ), 1, false ) );
382
383 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_WIDTH_PRM, "W", "W", _( "Line width" ), 0.2, true ) );
384 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_S_PRM, "S", "S", _( "Gap width" ), 0.2, true ) );
385 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_LEN_PRM, "L", "L", _( "Line length" ), 50.0, true ) );
386
387 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_E_PRM,
388 "Zeven", _( "Zeven" ),
389 _( "Even mode impedance (lines driven by common voltages)" ),
390 50.0, true ) );
391 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_O_PRM,
392 "Zodd", _( "Zodd" ),
393 _( "Odd mode impedance (lines driven by opposite "
394 "(differential) voltages)" ), 50.0, true ) );
395 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, ANG_L_PRM,
396 "Ang_l", "Ang_l",
397 _( "Electrical length" ), 0.0, true ) );
398 break;
399
400 case STRIPLINE_TYPE: // stripline
401 m_TLine = new STRIPLINE_UI();
402 m_BitmapName = BITMAPS::stripline;
403
404 m_Messages.Add( wxString::Format( _( "Effective %s:" ), wxT( "εr" ) ) );
405 m_Messages.Add( _( "Unit propagation delay:" ) );
406 m_Messages.Add( _( "Conductor losses:" ) );
407 m_Messages.Add( _( "Dielectric losses:" ) );
408 m_Messages.Add( _( "Skin depth:" ) );
409
410 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, H_PRM,
411 "H", "H", _( "Height of substrate" ), 0.2, true ) );
412 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, STRIPLINE_A_PRM,
413 "a", "a", _( "Distance between strip and top metal" ), 0.2,
414 true ) );
415 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, T_PRM,
416 "T", "T", _( "Strip thickness" ), 0.035, true ) );
417 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MURC_PRM,
418 "mu Rel C", wxString::Format( wxT( "μ(%s)" ),
419 _( "conductor" ) ),
420 _( "Relative permeability (mu) of conductor" ), 1, false ) );
421
422 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_WIDTH_PRM,
423 "W", "W", _( "Line width" ), 0.2, true ) );
424 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_LEN_PRM,
425 "L", "L", _( "Line length" ), 50.0, true ) );
426
427 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_PRM,
428 "Z0", "Z0", _( "Characteristic impedance" ), 50, true ) );
429 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, DUMMY_PRM ) );
430 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, ANG_L_PRM,
431 "Ang_l", "Ang_l", _( "Electrical length" ), 0, true ) );
432 break;
433
434 case TWISTEDPAIR_TYPE: // twisted pair
435 m_TLine = new TWISTEDPAIR_UI();
436 m_BitmapName = BITMAPS::twistedpair;
437 m_HasPrmSelection = true;
438
439 m_Messages.Add( wxString::Format( _( "Effective %s:" ), wxT( "εr" ) ) );
440 m_Messages.Add( _( "Conductor losses:" ) );
441 m_Messages.Add( _( "Dielectric losses:" ) );
442 m_Messages.Add( _( "Skin depth:" ) );
443
444 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, TWISTEDPAIR_TWIST_PRM,
445 "Twists", _( "Twists" ),
446 _( "Number of twists per length" ), 0.0, false ) );
447 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, MURC_PRM,
448 "mu Rel C", wxString::Format( wxT( "μ(%s)" ),
449 _( "conductor" ) ),
450 _( "Relative permeability (mu) of conductor" ), 1,
451 false ) );
452 AddPrm( new TRANSLINE_PRM( PRM_TYPE_SUBS, TWISTEDPAIR_EPSILONR_ENV_PRM,
453 "ErEnv", wxString::Format( wxT( "εr(%s)" ),
454 _( "environment" ) ),
455 _( "Relative permittivity of environment" ), 1,
456 false ) );
457 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_DIAM_IN_PRM,
458 "Din", _( "Din" ),
459 _( "Inner diameter (conductor)" ), 1.0, true ) );
460 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_DIAM_OUT_PRM,
461 "Dout", _( "Dout" ),
462 _( "Outer diameter (insulator)" ), 8.0, true ) );
463 AddPrm( new TRANSLINE_PRM( PRM_TYPE_PHYS, PHYS_LEN_PRM,
464 "L", "L", _( "Cable length" ), 50.0, true ) );
465
466 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, Z0_PRM,
467 "Z0", "Z0", _( "Characteristic impedance" ), 50.0, true ) );
468 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, DUMMY_PRM ) );
469 AddPrm( new TRANSLINE_PRM( PRM_TYPE_ELEC, ANG_L_PRM,
470 "Ang_l", "Ang_l", _( "Electrical length" ), 0.0, true ) );
471 break;
472
473 case END_OF_LIST_TYPE: // Not really used
474 break;
475 }
476}
477
478TRANSLINE_IDENT::~TRANSLINE_IDENT()
479{
480 delete m_TLine;
481
482 for( auto& ii : m_prms_List )
483 delete ii;
484
485 m_prms_List.clear();
486}
487
488
489void TRANSLINE_IDENT::ReadConfig()
490{
491 auto cfg = static_cast<PCB_CALCULATOR_SETTINGS*>( Kiface().KifaceSettings() );
492 std::string name( m_TLine->m_Name );
493
494 // Recover C_STRIPLINE data that legacy builds wrote under the colliding "Coupled_MicroStrip"
495 // key. Distinguish by the c_microstrip-exclusive parameters H_t and Rough; if absent, the
496 // payload is stripline and belongs to the new key.
497 // TODO remove after KiCad 10.1 (two stable releases)
498 if( name == "Coupled_Stripline" && !cfg->m_TransLine.param_values.count( name ) )
499 {
500 const std::string legacyKey = "Coupled_MicroStrip";
501 auto legacyValuesIt = cfg->m_TransLine.param_values.find( legacyKey );
502 auto legacyUnitsIt = cfg->m_TransLine.param_units.find( legacyKey );
503
504 // Require both maps to have the legacy entry so values and units stay paired; the
505 // downstream lookup asserts that param_units is populated whenever param_values is.
506 if( legacyValuesIt != cfg->m_TransLine.param_values.end()
507 && legacyUnitsIt != cfg->m_TransLine.param_units.end() )
508 {
509 const auto& legacyValues = legacyValuesIt->second;
510 const bool looksLikeCMicrostrip = legacyValues.count( "H_t" ) || legacyValues.count( "Rough" );
511
512 if( !looksLikeCMicrostrip )
513 {
514 cfg->m_TransLine.param_values[name] = legacyValues;
515 cfg->m_TransLine.param_units[name] = legacyUnitsIt->second;
516
517 // Empty the legacy entry in place so the coupled-microstrip tab falls back to
518 // defaults instead of loading stripline data under its normal key. The outer
519 // map entries must remain because PARAM_MAP holds a raw pointer to the inner
520 // map captured at settings-ctor time; erasing would dangle those pointers.
521 legacyValuesIt->second.clear();
522 legacyUnitsIt->second.clear();
523 }
524 else
525 {
526 wxLogTrace( wxT( "KICAD_TRANSLINE" ),
527 wxT( "Legacy Coupled_MicroStrip settings look like coupled-microstrip "
528 "data; Coupled_Stripline will fall back to defaults." ) );
529 }
530 }
531 }
532
533 if( cfg->m_TransLine.param_values.count( name ) )
534 {
535 wxASSERT( cfg->m_TransLine.param_units.count( name ) );
536
537 for( auto& p : m_prms_List )
538 {
539 try
540 {
541 p->m_Value = cfg->m_TransLine.param_values.at( name ).at( p->m_KeyWord );
542 p->m_UnitSelection = cfg->m_TransLine.param_units.at( name ).at( p->m_KeyWord );
543 }
544 catch( ... )
545 {}
546 }
547 }
548}
549
550
551void TRANSLINE_IDENT::WriteConfig()
552{
553 auto cfg = static_cast<PCB_CALCULATOR_SETTINGS*>( Kiface().KifaceSettings() );
554 std::string name( m_TLine->m_Name );
555
556 for( auto& param : m_prms_List )
557 {
558 if( !std::isfinite( param->m_Value ) )
559 param->m_Value = 0;
560
561 cfg->m_TransLine.param_values[ name ][ param->m_KeyWord ] = param->m_Value;
562 cfg->m_TransLine.param_units[ name ][ param->m_KeyWord ] = param->m_UnitSelection;
563 }
564}
565
name
const char * name
Definition DXF_plotter.cpp:65
Kiface
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
Definition bitmap2cmp_main.cpp:73
BITMAPS::microstrip
@ microstrip
Definition bitmaps_list.h:360
BITMAPS::stripline
@ stripline
Definition bitmaps_list.h:593
BITMAPS::twistedpair
@ twistedpair
Definition bitmaps_list.h:649
BITMAPS::c_microstrip
@ c_microstrip
Definition bitmaps_list.h:118
BITMAPS::coupled_stripline
@ coupled_stripline
Definition bitmaps_list.h:144
BITMAPS::INVALID_BITMAP
@ INVALID_BITMAP
Definition bitmaps_list.h:39
BITMAPS::rectwaveguide
@ rectwaveguide
Definition bitmaps_list.h:507
BITMAPS::cpw_back
@ cpw_back
Definition bitmaps_list.h:146
BITMAPS::cpw
@ cpw
Definition bitmaps_list.h:145
BITMAPS::coax
@ coax
Definition bitmaps_list.h:130
c_microstrip.h
c_stripline.h
COAX_UI
Definition pcb_calculator/transline/coax.h:34
COPLANAR_UI
UI wrapper for an ungrounded coplanar waveguide.
Definition pcb_calculator/transline/coplanar.h:39
C_MICROSTRIP
Definition c_microstrip.h:34
C_STRIPLINE
Definition c_stripline.h:29
GROUNDEDCOPLANAR_UI
UI wrapper for a conductor-backed coplanar waveguide.
Definition pcb_calculator/transline/coplanar.h:64
KIFACE_BASE::KifaceSettings
APP_SETTINGS_BASE * KifaceSettings() const
Definition kiface_base.h:95
MICROSTRIP_UI
Definition pcb_calculator/transline/microstrip.h:34
PCB_CALCULATOR_SETTINGS
Definition pcb_calculator_settings.h:43
RECTWAVEGUIDE_UI
UI wrapper for the rectangular waveguide calculator.
Definition pcb_calculator/transline/rectwaveguide.h:43
STRIPLINE_UI
Definition pcb_calculator/transline/stripline.h:33
TRANSLINE_IDENT::m_TLine
TRANSLINE * m_TLine
Definition transline_ident.h:135
TRANSLINE_IDENT::ReadConfig
void ReadConfig()
Definition transline_ident.cpp:489
TRANSLINE_IDENT::m_BitmapName
BITMAPS m_BitmapName
Definition transline_ident.h:134
TRANSLINE_IDENT::m_Type
enum TRANSLINE_TYPE_ID m_Type
Definition transline_ident.h:133
TRANSLINE_IDENT::~TRANSLINE_IDENT
~TRANSLINE_IDENT()
Definition transline_ident.cpp:478
TRANSLINE_IDENT::AddPrm
void AddPrm(TRANSLINE_PRM *aParam)
Definition transline_ident.h:111
TRANSLINE_IDENT::TRANSLINE_IDENT
TRANSLINE_IDENT(enum TRANSLINE_TYPE_ID aType)
Definition transline_ident.cpp:86
TRANSLINE_IDENT::WriteConfig
void WriteConfig()
Definition transline_ident.cpp:551
TRANSLINE_IDENT::m_Messages
wxArrayString m_Messages
Definition transline_ident.h:136
TRANSLINE_IDENT::m_HasPrmSelection
bool m_HasPrmSelection
Definition transline_ident.h:139
TRANSLINE_IDENT::m_prms_List
std::vector< TRANSLINE_PRM * > m_prms_List
Definition transline_ident.h:142
TRANSLINE_PRM
A class to handle one parameter of transline.
Definition transline_ident.h:65
TRANSLINE_PRM::m_ValueCtrl
void * m_ValueCtrl
Definition transline_ident.h:90
TRANSLINE_PRM::ToUserUnit
double ToUserUnit()
Definition transline_ident.cpp:68
TRANSLINE_PRM::TRANSLINE_PRM
TRANSLINE_PRM(PRM_TYPE aType, PRMS_ID aId, const char *aKeywordCfg="", const wxString &aDlgLabel=wxEmptyString, const wxString &aToolTip=wxEmptyString, double aValue=0.0, bool aConvUnit=false, int aDefaultUnit=0)
Definition transline_ident.cpp:49
TRANSLINE_PRM::m_Value
double m_Value
Definition transline_ident.h:85
TRANSLINE_PRM::m_Id
PRMS_ID m_Id
Definition transline_ident.h:81
TRANSLINE_PRM::m_Type
PRM_TYPE m_Type
Definition transline_ident.h:80
TRANSLINE_PRM::m_UnitCtrl
void * m_UnitCtrl
Definition transline_ident.h:91
TRANSLINE_PRM::m_DefaultValue
double m_DefaultValue
Definition transline_ident.h:86
TRANSLINE_PRM::m_ConvUnit
bool m_ConvUnit
Definition transline_ident.h:89
TRANSLINE_PRM::m_UnitSelection
int m_UnitSelection
Definition transline_ident.h:92
TRANSLINE_PRM::m_NormalizedValue
double m_NormalizedValue
Definition transline_ident.h:88
TRANSLINE_PRM::m_ToolTip
wxString m_ToolTip
Definition transline_ident.h:84
TRANSLINE_PRM::m_DefaultUnit
int m_DefaultUnit
Definition transline_ident.h:87
TRANSLINE_PRM::m_DlgLabel
wxString m_DlgLabel
Definition transline_ident.h:83
TRANSLINE_PRM::m_KeyWord
std::string m_KeyWord
Definition transline_ident.h:82
TRANSLINE_PRM::FromUserUnit
double FromUserUnit()
Definition transline_ident.cpp:77
TWISTEDPAIR_UI
UI wrapper for the twisted-pair calculator.
Definition pcb_calculator/transline/twistedpair.h:38
UNIT_SELECTOR
Definition unit_selector.h:35
_
#define _(s)
Definition eda_3d_actions.cpp:36
kiface_base.h
coax.h
coplanar.h
microstrip.h
rectwaveguide.h
stripline.h
twistedpair.h
pcb_calculator_settings.h
property_mgr.h
PRMS_ID
PRMS_ID
Definition transline.h:39
TWISTEDPAIR_EPSILONR_ENV_PRM
@ TWISTEDPAIR_EPSILONR_ENV_PRM
Definition transline.h:51
Z0_O_PRM
@ Z0_O_PRM
Definition transline.h:56
FREQUENCY_PRM
@ FREQUENCY_PRM
Definition transline.h:53
DUMMY_PRM
@ DUMMY_PRM
Definition transline.h:63
RHO_PRM
@ RHO_PRM
Definition transline.h:43
PHYS_DIAM_OUT_PRM
@ PHYS_DIAM_OUT_PRM
Definition transline.h:61
T_PRM
@ T_PRM
Definition transline.h:48
Z0_E_PRM
@ Z0_E_PRM
Definition transline.h:55
MURC_PRM
@ MURC_PRM
Definition transline.h:52
MUR_PRM
@ MUR_PRM
Definition transline.h:50
STRIPLINE_A_PRM
@ STRIPLINE_A_PRM
Definition transline.h:47
Z0_PRM
@ Z0_PRM
Definition transline.h:54
TAND_PRM
@ TAND_PRM
Definition transline.h:42
PHYS_LEN_PRM
@ PHYS_LEN_PRM
Definition transline.h:62
ANG_L_PRM
@ ANG_L_PRM
Definition transline.h:57
H_T_PRM
@ H_T_PRM
Definition transline.h:46
TWISTEDPAIR_TWIST_PRM
@ TWISTEDPAIR_TWIST_PRM
Definition transline.h:45
PHYS_DIAM_IN_PRM
@ PHYS_DIAM_IN_PRM
Definition transline.h:59
ROUGH_PRM
@ ROUGH_PRM
Definition transline.h:49
EPSILONR_PRM
@ EPSILONR_PRM
Definition transline.h:41
PHYS_S_PRM
@ PHYS_S_PRM
Definition transline.h:60
H_PRM
@ H_PRM
Definition transline.h:44
PHYS_WIDTH_PRM
@ PHYS_WIDTH_PRM
Definition transline.h:58
transline_ident.h
PRM_TYPE
PRM_TYPE
Definition transline_ident.h:53
PRM_TYPE_FREQUENCY
@ PRM_TYPE_FREQUENCY
Definition transline_ident.h:57
PRM_TYPE_SUBS
@ PRM_TYPE_SUBS
Definition transline_ident.h:54
PRM_TYPE_ELEC
@ PRM_TYPE_ELEC
Definition transline_ident.h:56
PRM_TYPE_PHYS
@ PRM_TYPE_PHYS
Definition transline_ident.h:55
TRANSLINE_TYPE_ID
TRANSLINE_TYPE_ID
Definition transline_ident.h:37
RECTWAVEGUIDE_TYPE
@ RECTWAVEGUIDE_TYPE
Definition transline_ident.h:46
MICROSTRIP_TYPE
@ MICROSTRIP_TYPE
Definition transline_ident.h:40
CPW_TYPE
@ CPW_TYPE
Definition transline_ident.h:44
GROUNDED_CPW_TYPE
@ GROUNDED_CPW_TYPE
Definition transline_ident.h:45
C_MICROSTRIP_TYPE
@ C_MICROSTRIP_TYPE
Definition transline_ident.h:41
COAX_TYPE
@ COAX_TYPE
Definition transline_ident.h:47
TWISTEDPAIR_TYPE
@ TWISTEDPAIR_TYPE
Definition transline_ident.h:48
END_OF_LIST_TYPE
@ END_OF_LIST_TYPE
Definition transline_ident.h:49
STRIPLINE_TYPE
@ STRIPLINE_TYPE
Definition transline_ident.h:42
C_STRIPLINE_TYPE
@ C_STRIPLINE_TYPE
Definition transline_ident.h:43
unit_selector.h