KiCad PCB EDA Suite
GBR_APERTURE_METADATA Class Reference

#include <plot_auxiliary_data.h>

Public Types

enum  GBR_APERTURE_ATTRIB {
  GBR_APERTURE_ATTRIB_NONE, GBR_APERTURE_ATTRIB_ETCHEDCMP, GBR_APERTURE_ATTRIB_CONDUCTOR, GBR_APERTURE_ATTRIB_CUTOUT,
  GBR_APERTURE_ATTRIB_NONCONDUCTOR, GBR_APERTURE_ATTRIB_VIAPAD, GBR_APERTURE_ATTRIB_COMPONENTPAD, GBR_APERTURE_ATTRIB_SMDPAD_SMDEF,
  GBR_APERTURE_ATTRIB_SMDPAD_CUDEF, GBR_APERTURE_ATTRIB_BGAPAD_SMDEF, GBR_APERTURE_ATTRIB_BGAPAD_CUDEF, GBR_APERTURE_ATTRIB_CONNECTORPAD,
  GBR_APERTURE_ATTRIB_WASHERPAD, GBR_APERTURE_ATTRIB_HEATSINKPAD, GBR_APERTURE_ATTRIB_VIADRILL, GBR_APERTURE_ATTRIB_COMPONENTDRILL,
  GBR_APERTURE_ATTRIB_SLOTDRILL, GBR_APERTURE_ATTRIB_END
}
 

Public Member Functions

 GBR_APERTURE_METADATA ()
 
std::string GetAttributeName ()
 
std::string FormatAttribute ()
 

Static Public Member Functions

static std::string GetAttributeName (GBR_APERTURE_ATTRIB aAttribute)
 
static std::string FormatAttribute (GBR_APERTURE_ATTRIB aAttribute)
 

Public Attributes

GBR_APERTURE_ATTRIB m_ApertAttribute
 

Detailed Description

Definition at line 44 of file plot_auxiliary_data.h.

Member Enumeration Documentation

Enumerator
GBR_APERTURE_ATTRIB_NONE 

uninitialized attribute

GBR_APERTURE_ATTRIB_ETCHEDCMP 

aperture used for etched components

GBR_APERTURE_ATTRIB_CONDUCTOR 

aperture used for connected items like tracks (not vias)

GBR_APERTURE_ATTRIB_CUTOUT 

aperture used for board cutout

GBR_APERTURE_ATTRIB_NONCONDUCTOR 

aperture used for not connected items (texts, outlines on copper)

GBR_APERTURE_ATTRIB_VIAPAD 

aperture used for vias

GBR_APERTURE_ATTRIB_COMPONENTPAD 

aperture used for through hole component on outer layer

GBR_APERTURE_ATTRIB_SMDPAD_SMDEF 

aperture used for SMD pad. Excluded BGA pads which have their own type

GBR_APERTURE_ATTRIB_SMDPAD_CUDEF 

aperture used for SMD pad with a solder mask defined by the solder mask

GBR_APERTURE_ATTRIB_BGAPAD_SMDEF 

aperture used for BGA pads with a solder mask defined by the copper shape

GBR_APERTURE_ATTRIB_BGAPAD_CUDEF 

aperture used for BGA pad with a solder mask defined by the solder mask

GBR_APERTURE_ATTRIB_CONNECTORPAD 

aperture used for edge connecto pad (outer layers)

GBR_APERTURE_ATTRIB_WASHERPAD 

aperture used for mechanical pads (NPTH)

GBR_APERTURE_ATTRIB_HEATSINKPAD 

aperture used for heat sink pad (typically for SMDs)

GBR_APERTURE_ATTRIB_VIADRILL 

aperture used for via holes in drill files

GBR_APERTURE_ATTRIB_COMPONENTDRILL 

aperture used for pad holes in drill files

GBR_APERTURE_ATTRIB_SLOTDRILL 

aperture used for oblong holes in drill files

GBR_APERTURE_ATTRIB_END 

sentinel: max value

Definition at line 47 of file plot_auxiliary_data.h.

