KiCad PCB EDA Suite
gerber_jobfile_writer.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) 2018 Jean_Pierre Charras <jp.charras at wanadoo.fr>
5  * Copyright (C) 1992-2021 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 
30 #include <fstream>
31 #include <iomanip>
32 #include <vector>
33 
34 #include <build_version.h>
35 #include <locale_io.h>
36 #include <pcb_edit_frame.h>
37 #include <plotters/plotter.h>
38 
39 #include <board.h>
40 #include <board_design_settings.h>
41 #include <footprint.h>
42 #include <pad.h>
43 #include <pcb_track.h>
44 #include <zone.h>
45 
47 #include <gbr_metadata.h>
48 #include <gerber_jobfile_writer.h>
49 #include <pcbplot.h>
50 #include <reporter.h>
52 
54 {
55  m_pcb = aPcb;
56  m_reporter = aReporter;
57  m_conversionUnits = 1.0 / IU_PER_MM; // Gerber units = mm
58 }
59 
60 std::string GERBER_JOBFILE_WRITER::formatStringFromUTF32( const wxString& aText )
61 {
62  std::string fmt_text; // the text after UTF32 to UTF8 conversion
63 
64  for( unsigned long letter : aText )
65  {
66  if( letter >= ' ' && letter <= 0x7F )
67  fmt_text += char( letter );
68  else
69  {
70  char buff[16];
71  sprintf( buff, "\\u%4.4lX", letter );
72  fmt_text += buff;
73  }
74  }
75  return fmt_text;
76 }
77 
78 
80 {
81  int flag = SIDE_NONE;
82 
83  for( unsigned ii = 0; ii < m_params.m_LayerId.size(); ii++ )
84  {
85  if( m_params.m_LayerId[ii] == B_SilkS )
86  flag |= SIDE_BOTTOM;
87 
88  if( m_params.m_LayerId[ii] == F_SilkS )
89  flag |= SIDE_TOP;
90  }
91 
92  return (enum ONSIDE) flag;
93 }
94 
95 
97 {
98  int flag = SIDE_NONE;
99 
100  for( unsigned ii = 0; ii < m_params.m_LayerId.size(); ii++ )
101  {
102  if( m_params.m_LayerId[ii] == B_Mask )
103  flag |= SIDE_BOTTOM;
104 
105  if( m_params.m_LayerId[ii] == F_Mask )
106  flag |= SIDE_TOP;
107  }
108 
109  return (enum ONSIDE) flag;
110 }
111 
112 const char* GERBER_JOBFILE_WRITER::sideKeyValue( enum ONSIDE aValue )
113 {
114  // return the key associated to sides used for some layers
115  // "No, TopOnly, BotOnly or Both"
116  const char* value = nullptr;
117 
118  switch( aValue )
119  {
120  case SIDE_NONE:
121  value = "No";
122  break;
123 
124  case SIDE_TOP:
125  value = "TopOnly";
126  break;
127 
128  case SIDE_BOTTOM:
129  value = "BotOnly";
130  break;
131 
132  case SIDE_BOTH:
133  value = "Both";
134  break;
135  }
136 
137  return value;
138 }
139 
140 
141 bool GERBER_JOBFILE_WRITER::CreateJobFile( const wxString& aFullFilename )
142 {
143  bool success;
144  wxString msg;
145 
146  success = WriteJSONJobFile( aFullFilename );
147 
148  if( !success )
149  {
150  if( m_reporter )
151  {
152  msg.Printf( _( "Failed to create file '%s'." ), aFullFilename );
154  }
155  }
156  else if( m_reporter )
157  {
158  msg.Printf( _( "Created Gerber job file '%s'." ), aFullFilename );
160  }
161 
162  return success;
163 }
164 
165 
167 {
168  wxString text;
169 
170  m_json["Header"] = {
171  {
172  "GenerationSoftware",
173  {
174  { "Vendor", "KiCad" },
175  { "Application", "Pcbnew" },
176  { "Version", GetBuildVersion() }
177  }
178  },
179  {
180  // The attribute value must conform to the full version of the ISO 8601
181  // date and time format, including time and time zone.
183  }
184  };
185 }
186 
187 
188 bool GERBER_JOBFILE_WRITER::WriteJSONJobFile( const wxString& aFullFilename )
189 {
190  // Note: in Gerber job file, dimensions are in mm, and are floating numbers
191  std::ofstream file( aFullFilename.ToUTF8() );
192 
194 
195  m_json = nlohmann::ordered_json( {} );
196 
197  // output the job file header
198  addJSONHeader();
199 
200  // Add the General Specs
202 
203  // Job file support a few design rules:
205 
206  // output the gerber file list:
208 
209  // output the board stackup:
211 
212  file << std::setw( 2 ) << m_json << std::endl;
213 
214  return true;
215 }
216 
217 
218 double GERBER_JOBFILE_WRITER::mapValue( double aUiValue )
219 {
220  // A helper function to convert aUiValue in Json units (mm) and to have
221  // 4 digits in Json in mantissa when using %g to print it
222  // i.e. displays values truncated in 0.1 microns.
223  // This is enough for a Json file
224  char buffer[128];
225  sprintf( buffer, "%.4f", aUiValue * m_conversionUnits );
226 
227  long double output;
228  sscanf( buffer, "%Lg", &output );
229 
230  return output;
231 
232 }
233 
234 
236 {
237  m_json["GeneralSpecs"] = nlohmann::ordered_json( {} );
238  m_json["GeneralSpecs"]["ProjectId"] = nlohmann::ordered_json( {} );
239 
240  // Creates the ProjectId. Format is (from Gerber file format doc):
241  // ProjectId,<project id>,<project GUID>,<revision id>*%
242  // <project id> is the name of the project, restricted to basic ASCII symbols only,
243  // and comma not accepted
244  // All illegal chars will be replaced by underscore
245  // Rem: <project id> accepts only ASCII 7 code (only basic ASCII codes are allowed in gerber files).
246  //
247  // <project GUID> is a string which is an unique id of a project.
248  // However Kicad does not handle such a project GUID, so it is built from the board name
249  wxFileName fn = m_pcb->GetFileName();
250  wxString msg = fn.GetFullName();
251 
252  // Build a <project GUID>, from the board name
253  wxString guid = GbrMakeProjectGUIDfromString( msg );
254 
255  // build the <project id> string: this is the board short filename (without ext)
256  // and all non ASCII chars are replaced by '_', to be compatible with .gbr files.
257  msg = fn.GetName();
258 
259  // build the <rec> string. All non ASCII chars and comma are replaced by '_'
260  wxString rev = m_pcb->GetTitleBlock().GetRevision();
261 
262  if( rev.IsEmpty() )
263  rev = wxT( "rev?" );
264 
265  m_json["GeneralSpecs"]["ProjectId"]["Name"] = msg.ToAscii();
266  m_json["GeneralSpecs"]["ProjectId"]["GUID"] = guid;
267  m_json["GeneralSpecs"]["ProjectId"]["Revision"] = rev.ToAscii();
268 
269  // output the board size in mm:
271 
272  m_json["GeneralSpecs"]["Size"]["X"] = mapValue( brect.GetWidth() );
273  m_json["GeneralSpecs"]["Size"]["Y"] = mapValue( brect.GetHeight() );
274 
275 
276  // Add some data to the JSON header, GeneralSpecs:
277  // number of copper layers
278  m_json["GeneralSpecs"]["LayerNumber"] = m_pcb->GetCopperLayerCount();
279 
280  // Board thickness
281  m_json["GeneralSpecs"]["BoardThickness"] =
283 
284  // Copper finish
286 
287  if( !brd_stackup.m_FinishType.IsEmpty() )
288  m_json["GeneralSpecs"]["Finish"] = brd_stackup.m_FinishType;
289 
290  if( brd_stackup.m_CastellatedPads )
291  m_json["GeneralSpecs"]["Castellated"] = true;
292 
293  if( brd_stackup.m_EdgePlating )
294  m_json["GeneralSpecs"]["EdgePlating"] = true;
295 
296  if( brd_stackup.m_EdgeConnectorConstraints )
297  {
298  m_json["GeneralSpecs"]["EdgeConnector"] = true;
299 
300  m_json["GeneralSpecs"]["EdgeConnectorBevelled"] =
301  ( brd_stackup.m_EdgeConnectorConstraints == BS_EDGE_CONNECTOR_BEVELLED );
302  }
303 
304 #if 0 // Not yet in use
305  /* The board type according to IPC-2221. There are six primary board types:
306  - Type 1 - Single-sided
307  - Type 2 - Double-sided
308  - Type 3 - Multilayer, TH components only
309  - Type 4 - Multilayer, with TH, blind and/or buried vias.
310  - Type 5 - Multilayer metal-core board, TH components only
311  - Type 6 - Multilayer metal-core
312  */
313  m_json["GeneralSpecs"]["IPC-2221-Type"] = 4;
314 
315  /* Via protection: key words:
316  Ia Tented - Single-sided
317  Ib Tented - Double-sided
318  IIa Tented and Covered - Single-sided
319  IIb Tented and Covered - Double-sided
320  IIIa Plugged - Single-sided
321  IIIb Plugged - Double-sided
322  IVa Plugged and Covered - Single-sided
323  IVb Plugged and Covered - Double-sided
324  V Filled (fully plugged)
325  VI Filled and Covered
326  VIII Filled and Capped
327  None...No protection
328  */
329  m_json["GeneralSpecs"]["ViaProtection"] = "Ib";
330 #endif
331 }
332 
333 
335 {
336  // Add the Files Attributes section in JSON format to m_JSONbuffer
337  m_json["FilesAttributes"] = nlohmann::ordered_json::array();
338 
339  for( unsigned ii = 0; ii < m_params.m_GerberFileList.GetCount(); ii++ )
340  {
341  wxString& name = m_params.m_GerberFileList[ii];
342  PCB_LAYER_ID layer = m_params.m_LayerId[ii];
343  wxString gbr_layer_id;
344  bool skip_file = false; // true to skip files which should not be in job file
345  const char* polarity = "Positive";
346 
347  nlohmann::ordered_json file_json;
348 
349  if( layer <= B_Cu )
350  {
351  gbr_layer_id = "Copper,L";
352 
353  if( layer == B_Cu )
354  gbr_layer_id << m_pcb->GetCopperLayerCount();
355  else
356  gbr_layer_id << layer + 1;
357 
358  gbr_layer_id << ",";
359 
360  if( layer == B_Cu )
361  gbr_layer_id << "Bot";
362  else if( layer == F_Cu )
363  gbr_layer_id << "Top";
364  else
365  gbr_layer_id << "Inr";
366  }
367 
368  else
369  {
370  switch( layer )
371  {
372  case B_Adhes:
373  gbr_layer_id = "Glue,Bot";
374  break;
375  case F_Adhes:
376  gbr_layer_id = "Glue,Top";
377  break;
378 
379  case B_Paste:
380  gbr_layer_id = "SolderPaste,Bot";
381  break;
382  case F_Paste:
383  gbr_layer_id = "SolderPaste,Top";
384  break;
385 
386  case B_SilkS:
387  gbr_layer_id = "Legend,Bot";
388  break;
389  case F_SilkS:
390  gbr_layer_id = "Legend,Top";
391  break;
392 
393  case B_Mask:
394  gbr_layer_id = "SolderMask,Bot";
395  polarity = "Negative";
396  break;
397  case F_Mask:
398  gbr_layer_id = "SolderMask,Top";
399  polarity = "Negative";
400  break;
401 
402  case Edge_Cuts:
403  gbr_layer_id = "Profile";
404  break;
405 
406  case B_Fab:
407  gbr_layer_id = "AssemblyDrawing,Bot";
408  break;
409  case F_Fab:
410  gbr_layer_id = "AssemblyDrawing,Top";
411  break;
412 
413  case Dwgs_User:
414  case Cmts_User:
415  case Eco1_User:
416  case Eco2_User:
417  case Margin:
418  case B_CrtYd:
419  case F_CrtYd:
420  skip_file = true;
421  break;
422 
423  default:
424  skip_file = true;
425  m_reporter->Report( "Unexpected layer id in job file", RPT_SEVERITY_ERROR );
426  break;
427  }
428  }
429 
430  if( !skip_file )
431  {
432  // name can contain non ASCII7 chars.
433  // Ensure the name is JSON compatible.
434  std::string strname = formatStringFromUTF32( name );
435 
436  file_json["Path"] = strname.c_str();
437  file_json["FileFunction"] = gbr_layer_id;
438  file_json["FilePolarity"] = polarity;
439 
440  m_json["FilesAttributes"] += file_json;
441  }
442  }
443 }
444 
445 
447 {
448  // Add the Design Rules section in JSON format to m_JSONbuffer
449  // Job file support a few design rules:
450  const BOARD_DESIGN_SETTINGS& dsnSettings = m_pcb->GetDesignSettings();
451  NETCLASS defaultNC = *dsnSettings.GetDefault();
452  int minclearanceOuter = defaultNC.GetClearance();
453  bool hasInnerLayers = m_pcb->GetCopperLayerCount() > 2;
454 
455  // Search a smaller clearance in other net classes, if any.
456  for( const std::pair<const wxString, NETCLASSPTR>& entry : dsnSettings.GetNetClasses() )
457  minclearanceOuter = std::min( minclearanceOuter, entry.second->GetClearance() );
458 
459  // job file knows different clearance types.
460  // Kicad knows only one clearance for pads and tracks
461  int minclearance_track2track = minclearanceOuter;
462 
463  // However, pads can have a specific clearance defined for a pad or a footprint,
464  // and min clearance can be dependent on layers.
465  // Search for a minimal pad clearance:
466  int minPadClearanceOuter = defaultNC.GetClearance();
467  int minPadClearanceInner = defaultNC.GetClearance();
468 
469  for( FOOTPRINT* footprint : m_pcb->Footprints() )
470  {
471  for( PAD* pad : footprint->Pads() )
472  {
473  for( PCB_LAYER_ID layer : pad->GetLayerSet().Seq() )
474  {
475  int padClearance = pad->GetOwnClearance( layer );
476 
477  if( layer == B_Cu || layer == F_Cu )
478  minPadClearanceOuter = std::min( minPadClearanceOuter, padClearance );
479  else
480  minPadClearanceInner = std::min( minPadClearanceInner, padClearance );
481  }
482  }
483  }
484 
485  m_json["DesignRules"] = { {
486  { "Layers", "Outer" },
487  { "PadToPad", mapValue( minPadClearanceOuter ) },
488  { "PadToTrack", mapValue( minPadClearanceOuter ) },
489  { "TrackToTrack", mapValue( minclearance_track2track ) }
490  } };
491 
492  // Until this is changed in Kicad, use the same value for internal tracks
493  int minclearanceInner = minclearanceOuter;
494 
495  // Output the minimal track width
496  int mintrackWidthOuter = INT_MAX;
497  int mintrackWidthInner = INT_MAX;
498 
499  for( PCB_TRACK* track : m_pcb->Tracks() )
500  {
501  if( track->Type() == PCB_VIA_T )
502  continue;
503 
504  if( track->GetLayer() == B_Cu || track->GetLayer() == F_Cu )
505  mintrackWidthOuter = std::min( mintrackWidthOuter, track->GetWidth() );
506  else
507  mintrackWidthInner = std::min( mintrackWidthInner, track->GetWidth() );
508  }
509 
510  if( mintrackWidthOuter != INT_MAX )
511  m_json["DesignRules"][0]["MinLineWidth"] = mapValue( mintrackWidthOuter );
512 
513  // Output the minimal zone to xx clearance
514  // Note: zones can have a zone clearance set to 0
515  // if happens, the actual zone clearance is the clearance of its class
516  minclearanceOuter = INT_MAX;
517  minclearanceInner = INT_MAX;
518 
519  for( ZONE* zone : m_pcb->Zones() )
520  {
521  if( zone->GetIsRuleArea() || !zone->IsOnCopperLayer() )
522  continue;
523 
524  for( PCB_LAYER_ID layer : zone->GetLayerSet().Seq() )
525  {
526  int zclerance = zone->GetOwnClearance( layer );
527 
528  if( layer == B_Cu || layer == F_Cu )
529  minclearanceOuter = std::min( minclearanceOuter, zclerance );
530  else
531  minclearanceInner = std::min( minclearanceInner, zclerance );
532  }
533  }
534 
535  if( minclearanceOuter != INT_MAX )
536  m_json["DesignRules"][0]["TrackToRegion"] = mapValue( minclearanceOuter );
537 
538  if( minclearanceOuter != INT_MAX )
539  m_json["DesignRules"][0]["RegionToRegion"] = mapValue( minclearanceOuter );
540 
541  if( hasInnerLayers )
542  {
543  m_json["DesignRules"] += nlohmann::ordered_json( {
544  { "Layers", "Inner" },
545  { "PadToPad", mapValue( minPadClearanceInner ) },
546  { "PadToTrack", mapValue( minPadClearanceInner ) },
547  { "TrackToTrack", mapValue( minclearance_track2track ) }
548  } );
549 
550  if( mintrackWidthInner != INT_MAX )
551  m_json["DesignRules"][1]["MinLineWidth"] = mapValue( mintrackWidthInner );
552 
553  if( minclearanceInner != INT_MAX )
554  m_json["DesignRules"][1]["TrackToRegion"] = mapValue( minclearanceInner );
555 
556  if( minclearanceInner != INT_MAX )
557  m_json["DesignRules"][1]["RegionToRegion"] = mapValue( minclearanceInner );
558  }
559 }
560 
561 
563 {
564  // Add the Material Stackup section in JSON format to m_JSONbuffer
565  m_json["MaterialStackup"] = nlohmann::ordered_json::array();
566 
567  // Build the candidates list:
568  LSET maskLayer;
570 
571  // Ensure brd_stackup is up to date (i.e. no change made by SynchronizeWithBoard() )
572  bool uptodate = not brd_stackup.SynchronizeWithBoard( &m_pcb->GetDesignSettings() );
573 
574  if( !uptodate && m_pcb->GetDesignSettings().m_HasStackup )
575  m_reporter->Report( _( "Board stackup settings not up to date." ), RPT_SEVERITY_ERROR );
576 
577  PCB_LAYER_ID last_copper_layer = F_Cu;
578 
579  // Generate the list (top to bottom):
580  for( int ii = 0; ii < brd_stackup.GetCount(); ++ii )
581  {
582  BOARD_STACKUP_ITEM* item = brd_stackup.GetStackupLayer( ii );
583 
584  int sub_layer_count =
585  item->GetType() == BS_ITEM_TYPE_DIELECTRIC ? item->GetSublayersCount() : 1;
586 
587  for( int sub_idx = 0; sub_idx < sub_layer_count; sub_idx++ )
588  {
589  // layer thickness is always in mm
590  double thickness = mapValue( item->GetThickness( sub_idx ) );
591  wxString layer_type;
592  std::string layer_name; // for comment
593 
594  nlohmann::ordered_json layer_json;
595 
596  switch( item->GetType() )
597  {
598  case BS_ITEM_TYPE_COPPER:
599  layer_type = "Copper";
600  layer_name = formatStringFromUTF32( m_pcb->GetLayerName( item->GetBrdLayerId() ) );
601  last_copper_layer = item->GetBrdLayerId();
602  break;
603 
605  layer_type = "Legend";
606  layer_name = formatStringFromUTF32( item->GetTypeName() );
607  break;
608 
610  layer_type = "SolderMask";
611  layer_name = formatStringFromUTF32( item->GetTypeName() );
612  break;
613 
615  layer_type = "SolderPaste";
616  layer_name = formatStringFromUTF32( item->GetTypeName() );
617  break;
618 
620  layer_type = "Dielectric";
621  // The option core or prepreg is not added here, as it creates constraints
622  // in build process, not necessary wanted.
623  if( sub_layer_count > 1 )
624  {
625  layer_name =
626  formatStringFromUTF32( wxString::Format( "dielectric layer %d - %d/%d",
627  item->GetDielectricLayerId(), sub_idx + 1, sub_layer_count ) );
628  }
629  else
631  "dielectric layer %d", item->GetDielectricLayerId() ) );
632  break;
633 
634  default:
635  break;
636  }
637 
638  layer_json["Type"] = layer_type;
639 
640  if( item->IsColorEditable() && uptodate )
641  {
642  if( IsPrmSpecified( item->GetColor() ) )
643  {
644  wxString colorName = item->GetColor();
645 
646  if( colorName.StartsWith( "#" ) ) // This is a user defined color.
647  {
648  // In job file a color can be given by its RGB values (0...255)
649  wxColor color( colorName );
650  colorName.Printf( "R%dG%dB%d", color.Red(), color.Green(), color.Blue() );
651  }
652 
653  layer_json["Color"] = colorName;
654  }
655  }
656 
657  if( item->IsThicknessEditable() && uptodate )
658  layer_json["Thickness"] = thickness;
659 
660  if( item->GetType() == BS_ITEM_TYPE_DIELECTRIC )
661  {
662  if( item->HasMaterialValue() )
663  {
664  layer_json["Material"] = item->GetMaterial( sub_idx );
665 
666  // These constrains are only written if the board has impedance controlled tracks.
667  // If the board is not impedance controlled, they are useless.
668  // Do not add constrains that create more expensive boards.
669  if( brd_stackup.m_HasDielectricConstrains )
670  {
671  // Generate Epsilon R if > 1.0 (value <= 1.0 means not specified: it is not
672  // a possible value
673  if( item->GetEpsilonR() > 1.0 )
674  layer_json["DielectricConstant"] = item->FormatEpsilonR( sub_idx );
675 
676  // Generate LossTangent > 0.0 (value <= 0.0 means not specified: it is not
677  // a possible value
678  if( item->GetLossTangent() > 0.0 )
679  layer_json["LossTangent"] = item->FormatLossTangent( sub_idx );
680  }
681  }
682 
683  PCB_LAYER_ID next_copper_layer = ( PCB_LAYER_ID )( last_copper_layer + 1 );
684 
685  // If the next_copper_layer is the last copper layer, the next layer id is B_Cu
686  if( next_copper_layer >= m_pcb->GetCopperLayerCount() - 1 )
687  next_copper_layer = B_Cu;
688 
689  wxString subLayerName;
690 
691  if( sub_layer_count > 1 )
692  subLayerName.Printf( " (%d/%d)", sub_idx + 1, sub_layer_count );
693 
694  wxString name = wxString::Format( "%s/%s%s",
695  formatStringFromUTF32( m_pcb->GetLayerName( last_copper_layer ) ),
696  formatStringFromUTF32( m_pcb->GetLayerName( next_copper_layer ) ),
697  subLayerName );
698 
699  layer_json["Name"] = name;
700 
701  // Add a comment ("Notes"):
702  wxString note;
703 
704  note << wxString::Format( "Type: %s", layer_name.c_str() );
705 
706  note << wxString::Format( " (from %s to %s)",
707  formatStringFromUTF32( m_pcb->GetLayerName( last_copper_layer ) ),
708  formatStringFromUTF32( m_pcb->GetLayerName( next_copper_layer ) ) );
709 
710  layer_json["Notes"] = note;
711  }
712  else if( item->GetType() == BS_ITEM_TYPE_SOLDERMASK
713  || item->GetType() == BS_ITEM_TYPE_SILKSCREEN )
714  {
715  if( item->HasMaterialValue() )
716  {
717  layer_json["Material"] = item->GetMaterial();
718 
719  // These constrains are only written if the board has impedance controlled tracks.
720  // If the board is not impedance controlled, they are useless.
721  // Do not add constrains that create more expensive boards.
722  if( brd_stackup.m_HasDielectricConstrains )
723  {
724  // Generate Epsilon R if > 1.0 (value <= 1.0 means not specified: it is not
725  // a possible value
726  if( item->GetEpsilonR() > 1.0 )
727  layer_json["DielectricConstant"] = item->FormatEpsilonR();
728 
729  // Generate LossTangent > 0.0 (value <= 0.0 means not specified: it is not
730  // a possible value
731  if( item->GetLossTangent() > 0.0 )
732  layer_json["LossTangent"] = item->FormatLossTangent();
733  }
734  }
735 
736  layer_json["Name"] = layer_name.c_str();
737  }
738  else
739  {
740  layer_json["Name"] = layer_name.c_str();
741  }
742 
743  m_json["MaterialStackup"].insert( m_json["MaterialStackup"].end(), layer_json );
744  }
745  }
746 }
BOARD_STACKUP_ITEM_TYPE GetType() const
nlohmann::ordered_json m_json
std::string formatStringFromUTF32(const wxString &aText)
A helper function to convert a wxString ( therefore a Unicode text ) to a JSON compatible string (a e...
Handle special data (items attributes) during plot.
Plot settings, and plotting engines (PostScript, Gerber, HPGL and DXF)
BOARD_STACKUP_ITEM * GetStackupLayer(int aIndex)
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:361
ZONES & Zones()
Definition: board.h:239
bool HasMaterialValue(int aDielectricSubLayer=0) const
double mapValue(double aUiValue)
A helper function to convert a double in Pcbnew internal units to a JSON double value (in mm),...
bool CreateJobFile(const wxString &aFullFilename)
Creates a Gerber job file.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
Manage layers needed to make a physical board.
int GetSublayersCount() const
static constexpr double IU_PER_MM
Mock up a conversion function.
const EDA_RECT GetBoardEdgesBoundingBox() const
Return the board bounding box calculated using exclusively the board edges (graphics on Edge....
Definition: board.h:742
void addJSONHeader()
Add the job file header in JSON format to m_JSONbuffer.
int color
Definition: DXF_plotter.cpp:57
int GetWidth() const
Definition: eda_rect.h:109
const char * sideKeyValue(enum ONSIDE aValue)
wxString GetColor() const
wxString GbrMakeCreationDateAttributeString(GBR_NC_STRING_FORMAT aFormat)
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:70
const wxString & GetFileName() const
Definition: board.h:228
Classes used to generate a Gerber job file in JSON.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:589
void addJSONFilesAttributes()
Add the Files Attributes section in JSON format to m_JSONbuffer.
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
double GetLossTangent(int aDielectricSubLayer=0) const
bool SynchronizeWithBoard(BOARD_DESIGN_SETTINGS *aSettings)
Synchronize the BOARD_STACKUP_ITEM* list with the board.
Board plot function definition file.
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
wxArrayString m_GerberFileList
bool m_HasDielectricConstrains
True if some layers have impedance controlled tracks or have specific constrains for micro-wave appli...
BOARD_STACKUP & GetStackupDescriptor()
bool IsThicknessEditable() const
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:502
wxString GetBuildVersion()
Get the full KiCad version string.
const wxString & GetRevision() const
Definition: title_block.h:86
int GetThickness(int aDielectricSubLayer=0) const
bool IsColorEditable() const
wxString GbrMakeProjectGUIDfromString(const wxString &aText)
Build a project GUID using format RFC4122 Version 1 or 4 from the project name, because a KiCad proje...
FOOTPRINTS & Footprints()
Definition: board.h:233
A collection of nets and the parameters used to route or test these nets.
Definition: netclass.h:46
double GetEpsilonR(int aDielectricSubLayer=0) const
wxString FormatEpsilonR(int aDielectricSubLayer=0) const
Definition of file extensions used in Kicad.
wxString GetTypeName() const
#define _(s)
wxString FormatLossTangent(int aDielectricSubLayer=0) const
NETCLASSES & GetNetClasses() const
Handle a list of polygons defining a copper zone.
Definition: zone.h:56
int GetCount() const
Manage one layer needed to make a physical board.
Definition: board_stackup.h:89
int GetHeight() const
Definition: eda_rect.h:110
bool WriteJSONJobFile(const wxString &aFullFilename)
Creates an Gerber job file in JSON format.
PCB_LAYER_ID GetBrdLayerId() const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
TITLE_BLOCK & GetTitleBlock()
Definition: board.h:541
bool IsPrmSpecified(const wxString &aPrmValue)
const char * name
Definition: DXF_plotter.cpp:56
int GetDielectricLayerId() const
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:64
int GetClearance() const
Definition: netclass.h:124
Definition: layer_ids.h:70
void addJSONDesignRules()
Add the Design Rules section in JSON format to m_JSONbuffer.
int GetCopperLayerCount() const
Definition: board.cpp:454
Handle the component boundary box.
Definition: eda_rect.h:42
NETCLASS * GetDefault() const
std::vector< PCB_LAYER_ID > m_LayerId
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
Definition: pad.h:57
void addJSONMaterialStackup()
Add the Material Stackup section in JSON format to m_JSONbuffer This is the ordered list of stackup l...
wxString GetMaterial(int aDielectricSubLayer=0) const
void addJSONGeneralSpecs()
Add the General Specs in JSON format to m_JSONbuffer.
TRACKS & Tracks()
Definition: board.h:230
GERBER_JOBFILE_WRITER(BOARD *aPcb, REPORTER *aReporter=nullptr)
Container for design settings for a BOARD object.