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.

Detailed Description

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:

TO.P
TO.N
TO.C

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 148 of file gbr_netlist_metadata.h.

Member Enumeration Documentation

◆ GBR_NETINFO_TYPE

enum GBR_NETLIST_METADATA::GBR_NETINFO_TYPE

Enumerator
GBR_NETINFO_UNSPECIFIED	idle command (no command)
GBR_NETINFO_PAD	print info associated to a flashed pad (TO.P attribute)
GBR_NETINFO_NET	print info associated to a net (TO.N attribute)
GBR_NETINFO_CMP	print info associated to a component (TO.C attribute)

Definition at line 154 of file gbr_netlist_metadata.h.

Constructor & Destructor Documentation

◆ GBR_NETLIST_METADATA()

GBR_NETLIST_METADATA::GBR_NETLIST_METADATA ( )

inline

Definition at line 162 of file gbr_netlist_metadata.h.

Member Function Documentation

◆ ClearAttribute()

void GBR_NETLIST_METADATA::ClearAttribute ( const wxString * aName )

inline

Remove the net attribute specified by aName.

If aName == NULL or empty, remove all attributes.

Parameters

aName is the name (.CN, .P .N or .C) of the attribute to remove.

Definition at line 190 of file gbr_netlist_metadata.h.

References GBR_DATA_FIELD::clear(), GBR_NETINFO_UNSPECIFIED, m_Cmpref, m_NetAttribType, m_Netname, m_Padname, and m_PadPinFunction.

Referenced by GERBER_FILE_IMAGE::RemoveAttribute().

◆ ClearExtraData()

void GBR_NETLIST_METADATA::ClearExtraData ( )

inline

Clear the extra data string printed at end of net attributes.

Definition at line 170 of file gbr_netlist_metadata.h.

References m_ExtraData.

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ SetExtraData()

void GBR_NETLIST_METADATA::SetExtraData ( const wxString & aExtraData )

inline

Set the extra data string printed at end of net attributes.

Definition at line 178 of file gbr_netlist_metadata.h.

References m_ExtraData.

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile().

Member Data Documentation

◆ m_Cmpref

wxString GBR_NETLIST_METADATA::m_Cmpref

the component reference parent of the data

Definition at line 242 of file gbr_netlist_metadata.h.

Referenced by ClearAttribute(), GERBER_FILE_IMAGE::ExecuteRS274XCommand(), FormatNetAttribute(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), GERBVIEW_CONTROL::HighlightControl(), GBR_METADATA::SetCmpReference(), and GERBER_DRAW_ITEM::SetNetAttributes().

◆ m_ExtraData

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 245 of file gbr_netlist_metadata.h.

Referenced by ClearExtraData(), GERBER_PLOTTER::formatNetAttribute(), and SetExtraData().

◆ m_NetAttribType

int GBR_NETLIST_METADATA::m_NetAttribType

the type of net info (used to define the gerber string to create)

Definition at line 235 of file gbr_netlist_metadata.h.

Referenced by ClearAttribute(), GERBER_FILE_IMAGE::ExecuteRS274XCommand(), FormatNetAttribute(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), GBR_METADATA::GetNetAttribType(), GBR_METADATA::SetNetAttribType(), and GERBER_DRAW_ITEM::SetNetAttributes().

◆ m_Netname

wxString GBR_NETLIST_METADATA::m_Netname

for items associated to a net: the netname

Definition at line 243 of file gbr_netlist_metadata.h.

Referenced by ClearAttribute(), GERBER_FILE_IMAGE::ExecuteRS274XCommand(), FormatNetAttribute(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), GERBVIEW_CONTROL::HighlightControl(), GERBER_DRAW_ITEM::SetNetAttributes(), and GBR_METADATA::SetNetName().

◆ m_NotInNet

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 237 of file gbr_netlist_metadata.h.

Referenced by FormatNetAttribute(), BRDITEMS_PLOTTER::PlotPad(), and PlotStandardLayer().

◆ m_Padname

GBR_DATA_FIELD GBR_NETLIST_METADATA::m_Padname

for a flashed pad: the pad name ((TO.P attribute)

Definition at line 240 of file gbr_netlist_metadata.h.

Referenced by ClearAttribute(), GERBER_FILE_IMAGE::ExecuteRS274XCommand(), FormatNetAttribute(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), and GBR_METADATA::SetPadName().

◆ m_PadPinFunction

GBR_DATA_FIELD GBR_NETLIST_METADATA::m_PadPinFunction

for a pad: the pin function (defined in schematic)

Definition at line 241 of file gbr_netlist_metadata.h.

Referenced by ClearAttribute(), GERBER_FILE_IMAGE::ExecuteRS274XCommand(), FormatNetAttribute(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), and GBR_METADATA::SetPadPinFunction().

◆ m_TryKeepPreviousAttributes

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 253 of file gbr_netlist_metadata.h.

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile(), and FormatNetAttribute().

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

gbr_netlist_metadata.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ GBR_NETINFO_TYPE

Constructor & Destructor Documentation

◆ GBR_NETLIST_METADATA()

Member Function Documentation

◆ ClearAttribute()

◆ ClearExtraData()

◆ SetExtraData()

Member Data Documentation

◆ m_Cmpref

◆ m_ExtraData

◆ m_NetAttribType

◆ m_Netname

◆ m_NotInNet

◆ m_Padname

◆ m_PadPinFunction

◆ m_TryKeepPreviousAttributes