48  {
67  };
aperture used for edge connecto pad (outer layers)
aperture used for heat sink pad (typically for SMDs)
aperture used for through hole component on outer layer
aperture used for via holes in drill files
aperture used for SMD pad. Excluded BGA pads which have their own type
aperture used for BGA pad with a solder mask defined by the solder mask
aperture used for pad holes in drill files
aperture used for mechanical pads (NPTH)
aperture used for BGA pads with a solder mask defined by the copper shape
aperture used for connected items like tracks (not vias)
aperture used for SMD pad with a solder mask defined by the solder mask
aperture used for not connected items (texts, outlines on copper)
aperture used for oblong holes in drill files

Constructor & Destructor Documentation

GBR_APERTURE_METADATA::GBR_APERTURE_METADATA ( )
inline

Definition at line 69 of file plot_auxiliary_data.h.

Member Function Documentation

std::string GBR_APERTURE_METADATA::FormatAttribute ( GBR_APERTURE_ATTRIB  aAttribute)
static
Returns
the full command string corresponding to the aperture attribute like "%TA.AperFunction,<function>*%"

Definition at line 35 of file gbr_metadata.cpp.

References GBR_APERTURE_ATTRIB_BGAPAD_CUDEF, GBR_APERTURE_ATTRIB_BGAPAD_SMDEF, GBR_APERTURE_ATTRIB_COMPONENTDRILL, GBR_APERTURE_ATTRIB_COMPONENTPAD, GBR_APERTURE_ATTRIB_CONDUCTOR, GBR_APERTURE_ATTRIB_CONNECTORPAD, GBR_APERTURE_ATTRIB_CUTOUT, GBR_APERTURE_ATTRIB_END, GBR_APERTURE_ATTRIB_ETCHEDCMP, GBR_APERTURE_ATTRIB_HEATSINKPAD, GBR_APERTURE_ATTRIB_NONCONDUCTOR, GBR_APERTURE_ATTRIB_NONE, GBR_APERTURE_ATTRIB_SLOTDRILL, GBR_APERTURE_ATTRIB_SMDPAD_CUDEF, GBR_APERTURE_ATTRIB_SMDPAD_SMDEF, GBR_APERTURE_ATTRIB_VIADRILL, GBR_APERTURE_ATTRIB_VIAPAD, and GBR_APERTURE_ATTRIB_WASHERPAD.

