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_POSITION ,   GBR_APERTURE_ATTRIB_PADOTHER_POSITION , GBR_APERTURE_ATTRIB_CMP_BODY , GBR_APERTURE_ATTRIB_CMP_LEAD2LEAD , GBR_APERTURE_ATTRIB_CMP_FOOTPRINT ,   GBR_APERTURE_ATTRIB_CMP_COURTYARD , 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)

Public Attributes
GBR_APERTURE_ATTRIB	m_ApertAttribute

Detailed Description

Definition at line 88 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. aperture used for connected items like tracks (not vias).
GBR_APERTURE_ATTRIB_CONDUCTOR
GBR_APERTURE_ATTRIB_EDGECUT	aperture used for board cutout, aperture used for not connected items (texts, outlines on copper).
GBR_APERTURE_ATTRIB_NONCONDUCTOR
GBR_APERTURE_ATTRIB_VIAPAD	aperture used for vias. aperture used for through hole component on outer layer.
GBR_APERTURE_ATTRIB_COMPONENTPAD	aperture used for SMD pad. Excluded BGA pads which have their own type.
GBR_APERTURE_ATTRIB_SMDPAD_SMDEF	aperture used for SMD pad with a solder mask defined by the solder mask.
GBR_APERTURE_ATTRIB_SMDPAD_CUDEF	aperture used for BGA pads with a solder mask defined by the copper shape.
GBR_APERTURE_ATTRIB_BGAPAD_SMDEF	aperture used for BGA pad with a solder mask defined by the solder mask.
GBR_APERTURE_ATTRIB_BGAPAD_CUDEF	aperture used for edge connector pad (outer layers).
GBR_APERTURE_ATTRIB_CONNECTORPAD
GBR_APERTURE_ATTRIB_WASHERPAD	aperture used for mechanical pads (NPTH).
GBR_APERTURE_ATTRIB_TESTPOINT	aperture used for test point pad (outer layers). aperture used for fiducial pad (outer layers), at board level.
GBR_APERTURE_ATTRIB_FIDUCIAL_GLBL	aperture used for fiducial pad (outer layers), at footprint level.
GBR_APERTURE_ATTRIB_FIDUCIAL_LOCAL	aperture used for heat sink pad (typically for SMDs).
GBR_APERTURE_ATTRIB_HEATSINKPAD	aperture used for castellated pads in copper layer files.
GBR_APERTURE_ATTRIB_CASTELLATEDPAD	aperture used for castellated pads in drill files.
GBR_APERTURE_ATTRIB_CASTELLATEDDRILL
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. aperture used for pads oblong holes in drill files.
GBR_APERTURE_ATTRIB_CMP_OBLONG_DRILL	aperture used for flashed cmp position in placement files.
GBR_APERTURE_ATTRIB_CMP_POSITION	aperture used for flashed pin 1 (or A1 or AA1) position in placement files.
GBR_APERTURE_ATTRIB_PAD1_POSITION	aperture used for flashed pads position in placement files.
GBR_APERTURE_ATTRIB_PADOTHER_POSITION	aperture used to draw component physical body outline without pins in placement files.
GBR_APERTURE_ATTRIB_CMP_BODY	aperture used to draw component physical body outline with pins in placement files.
GBR_APERTURE_ATTRIB_CMP_LEAD2LEAD	aperture used to draw component footprint bounding box in placement files.
GBR_APERTURE_ATTRIB_CMP_FOOTPRINT	aperture used to draw component outline courtyard in placement files.
GBR_APERTURE_ATTRIB_CMP_COURTYARD
GBR_APERTURE_ATTRIB_END	sentinel: max value

Definition at line 91 of file gbr_metadata.h.

 {
 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_POSITION,
 
 GBR_APERTURE_ATTRIB_PADOTHER_POSITION,
 
 GBR_APERTURE_ATTRIB_CMP_BODY,
 
 GBR_APERTURE_ATTRIB_CMP_LEAD2LEAD,
 
 GBR_APERTURE_ATTRIB_CMP_FOOTPRINT,
 
 GBR_APERTURE_ATTRIB_CMP_COURTYARD,
 GBR_APERTURE_ATTRIB_END 
 };

Constructor & Destructor Documentation

GBR_APERTURE_METADATA()

GBR_APERTURE_METADATA::GBR_APERTURE_METADATA ( )

inline

