KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GBR_APERTURE_METADATA Class Reference

#include <gbr_metadata.h>

Public Types

enum  GBR_APERTURE_ATTRIB {
  GBR_APERTURE_ATTRIB_NONE , GBR_APERTURE_ATTRIB_ETCHEDCMP , GBR_APERTURE_ATTRIB_CONDUCTOR , GBR_APERTURE_ATTRIB_EDGECUT ,
  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_TESTPOINT , GBR_APERTURE_ATTRIB_FIDUCIAL_GLBL , GBR_APERTURE_ATTRIB_FIDUCIAL_LOCAL ,
  GBR_APERTURE_ATTRIB_HEATSINKPAD , GBR_APERTURE_ATTRIB_CASTELLATEDPAD , GBR_APERTURE_ATTRIB_CASTELLATEDDRILL , GBR_APERTURE_ATTRIB_VIADRILL ,
  GBR_APERTURE_ATTRIB_CMP_DRILL , GBR_APERTURE_ATTRIB_CMP_OBLONG_DRILL , GBR_APERTURE_ATTRIB_CMP_POSITION , GBR_APERTURE_ATTRIB_PAD1_POS ,
  GBR_APERTURE_ATTRIB_PADOTHER_POS , GBR_APERTURE_ATTRIB_CMP_BODY , GBR_APERTURE_ATTRIB_CMP_LEAD2LEAD , GBR_APERTURE_ATTRIB_CMP_FOOTPRINT ,
  GBR_APERTURE_ATTRIB_CMP_COURTYARD , GBR_APERTURE_ATTRIB_OTHER , GBR_APERTURE_ATTRIB_END
}
 

Public Member Functions

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

Static Public Member Functions

static std::string GetAttributeName (GBR_APERTURE_ATTRIB aAttribute)
 
static std::string FormatAttribute (GBR_APERTURE_ATTRIB aAttribute, bool aUseX1StructuredComment, const std::string &aCustomAttribute)
 

Public Attributes

GBR_APERTURE_ATTRIB m_ApertAttribute
 
std::string m_CustomAttribute
 

Detailed Description

Definition at line 89 of file gbr_metadata.h.

Member Enumeration Documentation

◆ GBR_APERTURE_ATTRIB

enum GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB
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_EDGECUT 

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 connector pad (outer layers).

GBR_APERTURE_ATTRIB_WASHERPAD 

Aperture used for mechanical pads (NPTH).

GBR_APERTURE_ATTRIB_TESTPOINT 

Aperture used for test point pad (outer layers).

GBR_APERTURE_ATTRIB_FIDUCIAL_GLBL 

Aperture used for fiducial pad (outer layers), at board level.

GBR_APERTURE_ATTRIB_FIDUCIAL_LOCAL 

Aperture used for fiducial pad (outer layers), at footprint level.

GBR_APERTURE_ATTRIB_HEATSINKPAD 

Aperture used for heat sink pad (typically for SMDs).

GBR_APERTURE_ATTRIB_CASTELLATEDPAD 

Aperture used for castellated pads in copper layer files.

GBR_APERTURE_ATTRIB_CASTELLATEDDRILL 

Aperture used for castellated pads in drill files.

GBR_APERTURE_ATTRIB_VIADRILL 

Aperture used for via holes in drill files.

GBR_APERTURE_ATTRIB_CMP_DRILL 

Aperture used for pad holes in drill files.

GBR_APERTURE_ATTRIB_CMP_OBLONG_DRILL 

Aperture used for pads oblong holes in drill files.

GBR_APERTURE_ATTRIB_CMP_POSITION 

Aperture used for flashed cmp position in placement files.

GBR_APERTURE_ATTRIB_PAD1_POS 

Aperture used for flashed pin 1 (or A1 or AA1) position in placement files.

GBR_APERTURE_ATTRIB_PADOTHER_POS 

Aperture used for flashed pads position in placement files.

GBR_APERTURE_ATTRIB_CMP_BODY 

Aperture used to draw component physical body outline without pins in placement files.

GBR_APERTURE_ATTRIB_CMP_LEAD2LEAD 

Aperture used to draw component physical body outline with pins in placement files.

GBR_APERTURE_ATTRIB_CMP_FOOTPRINT 

Aperture used to draw component footprint bounding box in placement files.

GBR_APERTURE_ATTRIB_CMP_COURTYARD 

Aperture used to draw component outline courtyard in placement files.

aperture used for other purposes. Requires a text description of this feature.

GBR_APERTURE_ATTRIB_OTHER 
GBR_APERTURE_ATTRIB_END 

sentinel: max value

Definition at line 92 of file gbr_metadata.h.

