KiCad PCB EDA Suite
Loading...
Searching...
No Matches
odb_entity.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 The KiCad Developers, see AUTHORS.txt for contributors.
5 * Author: SYSUEric <[email protected]>.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * 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
21
22#include <base_units.h>
24#include <build_version.h>
25#include <callback_gal.h>
29#include <font/font.h>
30#include <footprint.h>
31#include <hash_eda.h>
32#include <pad.h>
33#include <pcb_dimension.h>
34#include <pcb_shape.h>
35#include <pcb_text.h>
36#include <pcb_textbox.h>
37#include <pcb_track.h>
38#include <pcbnew_settings.h>
40#include <pgm_base.h>
41#include <progress_reporter.h>
43#include <wx_fstream_progress.h>
44
49
50#include <wx/log.h>
51#include <wx/numformatter.h>
52#include <wx/mstream.h>
53
54#include "odb_attribute.h"
55#include "odb_entity.h"
56#include "odb_defines.h"
57#include "odb_feature.h"
58#include "odb_util.h"
59#include "pcb_io_odbpp.h"
60
61
63{
64 try
65 {
67 return true;
68 }
69 catch( const std::exception& e )
70 {
71 std::cerr << e.what() << std::endl;
72 return false;
73 }
74}
75
76
78{
79 m_info = { { wxS( ODB_JOB_NAME ), wxS( "job" ) },
81 { wxS( "ODB_VERSION_MAJOR" ), wxS( "8" ) },
82 { wxS( "ODB_VERSION_MINOR" ), wxS( "1" ) },
83 { wxS( "ODB_SOURCE" ), wxS( "KiCad EDA" ) },
84 { wxS( "CREATION_DATE" ), wxDateTime::Now().FormatISOCombined() },
85 { wxS( "SAVE_DATE" ), wxDateTime::Now().FormatISOCombined() },
86 { wxS( "SAVE_APP" ), wxString::Format( wxS( "KiCad EDA %s" ), GetBuildVersion() ) } };
87}
88
89
91{
92 auto fileproxy = writer.CreateFileProxy( "info" );
93
94 ODB_TEXT_WRITER twriter( fileproxy.GetStream() );
95
96 for( auto& info : m_info )
97 {
98 twriter.WriteEquationLine( info.first, info.second );
99 }
100}
101
102
103void ODB_MATRIX_ENTITY::AddStep( const wxString& aStepName )
104{
105 m_matrixSteps.emplace( aStepName.Upper(), m_col++ );
106}
107
108
110{
111 AddStep( "PCB" );
112
114}
115
116
118{
120 BOARD_STACKUP& stackup = dsnSettings.GetStackupDescriptor();
121 stackup.SynchronizeWithBoard( &dsnSettings );
122
123 std::vector<BOARD_STACKUP_ITEM*> layers = stackup.GetList();
124 std::set<PCB_LAYER_ID> added_layers;
125
127
128 for( int i = 0; i < stackup.GetCount(); i++ )
129 {
130 BOARD_STACKUP_ITEM* stackup_item = layers.at( i );
131
132 for( int sublayer_id = 0; sublayer_id < stackup_item->GetSublayersCount(); sublayer_id++ )
133 {
134 wxString ly_name = stackup_item->GetLayerName();
135
136 if( ly_name.IsEmpty() )
137 {
138 if( IsValidLayer( stackup_item->GetBrdLayerId() ) )
139 ly_name = m_board->GetLayerName( stackup_item->GetBrdLayerId() );
140
141 if( ly_name.IsEmpty() && stackup_item->GetType() == BS_ITEM_TYPE_DIELECTRIC )
142 ly_name = wxString::Format( "DIELECTRIC_%d",
143 stackup_item->GetDielectricLayerId() );
144 }
145
146 MATRIX_LAYER matrix( m_row++, ly_name );
147
148 if( stackup_item->GetType() == BS_ITEM_TYPE_DIELECTRIC )
149 {
150 if( stackup_item->GetTypeName() == KEY_CORE )
151 matrix.m_diType.emplace( ODB_DIELECTRIC_TYPE::CORE );
152 else
153 matrix.m_diType.emplace( ODB_DIELECTRIC_TYPE::PREPREG );
154
155 matrix.m_type = ODB_TYPE::DIELECTRIC;
156 matrix.m_context = ODB_CONTEXT::BOARD;
157 matrix.m_polarity = ODB_POLARITY::POSITIVE;
158 m_matrixLayers.push_back( matrix );
159 m_plugin->GetLayerNameList().emplace_back(
160 std::make_pair( PCB_LAYER_ID::UNDEFINED_LAYER, matrix.m_layerName ) );
161
162 continue;
163 }
164 else
165 {
166 added_layers.insert( stackup_item->GetBrdLayerId() );
167 AddMatrixLayerField( matrix, stackup_item->GetBrdLayerId() );
168 }
169 }
170 }
171
172 LSEQ layer_seq = m_board->GetEnabledLayers().Seq();
173
174 for( PCB_LAYER_ID layer : layer_seq )
175 {
176 if( added_layers.find( layer ) != added_layers.end() )
177 continue;
178
179 MATRIX_LAYER matrix( m_row++, m_board->GetLayerName( layer ) );
180 added_layers.insert( layer );
181 AddMatrixLayerField( matrix, layer );
182 }
183
185
187}
188
189
191{
192 aMLayer.m_polarity = ODB_POLARITY::POSITIVE;
193 aMLayer.m_context = ODB_CONTEXT::BOARD;
194 switch( aLayer )
195 {
196 case F_Paste:
197 case B_Paste: aMLayer.m_type = ODB_TYPE::SOLDER_PASTE; break;
198 case F_SilkS:
199 case B_SilkS: aMLayer.m_type = ODB_TYPE::SILK_SCREEN; break;
200 case F_Mask:
201 case B_Mask: aMLayer.m_type = ODB_TYPE::SOLDER_MASK; break;
202 case B_CrtYd:
203 case F_CrtYd:
204 case Edge_Cuts:
205 case B_Fab:
206 case F_Fab:
207 case F_Adhes:
208 case B_Adhes:
209 case Dwgs_User:
210 case Cmts_User:
211 case Eco1_User:
212 case Eco2_User:
213 case Margin:
214 case User_1:
215 case User_2:
216 case User_3:
217 case User_4:
218 case User_5:
219 case User_6:
220 case User_7:
221 case User_8:
222 case User_9:
223 case User_10:
224 case User_11:
225 case User_12:
226 case User_13:
227 case User_14:
228 case User_15:
229 case User_16:
230 case User_17:
231 case User_18:
232 case User_19:
233 case User_20:
234 case User_21:
235 case User_22:
236 case User_23:
237 case User_24:
238 case User_25:
239 case User_26:
240 case User_27:
241 case User_28:
242 case User_29:
243 case User_30:
244 case User_31:
245 case User_32:
246 case User_33:
247 case User_34:
248 case User_35:
249 case User_36:
250 case User_37:
251 case User_38:
252 case User_39:
253 case User_40:
254 case User_41:
255 case User_42:
256 case User_43:
257 case User_44:
258 case User_45:
259 aMLayer.m_context = ODB_CONTEXT::MISC;
260 aMLayer.m_type = ODB_TYPE::DOCUMENT;
261 break;
262
263 default:
264 if( IsCopperLayer( aLayer ) )
265 {
266 aMLayer.m_type = ODB_TYPE::SIGNAL;
267 }
268 else
269 {
270 // Do not handle other layers :
271 aMLayer.m_type = ODB_TYPE::UNDEFINED;
272 m_row--;
273 }
274
275 break;
276 }
277
278 if( aMLayer.m_type != ODB_TYPE::UNDEFINED )
279 {
280 m_matrixLayers.push_back( aMLayer );
281 m_plugin->GetLayerNameList().emplace_back( std::make_pair( aLayer, aMLayer.m_layerName ) );
282 }
283}
284
285
287{
288 std::map<std::pair<PCB_LAYER_ID, PCB_LAYER_ID>, std::vector<BOARD_ITEM*>>& drill_layers =
290
291 std::map<std::pair<PCB_LAYER_ID, PCB_LAYER_ID>, std::vector<BOARD_ITEM*>>& slot_holes =
293
294 bool has_pth_layer = false;
295 bool has_npth_layer = false;
296
297 for( BOARD_ITEM* item : m_board->Tracks() )
298 {
299 if( item->Type() == PCB_VIA_T )
300 {
301 PCB_VIA* via = static_cast<PCB_VIA*>( item );
302 drill_layers[std::make_pair( via->TopLayer(), via->BottomLayer() )].push_back( via );
303 }
304 }
305
306 for( FOOTPRINT* fp : m_board->Footprints() )
307 {
308 // std::shared_ptr<FOOTPRINT> fp( static_cast<FOOTPRINT*>( it_fp->Clone() ) );
309
310 if( fp->IsFlipped() )
311 {
312 m_hasBotComp = true;
313 }
314
315 for( PAD* pad : fp->Pads() )
316 {
317 if( !has_pth_layer && pad->GetAttribute() == PAD_ATTRIB::PTH )
318 has_pth_layer = true;
319 if( !has_npth_layer && pad->GetAttribute() == PAD_ATTRIB::NPTH )
320 has_npth_layer = true;
321
322 if( pad->HasHole() && pad->GetDrillSizeX() != pad->GetDrillSizeY() )
323 slot_holes[std::make_pair( F_Cu, B_Cu )].push_back( pad );
324 else if( pad->HasHole() )
325 drill_layers[std::make_pair( F_Cu, B_Cu )].push_back( pad );
326 }
327
328 // m_plugin->GetLoadedFootprintList().push_back( std::move( fp ) );
329 }
330
331 auto InitDrillMatrix =
332 [&]( const wxString& aHasPlated, std::pair<PCB_LAYER_ID, PCB_LAYER_ID> aLayerPair )
333 {
334 wxString dLayerName = wxString::Format( "drill_%s_%s-%s", aHasPlated,
335 m_board->GetLayerName( aLayerPair.first ),
336 m_board->GetLayerName( aLayerPair.second ) );
337 MATRIX_LAYER matrix( m_row++, dLayerName );
338
339 matrix.m_type = ODB_TYPE::DRILL;
340 matrix.m_context = ODB_CONTEXT::BOARD;
341 matrix.m_polarity = ODB_POLARITY::POSITIVE;
342 matrix.m_span.emplace( std::make_pair(
343 ODB::GenLegalEntityName( m_board->GetLayerName( aLayerPair.first ) ),
344 ODB::GenLegalEntityName( m_board->GetLayerName( aLayerPair.second ) ) ) );
345 m_matrixLayers.push_back( matrix );
346 m_plugin->GetLayerNameList().emplace_back(
347 std::make_pair( PCB_LAYER_ID::UNDEFINED_LAYER, matrix.m_layerName ) );
348 };
349
350 if( drill_layers.find( std::make_pair( F_Cu, B_Cu ) ) != drill_layers.end()
351 || !slot_holes.empty() )
352 {
353 // for pad has hole
354 if( has_pth_layer )
355 InitDrillMatrix( "plated", std::make_pair( F_Cu, B_Cu ) );
356 if( has_npth_layer )
357 InitDrillMatrix( "non-plated", std::make_pair( F_Cu, B_Cu ) );
358 }
359
360 for( const auto& [layer_pair, vec] : drill_layers )
361 {
362 if( layer_pair != std::make_pair( F_Cu, B_Cu ) ) // pad has initialized above
363 InitDrillMatrix( "plated", layer_pair ); // for via
364 }
365}
366
367
369{
370 MATRIX_LAYER matrix( m_row++, "COMP_+_TOP" );
371 matrix.m_type = ODB_TYPE::COMPONENT;
372 matrix.m_context = ODB_CONTEXT::BOARD;
373
374 if( aCompSide == F_Cu )
375 {
376 m_matrixLayers.push_back( matrix );
377 m_plugin->GetLayerNameList().emplace_back(
378 std::make_pair( PCB_LAYER_ID::UNDEFINED_LAYER, matrix.m_layerName ) );
379 }
380
381 if( aCompSide == B_Cu && m_hasBotComp )
382 {
383 matrix.m_layerName = ODB::GenLegalEntityName( "COMP_+_BOT" );
384 m_matrixLayers.push_back( matrix );
385 m_plugin->GetLayerNameList().emplace_back(
386 std::make_pair( PCB_LAYER_ID::UNDEFINED_LAYER, matrix.m_layerName ) );
387 }
388}
389
390
392{
393 auto fileproxy = writer.CreateFileProxy( "matrix" );
394
395 ODB_TEXT_WRITER twriter( fileproxy.GetStream() );
396
397 for( const auto& [step_name, column] : m_matrixSteps )
398 {
399 const auto array_proxy = twriter.MakeArrayProxy( "STEP" );
400 twriter.WriteEquationLine( "COL", column );
401 twriter.WriteEquationLine( "NAME", step_name );
402 }
403
404 for( const MATRIX_LAYER& layer : m_matrixLayers )
405 {
406 const auto array_proxy = twriter.MakeArrayProxy( "LAYER" );
407 twriter.WriteEquationLine( "ROW", layer.m_rowNumber );
408 twriter.write_line_enum( "CONTEXT", layer.m_context );
409 twriter.write_line_enum( "TYPE", layer.m_type );
410
411 if( layer.m_addType.has_value() )
412 {
413 twriter.write_line_enum( "ADD_TYPE", layer.m_addType.value() );
414 }
415
416 twriter.WriteEquationLine( "NAME", layer.m_layerName.Upper() );
417 twriter.WriteEquationLine( "OLD_NAME", wxEmptyString );
418 twriter.write_line_enum( "POLARITY", layer.m_polarity );
419
420 if( layer.m_diType.has_value() )
421 {
422 twriter.write_line_enum( "DIELECTRIC_TYPE", layer.m_diType.value() );
423 // twriter.WriteEquationLine( "DIELECTRIC_NAME", wxEmptyString );
424
425 // Can be used with DIELECTRIC_TYPE=CORE
426 // twriter.WriteEquationLine( "CU_TOP", wxEmptyString );
427 // twriter.WriteEquationLine( "CU_BOTTOM", wxEmptyString );
428 }
429
430 // Only applies to: soldermask, silkscreen, solderpaste and specifies the relevant cu layer
431 // twriter.WriteEquationLine( "REF", wxEmptyString );
432
433 if( layer.m_span.has_value() )
434 {
435 twriter.WriteEquationLine( "START_NAME", layer.m_span->first.Upper() );
436 twriter.WriteEquationLine( "END_NAME", layer.m_span->second.Upper() );
437 }
438
439 twriter.WriteEquationLine( "COLOR", "0" );
440 }
441}
442
443
445 std::map<int, std::vector<BOARD_ITEM*>>& aMap,
446 const PCB_LAYER_ID& aLayerID, const wxString& aLayerName ) :
447 ODB_ENTITY_BASE( aBoard, aPlugin ), m_layerItems( aMap ), m_layerID( aLayerID ),
448 m_matrixLayerName( aLayerName )
449{
450 m_featuresMgr = std::make_unique<FEATURES_MANAGER>( aBoard, aPlugin, aLayerName );
451}
452
453
455{
456 if( m_matrixLayerName.Contains( "drill" ) )
457 {
460 return;
461 }
462
463 if( m_layerID != PCB_LAYER_ID::UNDEFINED_LAYER )
464 {
466 }
467}
468
470{
471 if( m_layerItems.empty() )
472 return;
473
474 const NETINFO_LIST& nets = m_board->GetNetInfo();
475
476 for( const NETINFO_ITEM* net : nets )
477 {
478 std::vector<BOARD_ITEM*>& vec = m_layerItems[net->GetNetCode()];
479
480 std::stable_sort( vec.begin(), vec.end(),
481 []( BOARD_ITEM* a, BOARD_ITEM* b )
482 {
483 if( a->GetParentFootprint() == b->GetParentFootprint() )
484 return a->Type() < b->Type();
485
486 return a->GetParentFootprint() < b->GetParentFootprint();
487 } );
488
489 if( vec.empty() )
490 continue;
491
492 m_featuresMgr->InitFeatureList( m_layerID, vec );
493 }
494}
495
496
498 const EDA_DATA::PACKAGE& aPkg )
499{
500 if( m_matrixLayerName == "COMP_+_BOT" )
501 {
502 if( !m_compBot.has_value() )
503 {
504 m_compBot.emplace();
505 }
506 return m_compBot.value().AddComponent( aFp, aPkg );
507 }
508 else
509 {
510 if( !m_compTop.has_value() )
511 {
512 m_compTop.emplace();
513 }
514
515 return m_compTop.value().AddComponent( aFp, aPkg );
516 }
517}
518
519
521{
522 std::map<std::pair<PCB_LAYER_ID, PCB_LAYER_ID>, std::vector<BOARD_ITEM*>>& drill_layers =
524
525 std::map<std::pair<PCB_LAYER_ID, PCB_LAYER_ID>, std::vector<BOARD_ITEM*>>& slot_holes =
527
528 if( !m_layerItems.empty() )
529 {
530 m_layerItems.clear();
531 }
532
534
535 bool is_npth_layer = false;
536 wxString plated_name = "plated";
537
538 if( m_matrixLayerName.Contains( "non-plated" ) )
539 {
540 is_npth_layer = true;
541 plated_name = "non-plated";
542 }
543
544
545 for( const auto& [layer_pair, vec] : slot_holes )
546 {
547 wxString dLayerName = wxString::Format( "drill_%s_%s-%s", plated_name,
548 m_board->GetLayerName( layer_pair.first ),
549 m_board->GetLayerName( layer_pair.second ) );
550
551 if( ODB::GenLegalEntityName( dLayerName ) == m_matrixLayerName )
552 {
553 for( BOARD_ITEM* item : vec )
554 {
555 if( item->Type() == PCB_PAD_T )
556 {
557 PAD* pad = static_cast<PAD*>( item );
558
559 if( ( is_npth_layer && pad->GetAttribute() == PAD_ATTRIB::PTH )
560 || ( !is_npth_layer && pad->GetAttribute() == PAD_ATTRIB::NPTH ) )
561 {
562 continue;
563 }
564
565 m_tools.value().AddDrillTools(
566 pad->GetAttribute() == PAD_ATTRIB::PTH ? "PLATED" : "NON_PLATED",
568 std::min( pad->GetDrillSizeX(), pad->GetDrillSizeY() ) ) );
569
570 // for drill features
571 m_layerItems[pad->GetNetCode()].push_back( item );
572 }
573 }
574
575 break;
576 }
577 }
578
579 for( const auto& [layer_pair, vec] : drill_layers )
580 {
581 wxString dLayerName = wxString::Format( "drill_%s_%s-%s", plated_name,
582 m_board->GetLayerName( layer_pair.first ),
583 m_board->GetLayerName( layer_pair.second ) );
584
585 if( ODB::GenLegalEntityName( dLayerName ) == m_matrixLayerName )
586 {
587 for( BOARD_ITEM* item : vec )
588 {
589 if( item->Type() == PCB_VIA_T && !is_npth_layer )
590 {
591 PCB_VIA* via = static_cast<PCB_VIA*>( item );
592
593 m_tools.value().AddDrillTools( "VIA",
594 ODB::SymDouble2String( via->GetDrillValue() ) );
595
596 // for drill features
597 m_layerItems[via->GetNetCode()].push_back( item );
598 }
599 else if( item->Type() == PCB_PAD_T )
600 {
601 PAD* pad = static_cast<PAD*>( item );
602
603 if( ( is_npth_layer && pad->GetAttribute() == PAD_ATTRIB::PTH )
604 || ( !is_npth_layer && pad->GetAttribute() == PAD_ATTRIB::NPTH ) )
605 {
606 continue;
607 }
608
609 m_tools.value().AddDrillTools(
610 pad->GetAttribute() == PAD_ATTRIB::PTH ? "PLATED" : "NON_PLATED",
611 ODB::SymDouble2String( pad->GetDrillSizeX() ) );
612
613 // for drill features
614 m_layerItems[pad->GetNetCode()].push_back( item );
615 }
616 }
617
618 break;
619 }
620 }
621}
622
623
625{
627
628 InitEdaData();
629
630 // Init Layer Entity Data
631 for( const auto& [layerName, layer_entity_ptr] : m_layerEntityMap )
632 {
633 layer_entity_ptr->InitEntityData();
634 }
635}
636
637
639{
640 GenAttrList( writer );
641
642 GenFeatures( writer );
643
644 if( m_compTop.has_value() || m_compBot.has_value() )
645 {
646 GenComponents( writer );
647 }
648
649 if( m_tools.has_value() )
650 {
651 GenTools( writer );
652 }
653}
654
655
657{
658 auto fileproxy = writer.CreateFileProxy( "components" );
659
660 if( m_compTop.has_value() )
661 {
662 m_compTop->Write( fileproxy.GetStream() );
663 }
664 else if( m_compBot.has_value() )
665 {
666 m_compBot->Write( fileproxy.GetStream() );
667 }
668}
669
670
672{
673 auto fileproxy = writer.CreateFileProxy( "features" );
674
675 m_featuresMgr->GenerateFeatureFile( fileproxy.GetStream() );
676}
677
678
680{
681 auto fileproxy = writer.CreateFileProxy( "attrlist" );
682}
683
684
686{
687 auto fileproxy = writer.CreateFileProxy( "tools" );
688
689 m_tools.value().GenerateFile( fileproxy.GetStream() );
690}
691
692
694{
695 //InitPackage
696 for( const FOOTPRINT* fp : m_board->Footprints() )
697 {
698 m_edaData.AddPackage( fp );
699 }
700
701 // for NET
702 const NETINFO_LIST& nets = m_board->GetNetInfo();
703
704 for( const NETINFO_ITEM* net : nets )
705 {
706 m_edaData.AddNET( net );
707 }
708
709 // for CMP
710 size_t j = 0;
711
712 for( const FOOTPRINT* fp : m_board->Footprints() )
713 {
714 wxString compName = ODB::GenLegalEntityName( "COMP_+_TOP" );
715 if( fp->IsFlipped() )
716 compName = ODB::GenLegalEntityName( "COMP_+_BOT" );
717
718 auto iter = m_layerEntityMap.find( compName );
719
720 if( iter == m_layerEntityMap.end() )
721 {
722 wxLogError( _( "Failed to add component data" ) );
723 return;
724 }
725
726 // ODBPP only need unique PACKAGE in PKG record in eda/data file.
727 // the PKG index can repeat to be ref in CMP record in component file.
728 std::shared_ptr<FOOTPRINT> fp_pkg = m_edaData.GetEdaFootprints().at( j );
729 ++j;
730
731 const EDA_DATA::PACKAGE& eda_pkg =
732 m_edaData.GetPackage( hash_fp_item( fp_pkg.get(), HASH_POS | REL_COORD ) );
733
734 ODB_COMPONENT& comp = iter->second->InitComponentData( fp, eda_pkg );
735
736 for( int i = 0; i < fp->Pads().size(); ++i )
737 {
738 PAD* pad = fp->Pads()[i];
739 auto& eda_net = m_edaData.GetNet( pad->GetNetCode() );
740
741 auto& subnet = eda_net.AddSubnet<EDA_DATA::SUB_NET_TOEPRINT>(
742 &m_edaData,
745 comp.m_index, comp.m_toeprints.size() );
746
747 m_plugin->GetPadSubnetMap().emplace( pad, &subnet );
748
749 const std::shared_ptr<EDA_DATA::PIN> pin = eda_pkg.GetEdaPkgPin( i );
750 const EDA_DATA::PIN& pin_ref = *pin;
751 auto& toep = comp.m_toeprints.emplace_back( pin_ref );
752
753 toep.m_net_num = eda_net.m_index;
754 toep.m_subnet_num = subnet.m_index;
755
756 toep.m_center = ODB::AddXY( pad->GetPosition() );
757
758 toep.m_rot = ODB::Double2String(
759 ( ANGLE_360 - pad->GetOrientation() ).Normalize().AsDegrees() );
760
761 if( pad->IsFlipped() )
762 toep.m_mirror = wxT( "M" );
763 else
764 toep.m_mirror = wxT( "N" );
765 }
766 }
767
768 for( PCB_TRACK* track : m_board->Tracks() )
769 {
770 auto& eda_net = m_edaData.GetNet( track->GetNetCode() );
771 EDA_DATA::SUB_NET* subnet = nullptr;
772
773 if( track->Type() == PCB_VIA_T )
774 subnet = &( eda_net.AddSubnet<EDA_DATA::SUB_NET_VIA>( &m_edaData ) );
775 else
776 subnet = &( eda_net.AddSubnet<EDA_DATA::SUB_NET_TRACE>( &m_edaData ) );
777
778 m_plugin->GetViaTraceSubnetMap().emplace( track, subnet );
779 }
780
781 for( ZONE* zone : m_board->Zones() )
782 {
783 for( PCB_LAYER_ID layer : zone->GetLayerSet().Seq() )
784 {
785 auto& eda_net = m_edaData.GetNet( zone->GetNetCode() );
786 auto& subnet = eda_net.AddSubnet<EDA_DATA::SUB_NET_PLANE>(
789 m_plugin->GetPlaneSubnetMap().emplace( std::piecewise_construct,
790 std::forward_as_tuple( layer, zone ),
791 std::forward_as_tuple( &subnet ) );
792 }
793 }
794}
795
796
798{
799 wxString step_root = writer.GetCurrentPath();
800
801 writer.CreateEntityDirectory( step_root, "layers" );
802 GenerateLayerFiles( writer );
803
804 writer.CreateEntityDirectory( step_root, "eda" );
805 GenerateEdaFiles( writer );
806
807 writer.CreateEntityDirectory( step_root, "netlists/cadnet" );
808 GenerateNetlistsFiles( writer );
809
810 writer.SetCurrentPath( step_root );
811 GenerateProfileFile( writer );
812
813 GenerateStepHeaderFile( writer );
814
815 //TODO: system attributes
816 // GenerateAttrListFile( writer );
817}
818
819
821{
822 auto fileproxy = writer.CreateFileProxy( "profile" );
823
824 m_profile = std::make_unique<FEATURES_MANAGER>( m_board, m_plugin, wxEmptyString );
825
826 SHAPE_POLY_SET board_outline;
827
828 if( !m_board->GetBoardPolygonOutlines( board_outline ) )
829 {
830 wxLogError( "Failed to get board outline" );
831 }
832
833 if( !m_profile->AddContour( board_outline, 0 ) )
834 {
835 wxLogError( "Failed to add polygon to profile" );
836 }
837
838 m_profile->GenerateProfileFeatures( fileproxy.GetStream() );
839}
840
841
843{
844 auto fileproxy = writer.CreateFileProxy( "stephdr" );
845
846 m_stephdr = {
848 { "X_DATUM", "0" },
849 { "Y_DATUM", "0" },
850 { "X_ORIGIN", "0" },
851 { "Y_ORIGIN", "0" },
852 { "TOP_ACTIVE", "0" },
853 { "BOTTOM_ACTIVE", "0" },
854 { "RIGHT_ACTIVE", "0" },
855 { "LEFT_ACTIVE", "0" },
856 { "AFFECTING_BOM", "" },
857 { "AFFECTING_BOM_CHANGED", "0" },
858 };
859
860 ODB_TEXT_WRITER twriter( fileproxy.GetStream() );
861
862 for( const auto& [key, value] : m_stephdr )
863 {
864 twriter.WriteEquationLine( key, value );
865 }
866}
867
868
870{
871 wxString layers_root = writer.GetCurrentPath();
872
873 for( auto& [layerName, layerEntity] : m_layerEntityMap )
874 {
875 writer.CreateEntityDirectory( layers_root, layerName );
876
877 layerEntity->GenerateFiles( writer );
878 }
879}
880
881
883{
884 auto fileproxy = writer.CreateFileProxy( "data" );
885
886 m_edaData.Write( fileproxy.GetStream() );
887}
888
889
891{
892 auto fileproxy = writer.CreateFileProxy( "netlist" );
893
894 m_netlist.Write( fileproxy.GetStream() );
895}
896
897
899{
900 try
901 {
902 writer.CreateEntityDirectory( writer.GetRootPath(), "steps" );
904 return true;
905 }
906 catch( const std::exception& e )
907 {
908 std::cerr << e.what() << std::endl;
909 return false;
910 }
911}
912
913
915{
916 LSEQ layers = m_board->GetEnabledLayers().Seq();
917 const NETINFO_LIST& nets = m_board->GetNetInfo();
918
919 // To avoid the overhead of repeatedly cycling through the layers and nets,
920 // we pre-sort the board items into a map of layer -> net -> items
921 std::map<PCB_LAYER_ID, std::map<int, std::vector<BOARD_ITEM*>>>& elements =
923
924 std::for_each( m_board->Tracks().begin(), m_board->Tracks().end(),
925 [&layers, &elements]( PCB_TRACK* aTrack )
926 {
927 if( aTrack->Type() == PCB_VIA_T )
928 {
929 PCB_VIA* via = static_cast<PCB_VIA*>( aTrack );
930
931 for( PCB_LAYER_ID layer : layers )
932 {
933 if( via->FlashLayer( layer ) )
934 elements[layer][via->GetNetCode()].push_back( via );
935 }
936 }
937 else
938 {
939 elements[aTrack->GetLayer()][aTrack->GetNetCode()].push_back( aTrack );
940 }
941 } );
942
943 std::for_each( m_board->Zones().begin(), m_board->Zones().end(),
944 [&elements]( ZONE* zone )
945 {
946 LSEQ zone_layers = zone->GetLayerSet().Seq();
947
948 for( PCB_LAYER_ID layer : zone_layers )
949 {
950 elements[layer][zone->GetNetCode()].push_back( zone );
951 }
952 } );
953
954 for( BOARD_ITEM* item : m_board->Drawings() )
955 {
956 if( BOARD_CONNECTED_ITEM* conn_it = dynamic_cast<BOARD_CONNECTED_ITEM*>( item ) )
957 elements[conn_it->GetLayer()][conn_it->GetNetCode()].push_back( conn_it );
958 else
959 elements[item->GetLayer()][0].push_back( item );
960 }
961
962 for( FOOTPRINT* fp : m_board->Footprints() )
963 {
964 for( PCB_FIELD* field : fp->GetFields() )
965 elements[field->GetLayer()][0].push_back( field );
966
967 for( BOARD_ITEM* item : fp->GraphicalItems() )
968 elements[item->GetLayer()][0].push_back( item );
969
970 for( PAD* pad : fp->Pads() )
971 {
972 LSEQ pad_layers = pad->GetLayerSet().Seq();
973 VECTOR2I margin;
974
975 for( PCB_LAYER_ID layer : pad_layers )
976 {
977 bool onCopperLayer = ( LSET::AllCuMask() & LSET( { layer } ) ).any();
978 bool onSolderMaskLayer = ( LSET( { F_Mask, B_Mask } ) & LSET( { layer } ) ).any();
979 bool onSolderPasteLayer =
980 ( LSET( { F_Paste, B_Paste } ) & LSET( { layer } ) ).any();
981
982 if( onSolderMaskLayer )
983 margin.x = margin.y = pad->GetSolderMaskExpansion( PADSTACK::ALL_LAYERS );
984
985 if( onSolderPasteLayer )
986 margin = pad->GetSolderPasteMargin( PADSTACK::ALL_LAYERS );
987
988 VECTOR2I padPlotsSize = pad->GetSize( PADSTACK::ALL_LAYERS ) + margin * 2;
989
990 if( onCopperLayer && !pad->IsOnCopperLayer() )
991 continue;
992
993 if( onCopperLayer && !pad->FlashLayer( layer ) )
994 continue;
995
996 if( pad->GetShape( PADSTACK::ALL_LAYERS ) != PAD_SHAPE::CUSTOM
997 && ( padPlotsSize.x <= 0 || padPlotsSize.y <= 0 ) )
998 continue;
999
1000 elements[layer][pad->GetNetCode()].push_back( pad );
1001 }
1002 }
1003 }
1004
1005 for( const auto& [layerID, layerName] : m_plugin->GetLayerNameList() )
1006 {
1007 std::shared_ptr<ODB_LAYER_ENTITY> layer_entity_ptr = std::make_shared<ODB_LAYER_ENTITY>(
1008 m_board, m_plugin, elements[layerID], layerID, layerName );
1009
1010 m_layerEntityMap.emplace( layerName, layer_entity_ptr );
1011 }
1012}
@ BS_ITEM_TYPE_DIELECTRIC
Definition: board_stackup.h:46
wxString GetBuildVersion()
Get the full KiCad version string.
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
Container for design settings for a BOARD object.
BOARD_STACKUP & GetStackupDescriptor()
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
Manage one layer needed to make a physical board.
Definition: board_stackup.h:96
wxString GetTypeName() const
int GetSublayersCount() const
wxString GetLayerName() const
PCB_LAYER_ID GetBrdLayerId() const
BOARD_STACKUP_ITEM_TYPE GetType() const
int GetDielectricLayerId() const
Manage layers needed to make a physical board.
const std::vector< BOARD_STACKUP_ITEM * > & GetList() const
int GetCount() const
bool SynchronizeWithBoard(BOARD_DESIGN_SETTINGS *aSettings)
Synchronize the BOARD_STACKUP_ITEM* list with the board.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:295
bool GetBoardPolygonOutlines(SHAPE_POLY_SET &aOutlines, OUTLINE_ERROR_HANDLER *aErrorHandler=nullptr, bool aAllowUseArcsInPolygons=false, bool aIncludeNPTHAsOutlines=false)
Extract the board outlines and build a closed polygon from lines, arcs and circle items on edge cut l...
Definition: board.cpp:2567
const NETINFO_LIST & GetNetInfo() const
Definition: board.h:888
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:831
const ZONES & Zones() const
Definition: board.h:340
const FOOTPRINTS & Footprints() const
Definition: board.h:336
const TRACKS & Tracks() const
Definition: board.h:334
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:616
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:948
T & AddSubnet(Args &&... args)
Definition: odb_eda_data.h:160
const std::shared_ptr< PIN > GetEdaPkgPin(size_t aPadIndex) const
Definition: odb_eda_data.h:241
NET & GetNet(size_t aNetcode)
Definition: odb_eda_data.h:172
const PACKAGE & GetPackage(size_t aHash) const
Definition: odb_eda_data.h:253
void AddNET(const NETINFO_ITEM *aNet)
void AddPackage(const FOOTPRINT *aFp)
void Write(std::ostream &ost) const
std::vector< std::shared_ptr< FOOTPRINT > > GetEdaFootprints() const
Definition: odb_eda_data.h:40
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
Definition: lseq.h:47
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:564
LSEQ Seq(const LSEQ &aSequence) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:297
Handle the data for a net.
Definition: netinfo.h:56
Container for NETINFO_ITEM elements, which are the nets.
Definition: netinfo.h:346
const size_t m_index
! CMP index number on board to be used in SNT(TOP), 0~n-1
Definition: odb_component.h:53
std::list< TOEPRINT > m_toeprints
Definition: odb_component.h:93
virtual std::string GetEntityName()=0
virtual bool CreateDirectoryTree(ODB_TREE_WRITER &writer)
Definition: odb_entity.cpp:62
BOARD * m_board
Definition: odb_entity.h:59
PCB_IO_ODBPP * m_plugin
Definition: odb_entity.h:61
void GenFeatures(ODB_TREE_WRITER &writer)
Definition: odb_entity.cpp:671
PCB_LAYER_ID m_layerID
Definition: odb_entity.h:204
void InitFeatureData()
Definition: odb_entity.cpp:469
void GenComponents(ODB_TREE_WRITER &writer)
Definition: odb_entity.cpp:656
wxString m_matrixLayerName
Definition: odb_entity.h:205
std::optional< COMPONENTS_MANAGER > m_compTop
Definition: odb_entity.h:208
virtual void GenerateFiles(ODB_TREE_WRITER &writer) override
Definition: odb_entity.cpp:638
std::optional< COMPONENTS_MANAGER > m_compBot
Definition: odb_entity.h:209
std::optional< ODB_DRILL_TOOLS > m_tools
Definition: odb_entity.h:207
void GenTools(ODB_TREE_WRITER &writer)
Definition: odb_entity.cpp:685
std::map< int, std::vector< BOARD_ITEM * > > m_layerItems
Definition: odb_entity.h:203
ODB_LAYER_ENTITY(BOARD *aBoard, PCB_IO_ODBPP *aPlugin, std::map< int, std::vector< BOARD_ITEM * > > &aMap, const PCB_LAYER_ID &aLayerID, const wxString &aLayerName)
Definition: odb_entity.cpp:444
ODB_COMPONENT & InitComponentData(const FOOTPRINT *aFp, const EDA_DATA::PACKAGE &aPkg)
Definition: odb_entity.cpp:497
virtual void InitEntityData() override
Definition: odb_entity.cpp:454
void GenAttrList(ODB_TREE_WRITER &writer)
Definition: odb_entity.cpp:679
std::unique_ptr< FEATURES_MANAGER > m_featuresMgr
Definition: odb_entity.h:210
void AddStep(const wxString &aStepName)
Definition: odb_entity.cpp:103
unsigned int m_col
Definition: odb_entity.h:111
void InitMatrixLayerData()
Definition: odb_entity.cpp:117
std::vector< MATRIX_LAYER > m_matrixLayers
Definition: odb_entity.h:109
void AddMatrixLayerField(MATRIX_LAYER &aMLayer, PCB_LAYER_ID aLayer)
Definition: odb_entity.cpp:190
virtual void GenerateFiles(ODB_TREE_WRITER &writer) override
Definition: odb_entity.cpp:391
std::map< wxString, unsigned int > m_matrixSteps
Definition: odb_entity.h:108
unsigned int m_row
Definition: odb_entity.h:110
void AddDrillMatrixLayer()
Definition: odb_entity.cpp:286
virtual void InitEntityData() override
Definition: odb_entity.cpp:109
void AddCOMPMatrixLayer(PCB_LAYER_ID aCompSide)
Definition: odb_entity.cpp:368
std::map< wxString, wxString > m_info
Definition: odb_entity.h:128
virtual void GenerateFiles(ODB_TREE_WRITER &writer) override
Definition: odb_entity.cpp:90
void Write(std::ostream &aStream)
virtual std::string GetEntityName() override
Definition: odb_entity.h:144
std::unordered_map< wxString, wxString > m_stephdr
Definition: odb_entity.h:171
void GenerateProfileFile(ODB_TREE_WRITER &writer)
Definition: odb_entity.cpp:820
EDA_DATA m_edaData
Definition: odb_entity.h:170
void GenerateStepHeaderFile(ODB_TREE_WRITER &writer)
Definition: odb_entity.cpp:842
void GenerateEdaFiles(ODB_TREE_WRITER &writer)
Definition: odb_entity.cpp:882
virtual void InitEntityData() override
Definition: odb_entity.cpp:624
void GenerateLayerFiles(ODB_TREE_WRITER &writer)
Definition: odb_entity.cpp:869
std::map< wxString, std::shared_ptr< ODB_LAYER_ENTITY > > m_layerEntityMap
Definition: odb_entity.h:167
ODB_NET_LIST m_netlist
Definition: odb_entity.h:172
std::unique_ptr< FEATURES_MANAGER > m_profile
Definition: odb_entity.h:168
virtual bool CreateDirectoryTree(ODB_TREE_WRITER &writer) override
Definition: odb_entity.cpp:898
void GenerateNetlistsFiles(ODB_TREE_WRITER &writer)
Definition: odb_entity.cpp:890
void MakeLayerEntity()
Definition: odb_entity.cpp:914
virtual void GenerateFiles(ODB_TREE_WRITER &writer) override
Definition: odb_entity.cpp:797
void WriteEquationLine(const std::string &var, int value)
Definition: odb_util.cpp:285
ARRAY_PROXY MakeArrayProxy(const std::string &aStr)
Definition: odb_util.h:301
void write_line_enum(const std::string &var, const T &value)
Definition: odb_util.h:275
const wxString GetRootPath() const
Definition: odb_util.h:256
void CreateEntityDirectory(const wxString &aPareDir, const wxString &aSubDir=wxEmptyString)
Definition: odb_util.cpp:206
ODB_FILE_WRITER CreateFileProxy(const wxString &aFileName)
Definition: odb_util.h:243
void SetCurrentPath(const wxString &aDir)
Definition: odb_util.h:252
const wxString GetCurrentPath() const
Definition: odb_util.h:250
static constexpr PCB_LAYER_ID ALL_LAYERS
! Temporary layer identifier to identify code that is not padstack-aware
Definition: padstack.h:144
Definition: pad.h:54
std::map< std::pair< PCB_LAYER_ID, ZONE * >, EDA_DATA::SUB_NET_PLANE * > & GetPlaneSubnetMap()
Definition: pcb_io_odbpp.h:119
std::map< PCB_TRACK *, EDA_DATA::SUB_NET * > & GetViaTraceSubnetMap()
Definition: pcb_io_odbpp.h:124
std::vector< std::pair< PCB_LAYER_ID, wxString > > & GetLayerNameList()
Definition: pcb_io_odbpp.h:87
std::map< std::pair< PCB_LAYER_ID, PCB_LAYER_ID >, std::vector< BOARD_ITEM * > > & GetSlotHolesMap()
Definition: pcb_io_odbpp.h:109
std::map< const PAD *, EDA_DATA::SUB_NET_TOEPRINT * > & GetPadSubnetMap()
Definition: pcb_io_odbpp.h:114
std::map< PCB_LAYER_ID, std::map< int, std::vector< BOARD_ITEM * > > > & GetLayerElementsMap()
Definition: pcb_io_odbpp.h:92
static std::string m_unitsStr
Definition: pcb_io_odbpp.h:144
std::map< std::pair< PCB_LAYER_ID, PCB_LAYER_ID >, std::vector< BOARD_ITEM * > > & GetDrillLayerItemsMap()
Definition: pcb_io_odbpp.h:103
Represent a set of closed polygons.
Handle a list of polygons defining a copper zone.
Definition: zone.h:73
#define _(s)
static constexpr EDA_ANGLE ANGLE_360
Definition: eda_angle.h:407
size_t hash_fp_item(const EDA_ITEM *aItem, int aFlags)
Calculate hash of an EDA_ITEM.
Definition: hash_eda.cpp:55
Hashing functions for EDA_ITEMs.
@ HASH_POS
Definition: hash_eda.h:47
@ REL_COORD
Use coordinates relative to the parent object.
Definition: hash_eda.h:50
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition: layer_ids.h:618
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ User_16
Definition: layer_ids.h:139
@ User_29
Definition: layer_ids.h:152
@ User_40
Definition: layer_ids.h:163
@ User_15
Definition: layer_ids.h:138
@ User_8
Definition: layer_ids.h:131
@ F_CrtYd
Definition: layer_ids.h:116
@ User_11
Definition: layer_ids.h:134
@ User_25
Definition: layer_ids.h:148
@ User_34
Definition: layer_ids.h:157
@ User_45
Definition: layer_ids.h:168
@ B_Adhes
Definition: layer_ids.h:103
@ User_36
Definition: layer_ids.h:159
@ Edge_Cuts
Definition: layer_ids.h:112
@ Dwgs_User
Definition: layer_ids.h:107
@ F_Paste
Definition: layer_ids.h:104
@ Cmts_User
Definition: layer_ids.h:108
@ User_6
Definition: layer_ids.h:129
@ User_7
Definition: layer_ids.h:130
@ User_19
Definition: layer_ids.h:142
@ User_23
Definition: layer_ids.h:146
@ F_Adhes
Definition: layer_ids.h:102
@ User_41
Definition: layer_ids.h:164
@ B_Mask
Definition: layer_ids.h:98
@ B_Cu
Definition: layer_ids.h:65
@ User_14
Definition: layer_ids.h:137
@ User_39
Definition: layer_ids.h:162
@ User_5
Definition: layer_ids.h:128
@ User_20
Definition: layer_ids.h:143
@ Eco1_User
Definition: layer_ids.h:109
@ F_Mask
Definition: layer_ids.h:97
@ User_42
Definition: layer_ids.h:165
@ User_43
Definition: layer_ids.h:166
@ B_Paste
Definition: layer_ids.h:105
@ User_10
Definition: layer_ids.h:133
@ User_9
Definition: layer_ids.h:132
@ User_27
Definition: layer_ids.h:150
@ User_28
Definition: layer_ids.h:151
@ F_Fab
Definition: layer_ids.h:119
@ Margin
Definition: layer_ids.h:113
@ F_SilkS
Definition: layer_ids.h:100
@ B_CrtYd
Definition: layer_ids.h:115
@ Eco2_User
Definition: layer_ids.h:110
@ User_35
Definition: layer_ids.h:158
@ User_31
Definition: layer_ids.h:154
@ User_3
Definition: layer_ids.h:126
@ User_1
Definition: layer_ids.h:124
@ User_12
Definition: layer_ids.h:135
@ B_SilkS
Definition: layer_ids.h:101
@ User_30
Definition: layer_ids.h:153
@ User_37
Definition: layer_ids.h:160
@ User_22
Definition: layer_ids.h:145
@ User_38
Definition: layer_ids.h:161
@ User_4
Definition: layer_ids.h:127
@ User_21
Definition: layer_ids.h:144
@ User_24
Definition: layer_ids.h:147
@ User_13
Definition: layer_ids.h:136
@ User_2
Definition: layer_ids.h:125
@ User_17
Definition: layer_ids.h:140
@ User_33
Definition: layer_ids.h:156
@ User_26
Definition: layer_ids.h:149
@ User_32
Definition: layer_ids.h:155
@ User_18
Definition: layer_ids.h:141
@ User_44
Definition: layer_ids.h:167
@ F_Cu
Definition: layer_ids.h:64
@ B_Fab
Definition: layer_ids.h:118
bool IsValidLayer(int aLayerId)
Test whether a given integer is a valid layer index, i.e.
Definition: layer_ids.h:596
std::pair< wxString, wxString > AddXY(const VECTOR2I &aVec)
Definition: odb_util.cpp:167
wxString GenLegalEntityName(const wxString &aStr)
Definition: odb_util.cpp:82
wxString Double2String(double aVal)
Definition: odb_util.cpp:127
wxString SymDouble2String(double aVal)
Definition: odb_util.cpp:155
#define ODB_JOB_NAME
Definition: odb_defines.h:27
#define ODB_UNITS
Definition: odb_defines.h:28
see class PGM_BASE
#define KEY_CORE
std::optional< ODB_DIELECTRIC_TYPE > m_diType
Definition: odb_entity.h:84
std::optional< std::pair< wxString, wxString > > m_span
Definition: odb_entity.h:82
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition: typeinfo.h:87