Definition at line 168 of file gbr_metadata.h.

 :m_ApertAttribute( GBR_APERTURE_ATTRIB_NONE )
 {}

Member Function Documentation

FormatAttribute() [1/2]

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

inline

Definition at line 191 of file gbr_metadata.h.

 {
 return FormatAttribute( m_ApertAttribute, aUseX1StructuredComment );
 }

References FormatAttribute(), and m_ApertAttribute.

FormatAttribute() [2/2]

std::string GBR_APERTURE_METADATA::FormatAttribute ( GBR_APERTURE_ATTRIB  aAttribute, bool  aUseX1StructuredComment  )

static

Parameters

aUseX1StructuredComment

false 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 156 of file gbr_metadata.cpp.

{
 std::string attribute_string; // the specific aperture attribute (TA.xxx)
 std::string comment_string; // a optional G04 comment line to write before the TA. line
 
 // generate a string to print a Gerber Aperture attribute
 switch( aAttribute )
 {
 // Dummy value (aAttribute must be < GBR_APERTURE_ATTRIB_END).
 case GBR_APERTURE_ATTRIB_END:
 case GBR_APERTURE_ATTRIB_NONE: // idle command: do nothing
 break;
 
 case GBR_APERTURE_ATTRIB_ETCHEDCMP: // print info associated to an item
 // which connects 2 different nets
 // (Net tees, microwave component)
 attribute_string = "TA.AperFunction,EtchedComponent";
 break;
 
 case GBR_APERTURE_ATTRIB_CONDUCTOR: // print info associated to a track
 attribute_string = "TA.AperFunction,Conductor";
 break;
 
 case GBR_APERTURE_ATTRIB_EDGECUT: // print info associated to a board outline
 attribute_string = "TA.AperFunction,Profile";
 break;
 
 case GBR_APERTURE_ATTRIB_VIAPAD: // print info associated to a flashed via
 attribute_string = "TA.AperFunction,ViaPad";
 break;
 
 case GBR_APERTURE_ATTRIB_NONCONDUCTOR: // print info associated to a item on a copper layer
 // which is not a track (for instance a text)
 attribute_string = "TA.AperFunction,NonConductor";
 break;
 
 case GBR_APERTURE_ATTRIB_COMPONENTPAD: // print info associated to a flashed
 // through hole component on outer layer
 attribute_string = "TA.AperFunction,ComponentPad";
 break;
 
 case GBR_APERTURE_ATTRIB_SMDPAD_SMDEF: // print info associated to a flashed for SMD pad.
 // with solder mask defined from the copper shape
 // Excluded BGA pads which have their own type
 attribute_string = "TA.AperFunction,SMDPad,SMDef";
 break;
 
 case GBR_APERTURE_ATTRIB_SMDPAD_CUDEF: // print info associated to a flashed SMD pad with
 // a solder mask defined by the solder mask
 attribute_string = "TA.AperFunction,SMDPad,CuDef";
 break;
 
 case GBR_APERTURE_ATTRIB_BGAPAD_SMDEF: // print info associated to flashed BGA pads with
 // a solder mask defined by the copper shape
 attribute_string = "TA.AperFunction,BGAPad,SMDef";
 break;
 
 case GBR_APERTURE_ATTRIB_BGAPAD_CUDEF: // print info associated to a flashed BGA pad with
  // a solder mask defined by the solder mask
 attribute_string = "TA.AperFunction,BGAPad,CuDef";
 break;
 
 case GBR_APERTURE_ATTRIB_CONNECTORPAD:
 // print info associated to a flashed edge connector pad (outer layers)
 attribute_string = "TA.AperFunction,ConnectorPad";
 break;
 
 case GBR_APERTURE_ATTRIB_WASHERPAD:
 // print info associated to flashed mechanical pads (NPTH)
 attribute_string = "TA.AperFunction,WasherPad";
 break;
 
 case GBR_APERTURE_ATTRIB_HEATSINKPAD: // print info associated to a flashed heat sink pad
 // (typically for SMDs)
 attribute_string = "TA.AperFunction,HeatsinkPad";
 break;
 
 case GBR_APERTURE_ATTRIB_TESTPOINT: // print info associated to a flashed test point pad
 // (typically for SMDs)
 attribute_string = "TA.AperFunction,TestPad";
 break;
 
 case GBR_APERTURE_ATTRIB_FIDUCIAL_GLBL: // print info associated to a flashed fiducial pad
 // (typically for SMDs)
 attribute_string = "TA.AperFunction,FiducialPad,Global";
 break;
 
 case GBR_APERTURE_ATTRIB_FIDUCIAL_LOCAL: // print info associated to a flashed fiducial pad
 // (typically for SMDs)
 attribute_string = "TA.AperFunction,FiducialPad,Local";
 break;
 
 case GBR_APERTURE_ATTRIB_CASTELLATEDPAD:
 // print info associated to a flashed castellated pad (typically for SMDs)
 attribute_string = "TA.AperFunction,CastellatedPad";
 break;
 
 case GBR_APERTURE_ATTRIB_CASTELLATEDDRILL:
 // print info associated to a flashed castellated pad in drill files
 attribute_string = "TA.AperFunction,CastellatedDrill";
 break;
 
 case GBR_APERTURE_ATTRIB_VIADRILL: // print info associated to a via hole in drill files
 attribute_string = "TA.AperFunction,ViaDrill";
 break;
 
 case GBR_APERTURE_ATTRIB_CMP_DRILL: // print info associated to a component
 // round pad hole in drill files
 attribute_string = "TA.AperFunction,ComponentDrill";
 break;
 
 // print info associated to a component oblong pad hole in drill files
 // Same as a round pad hole, but is a specific aperture in drill file and
 // a G04 comment is added to the aperture function
 case GBR_APERTURE_ATTRIB_CMP_OBLONG_DRILL:
 comment_string = "aperture for slot hole";
 attribute_string = "TA.AperFunction,ComponentDrill";
 break;
 
 case GBR_APERTURE_ATTRIB_CMP_POSITION: // print info associated to a component
 // flashed shape at the component position
 // in placement files
 attribute_string = "TA.AperFunction,ComponentMain";
 break;
 
 case GBR_APERTURE_ATTRIB_PAD1_POSITION: // print info associated to a component
 // flashed shape at pad 1 position
 // (pad 1 is also pad A1 or pad AA1)
 // in placement files
 attribute_string = "TA.AperFunction,ComponentPin";
 break;
 
 case GBR_APERTURE_ATTRIB_PADOTHER_POSITION: // print info associated to a component
 // flashed shape at pads position (all but pad 1)
 // in placement files
 // Currently: (could be changed later) same as
 // GBR_APERTURE_ATTRIB_PADOTHER_POSITION
 attribute_string = "TA.AperFunction,ComponentPin";
 break;
 
 case GBR_APERTURE_ATTRIB_CMP_BODY: // print info associated to a component
 // print the component physical body
 // polygon in placement files
 attribute_string = "TA.AperFunction,ComponentOutline,Body";
 break;
 
 case GBR_APERTURE_ATTRIB_CMP_LEAD2LEAD: // print info associated to a component
 // print the component physical lead to lead
 // polygon in placement files
 attribute_string = "TA.AperFunction,ComponentOutline,Lead2Lead";
 break;
 
 case GBR_APERTURE_ATTRIB_CMP_FOOTPRINT: // print info associated to a component
 // print the component footprint bounding box
 // polygon in placement files
 attribute_string = "TA.AperFunction,ComponentOutline,Footprint";
 break;
 
 case GBR_APERTURE_ATTRIB_CMP_COURTYARD: // print info associated to a component
 // print the component courtyard
 // polygon in placement files
 attribute_string = "TA.AperFunction,ComponentOutline,Courtyard";
 break;
 
 break;
 }
 
 std::string full_attribute_string;
 wxString eol_string;
 
 if( !attribute_string.empty() )
 {
 if( !comment_string.empty() )
 {
 full_attribute_string = "G04 " + comment_string + "*\n";
 }
 
 if( aUseX1StructuredComment )
 {
 full_attribute_string += "G04 #@! ";
 eol_string = "*\n";
 }
 else
 {
 full_attribute_string += "%";
 eol_string = "*%\n";
 }
 }
 
 full_attribute_string += attribute_string + eol_string;
 
 return full_attribute_string;
}

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_PAD1_POSITION, GBR_APERTURE_ATTRIB_PADOTHER_POSITION, 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 176 of file gbr_metadata.h.

 {
 return GetAttributeName( m_ApertAttribute );
 }

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 197 of file gbr_metadata.h.

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

---

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

• gbr_metadata.h
• gbr_metadata.cpp