- Generated on Tue Nov 4 2025 00:07:08 for KiCad PCB EDA Suite by
1.13.2
|
KiCad PCB EDA Suite
|
Information which can be added in a gerber file as attribute of an object. More...
#include <gbr_netlist_metadata.h>
Public Types | |
| enum | GBR_NETINFO_TYPE { GBR_NETINFO_UNSPECIFIED , GBR_NETINFO_PAD = 1 , GBR_NETINFO_NET = 2 , GBR_NETINFO_CMP = 4 } |
Public Member Functions | |
| GBR_NETLIST_METADATA () | |
| void | ClearExtraData () |
| Clear the extra data string printed at end of net attributes. | |
| void | SetExtraData (const wxString &aExtraData) |
| Set the extra data string printed at end of net attributes. | |
| void | ClearAttribute (const wxString *aName) |
| Remove the net attribute specified by aName. | |
Public Attributes | |
| int | m_NetAttribType |
| the type of net info (used to define the gerber string to create) | |
| bool | m_NotInNet |
| true if a pad of a footprint cannot be connected (for instance a mechanical NPTH, ot a not named pad) in this case the pad net name is empty in gerber file | |
| GBR_DATA_FIELD | m_Padname |
| for a flashed pad: the pad name ((TO.P attribute) | |
| GBR_DATA_FIELD | m_PadPinFunction |
| for a pad: the pin function (defined in schematic) | |
| wxString | m_Cmpref |
| the component reference parent of the data | |
| wxString | m_Netname |
| for items associated to a net: the netname | |
| wxString | m_ExtraData |
| a string to print after TO object attributes, if not empty it is printed "as this" | |
| bool | m_TryKeepPreviousAttributes |
| If true, do not clear all attributes when a attribute has changed. | |
Information which can be added in a gerber file as attribute of an object.
The #GBR_INFO_TYPE types can be OR'ed to add 2 (or more) attributes. There are only 3 net attributes defined attached to an object by the TO command:
The .P attribute can be used only for flashed pads (using the D03 command) and only for external copper layers, if the component is on a external copper layer for other copper layer items (pads on internal layers, tracks ... ), only .N and .C can be used.
Definition at line 151 of file gbr_netlist_metadata.h.
Definition at line 157 of file gbr_netlist_metadata.h.
|
inline |
Definition at line 165 of file gbr_netlist_metadata.h.
References GBR_NETINFO_UNSPECIFIED, m_NetAttribType, m_NotInNet, and m_TryKeepPreviousAttributes.
|
inline |
Remove the net attribute specified by aName.
If aName == NULL or empty, remove all attributes.
| aName | is the name (.CN, .P .N or .C) of the attribute to remove. |
Definition at line 193 of file gbr_netlist_metadata.h.
References GBR_NETINFO_CMP, GBR_NETINFO_NET, GBR_NETINFO_PAD, GBR_NETINFO_UNSPECIFIED, m_Cmpref, m_NetAttribType, m_Netname, m_Padname, and m_PadPinFunction.
|
inline |
Clear the extra data string printed at end of net attributes.
Definition at line 173 of file gbr_netlist_metadata.h.
References m_ExtraData.
Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile().
|
inline |
Set the extra data string printed at end of net attributes.
Definition at line 181 of file gbr_netlist_metadata.h.
References m_ExtraData.
Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile().
| wxString GBR_NETLIST_METADATA::m_Cmpref |
the component reference parent of the data
Definition at line 245 of file gbr_netlist_metadata.h.
Referenced by ClearAttribute(), FormatNetAttribute(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), and GERBVIEW_CONTROL::HighlightControl().
| wxString GBR_NETLIST_METADATA::m_ExtraData |
a string to print after TO object attributes, if not empty it is printed "as this"
Definition at line 248 of file gbr_netlist_metadata.h.
Referenced by ClearExtraData(), GERBER_PLOTTER::formatNetAttribute(), and SetExtraData().
| int GBR_NETLIST_METADATA::m_NetAttribType |
the type of net info (used to define the gerber string to create)
Definition at line 238 of file gbr_netlist_metadata.h.
Referenced by ClearAttribute(), FormatNetAttribute(), and GBR_NETLIST_METADATA().
| wxString GBR_NETLIST_METADATA::m_Netname |
for items associated to a net: the netname
Definition at line 246 of file gbr_netlist_metadata.h.
Referenced by ClearAttribute(), FormatNetAttribute(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), and GERBVIEW_CONTROL::HighlightControl().
| bool GBR_NETLIST_METADATA::m_NotInNet |
true if a pad of a footprint cannot be connected (for instance a mechanical NPTH, ot a not named pad) in this case the pad net name is empty in gerber file
Definition at line 240 of file gbr_netlist_metadata.h.
Referenced by FormatNetAttribute(), GBR_NETLIST_METADATA(), BRDITEMS_PLOTTER::PlotPad(), and PlotStandardLayer().
| GBR_DATA_FIELD GBR_NETLIST_METADATA::m_Padname |
for a flashed pad: the pad name ((TO.P attribute)
Definition at line 243 of file gbr_netlist_metadata.h.
Referenced by ClearAttribute(), and FormatNetAttribute().
| GBR_DATA_FIELD GBR_NETLIST_METADATA::m_PadPinFunction |
for a pad: the pin function (defined in schematic)
Definition at line 244 of file gbr_netlist_metadata.h.
Referenced by ClearAttribute(), and FormatNetAttribute().
| bool GBR_NETLIST_METADATA::m_TryKeepPreviousAttributes |
If true, do not clear all attributes when a attribute has changed.
This is useful when some attributes need to be persistent. If false, attributes will be cleared if only one attribute cleared. This is a more secure way to set attributes, when all attribute changes are not safely managed.
Definition at line 256 of file gbr_netlist_metadata.h.
Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile(), FormatNetAttribute(), and GBR_NETLIST_METADATA().
1.13.2