Constructor & Destructor Documentation

◆ GBR_APERTURE_METADATA()

GBR_APERTURE_METADATA::GBR_APERTURE_METADATA ( )
inline

Definition at line 172 of file gbr_metadata.h.

Member Function Documentation

◆ FormatAttribute() [1/2]

std::string GBR_APERTURE_METADATA::FormatAttribute ( bool  aUseX1StructuredComment)
inline

Definition at line 195 of file gbr_metadata.h.

References FormatAttribute(), m_ApertAttribute, and m_CustomAttribute.

◆ FormatAttribute() [2/2]

std::string GBR_APERTURE_METADATA::FormatAttribute ( GBR_APERTURE_ATTRIB  aAttribute,
bool  aUseX1StructuredComment,
const std::string &  aCustomAttribute 
)
static
Parameters
aUseX1StructuredCommentfalse in X2 mode and true in X1 mode to add the net attribute inside a compatible X1 structured comment starting by "G04 #@! "
Returns
the full command string corresponding to the aperture attribute like "%TA.AperFunction,<function>*%"

Definition at line 159 of file gbr_metadata.cpp.

References GBR_APERTURE_ATTRIB_BGAPAD_CUDEF, GBR_APERTURE_ATTRIB_BGAPAD_SMDEF, GBR_APERTURE_ATTRIB_CASTELLATEDDRILL, GBR_APERTURE_ATTRIB_CASTELLATEDPAD, GBR_APERTURE_ATTRIB_CMP_BODY, GBR_APERTURE_ATTRIB_CMP_COURTYARD, GBR_APERTURE_ATTRIB_CMP_DRILL, GBR_APERTURE_ATTRIB_CMP_FOOTPRINT, GBR_APERTURE_ATTRIB_CMP_LEAD2LEAD, GBR_APERTURE_ATTRIB_CMP_OBLONG_DRILL, GBR_APERTURE_ATTRIB_CMP_POSITION, GBR_APERTURE_ATTRIB_COMPONENTPAD, GBR_APERTURE_ATTRIB_CONDUCTOR, GBR_APERTURE_ATTRIB_CONNECTORPAD, GBR_APERTURE_ATTRIB_EDGECUT, GBR_APERTURE_ATTRIB_END, GBR_APERTURE_ATTRIB_ETCHEDCMP, GBR_APERTURE_ATTRIB_FIDUCIAL_GLBL, GBR_APERTURE_ATTRIB_FIDUCIAL_LOCAL, GBR_APERTURE_ATTRIB_HEATSINKPAD, GBR_APERTURE_ATTRIB_NONCONDUCTOR, GBR_APERTURE_ATTRIB_NONE, GBR_APERTURE_ATTRIB_OTHER, GBR_APERTURE_ATTRIB_PAD1_POS, GBR_APERTURE_ATTRIB_PADOTHER_POS, GBR_APERTURE_ATTRIB_SMDPAD_CUDEF, GBR_APERTURE_ATTRIB_SMDPAD_SMDEF, GBR_APERTURE_ATTRIB_TESTPOINT, GBR_APERTURE_ATTRIB_VIADRILL, GBR_APERTURE_ATTRIB_VIAPAD, and GBR_APERTURE_ATTRIB_WASHERPAD.

Referenced by GERBER_PLOTTER::FlashPadRoundRect(), FormatAttribute(), GERBER_PLOTTER::PlotGerberRegion(), and GERBER_PLOTTER::writeApertureList().

◆ GetAttributeName() [1/2]

std::string GBR_APERTURE_METADATA::GetAttributeName ( )
inline

Definition at line 179 of file gbr_metadata.h.

References GetAttributeName(), and m_ApertAttribute.

Referenced by GetAttributeName().

◆ GetAttributeName() [2/2]

static std::string GBR_APERTURE_METADATA::GetAttributeName ( GBR_APERTURE_ATTRIB  aAttribute)
static
Returns
the string corresponding to the aperture attribute.

Member Data Documentation

◆ m_ApertAttribute

GBR_APERTURE_ATTRIB GBR_APERTURE_METADATA::m_ApertAttribute

Definition at line 201 of file gbr_metadata.h.

Referenced by FormatAttribute(), GBR_METADATA::GetApertureAttrib(), GetAttributeName(), and GBR_METADATA::SetApertureAttrib().

◆ m_CustomAttribute

std::string GBR_APERTURE_METADATA::m_CustomAttribute

Definition at line 203 of file gbr_metadata.h.

Referenced by FormatAttribute(), GBR_METADATA::GetCustomAttribute(), and GBR_METADATA::SetApertureAttrib().

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