36 {
37  std::string attribute_string;
38 
39  // generate a string to print a Gerber Aperture attribute
40  switch( aAttribute )
41  {
42  case GBR_APERTURE_ATTRIB_END: // Dummy value (aAttribute must be < GBR_APERTURE_ATTRIB_END)
43  case GBR_APERTURE_ATTRIB_NONE: // idle command: do nothing
44  break;
45 
46  case GBR_APERTURE_ATTRIB_ETCHEDCMP: // print info associated to an item
47  // which connects 2 different nets
48  // (Net tees, microwave component)
49  attribute_string = "%TA.AperFunction,EtchedComponent*%\n";
50  break;
51 
52  case GBR_APERTURE_ATTRIB_CONDUCTOR: // print info associated to a track
53  attribute_string = "%TA.AperFunction,Conductor*%\n";
54  break;
55 
56  case GBR_APERTURE_ATTRIB_CUTOUT: // print info associated to a outline
57  attribute_string = "%TA.AperFunction,CutOut*%\n";
58  break;
59 
60  case GBR_APERTURE_ATTRIB_VIAPAD: // print info associated to a flashed via
61  attribute_string = "%TA.AperFunction,ViaPad*%\n";
62  break;
63 
64  case GBR_APERTURE_ATTRIB_NONCONDUCTOR: // print info associated to a item on a copper layer
65  // which is not a track (for instance a text)
66  attribute_string = "%TA.AperFunction,NonConductor*%\n";
67  break;
68 
69  case GBR_APERTURE_ATTRIB_COMPONENTPAD: // print info associated to a flashed
70  // through hole component on outer layer
71  attribute_string = "%TA.AperFunction,ComponentPad*%\n";
72  break;
73 
74  case GBR_APERTURE_ATTRIB_SMDPAD_SMDEF: // print info associated to a flashed for SMD pad.
75  // with solder mask defined from the copper shape
76  // Excluded BGA pads which have their own type
77  attribute_string = "%TA.AperFunction,SMDPad,SMDef*%\n";
78  break;
79 
80  case GBR_APERTURE_ATTRIB_SMDPAD_CUDEF: // print info associated to a flashed SMD pad with
81  // a solder mask defined by the solder mask
82  attribute_string = "%TA.AperFunction,SMDPad,CuDef*%\n";
83  break;
84 
85  case GBR_APERTURE_ATTRIB_BGAPAD_SMDEF: // print info associated to flashed BGA pads with
86  // a solder mask defined by the copper shape
87  attribute_string = "%TA.AperFunction,BGAPad,SMDef*%\n";
88  break;
89 
90  case GBR_APERTURE_ATTRIB_BGAPAD_CUDEF: // print info associated to a flashed BGA pad with
91  // a solder mask defined by the solder mask
92  attribute_string = "%TA.AperFunction,BGAPad,CuDef*%\n";
93  break;
94 
95  case GBR_APERTURE_ATTRIB_CONNECTORPAD: // print info associated to a flashed edge connector pad (outer layers)
96  attribute_string = "%TA.AperFunction,ConnectorPad*%\n";
97  break;
98 
99  case GBR_APERTURE_ATTRIB_WASHERPAD: // print info associated to flashed mechanical pads (NPTH)
100  attribute_string = "%TA.AperFunction,WasherPad*%\n";
101  break;
102 
103  case GBR_APERTURE_ATTRIB_HEATSINKPAD: // print info associated to a flashed heat sink pad
104  // (typically for SMDs)
105  attribute_string = "%TA.AperFunction,HeatsinkPad*%\n";
106  break;
107 
108  case GBR_APERTURE_ATTRIB_VIADRILL: // print info associated to a via hole in drill files
109  attribute_string = "%TA.AperFunction,ViaDrill*%\n";
110  break;
111 
112  case GBR_APERTURE_ATTRIB_COMPONENTDRILL: // print info associated to a component
113  // round hole in drill files
114  attribute_string = "%TA.AperFunction,ComponentDrill*%\n";
115  break;
116 
117  case GBR_APERTURE_ATTRIB_SLOTDRILL: // print info associated to a oblong hole in drill files
118  attribute_string = "%TA.AperFunction,Slot*%\n";
119  break;
120  }
121 
122  return attribute_string;
123 }
aperture used for edge connecto pad (outer layers)
aperture used for heat sink pad (typically for SMDs)
aperture used for through hole component on outer layer
aperture used for via holes in drill files
aperture used for SMD pad. Excluded BGA pads which have their own type
aperture used for BGA pad with a solder mask defined by the solder mask
aperture used for pad holes in drill files
aperture used for mechanical pads (NPTH)
aperture used for BGA pads with a solder mask defined by the copper shape
aperture used for connected items like tracks (not vias)
aperture used for SMD pad with a solder mask defined by the solder mask
aperture used for not connected items (texts, outlines on copper)
aperture used for oblong holes in drill files
std::string GBR_APERTURE_METADATA::FormatAttribute ( )
inline

Definition at line 87 of file plot_auxiliary_data.h.

References m_ApertAttribute.

Referenced by GERBER_PLOTTER::writeApertureList().

88  {
90  }
GBR_APERTURE_ATTRIB m_ApertAttribute
static std::string GBR_APERTURE_METADATA::GetAttributeName ( GBR_APERTURE_ATTRIB  aAttribute)
static
Returns
the string corresponding to the aperture attribute
std::string GBR_APERTURE_METADATA::GetAttributeName ( )
inline

Definition at line 77 of file plot_auxiliary_data.h.

References m_ApertAttribute.

78  {
80  }
std::string GetAttributeName()
GBR_APERTURE_ATTRIB m_ApertAttribute

Member Data Documentation

GBR_APERTURE_ATTRIB GBR_APERTURE_METADATA::m_ApertAttribute

The documentation for this class was generated from the following files: