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

Metadata which can be added in a gerber file as attribute in X2 format. More...

#include <gbr_metadata.h>

Public Member Functions

 GBR_METADATA ()
 
void SetApertureAttrib (GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
 
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib ()
 
void SetNetAttribType (int aNetAttribType)
 
int GetNetAttribType () const
 
void SetNetName (const wxString &aNetname)
 
void SetPadName (const wxString &aPadname, bool aUseUTF8=false, bool aEscapeString=false)
 
void SetPadPinFunction (const wxString &aPadPinFunction, bool aUseUTF8, bool aEscapeString)
 
void SetCmpReference (const wxString &aComponentRef)
 
bool IsCopper ()
 Allowed attributes are not the same on board copper layers and on other layers.
 
void SetCopper (bool aValue)
 

Public Attributes

GBR_APERTURE_METADATA m_ApertureMetadata
 An item to handle aperture attribute.
 
GBR_NETLIST_METADATA m_NetlistMetadata
 An item to handle object attribute.
 

Private Attributes

bool m_isCopper
 If the metadata is relative to a copper layer or not, this flag which can be set/reset when an attribute for a given item depends on whether a copper layer or a non copper layer is plotted.
 

Detailed Description

Metadata which can be added in a gerber file as attribute in X2 format.

Definition at line 204 of file gbr_metadata.h.

Constructor & Destructor Documentation

◆ GBR_METADATA()

GBR_METADATA::GBR_METADATA ( )
inline

Definition at line 207 of file gbr_metadata.h.

Member Function Documentation

◆ GetApertureAttrib()

GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GBR_METADATA::GetApertureAttrib ( )
inline

Definition at line 214 of file gbr_metadata.h.

References GBR_APERTURE_METADATA::m_ApertAttribute, and m_ApertureMetadata.

Referenced by GERBER_PLOTTER::FlashPadChamferRoundRect(), GERBER_PLOTTER::FlashPadCircle(), GERBER_PLOTTER::FlashPadCustom(), GERBER_PLOTTER::FlashPadOval(), GERBER_PLOTTER::FlashPadRect(), GERBER_PLOTTER::FlashPadRoundRect(), GERBER_PLOTTER::FlashPadTrapez(), GERBER_PLOTTER::FlashRegularPolygon(), and GERBER_PLOTTER::SetCurrentLineWidth().

◆ GetNetAttribType()

int GBR_METADATA::GetNetAttribType ( ) const
inline

Definition at line 224 of file gbr_metadata.h.

References GBR_NETLIST_METADATA::m_NetAttribType, and m_NetlistMetadata.

◆ IsCopper()

bool GBR_METADATA::IsCopper ( )
inline

Allowed attributes are not the same on board copper layers and on other layers.

A flag can be set or reset when attributes can be depending on layers

Definition at line 251 of file gbr_metadata.h.

References m_isCopper.

◆ SetApertureAttrib()

void GBR_METADATA::SetApertureAttrib ( GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB  aApertAttribute)
inline

Definition at line 209 of file gbr_metadata.h.

References GBR_APERTURE_METADATA::m_ApertAttribute, and m_ApertureMetadata.

Referenced by GERBER_WRITER::createDrillFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), PlotStandardLayer(), BRDITEMS_PLOTTER::PlotText(), and BRDITEMS_PLOTTER::PlotZone().

◆ SetCmpReference()

void GBR_METADATA::SetCmpReference ( const wxString &  aComponentRef)
inline

Definition at line 241 of file gbr_metadata.h.

References GBR_NETLIST_METADATA::m_Cmpref, and m_NetlistMetadata.

Referenced by GERBER_WRITER::createDrillFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), and BRDITEMS_PLOTTER::PlotTableBorders().

◆ SetCopper()

void GBR_METADATA::SetCopper ( bool  aValue)
inline

Definition at line 252 of file gbr_metadata.h.

References m_isCopper.

Referenced by BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), and BRDITEMS_PLOTTER::PlotZone().

◆ SetNetAttribType()

void GBR_METADATA::SetNetAttribType ( int  aNetAttribType)
inline

Definition at line 219 of file gbr_metadata.h.

References GBR_NETLIST_METADATA::m_NetAttribType, and m_NetlistMetadata.

Referenced by GERBER_WRITER::createDrillFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), PlotStandardLayer(), BRDITEMS_PLOTTER::PlotTableBorders(), and BRDITEMS_PLOTTER::PlotZone().

◆ SetNetName()

void GBR_METADATA::SetNetName ( const wxString &  aNetname)
inline

Definition at line 229 of file gbr_metadata.h.

References m_NetlistMetadata, and GBR_NETLIST_METADATA::m_Netname.

Referenced by BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), PlotStandardLayer(), and BRDITEMS_PLOTTER::PlotZone().

◆ SetPadName()

void GBR_METADATA::SetPadName ( const wxString &  aPadname,
bool  aUseUTF8 = false,
bool  aEscapeString = false 
)
inline

Definition at line 231 of file gbr_metadata.h.

References m_NetlistMetadata, GBR_NETLIST_METADATA::m_Padname, and GBR_DATA_FIELD::SetField().

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile(), and BRDITEMS_PLOTTER::PlotPad().

◆ SetPadPinFunction()

void GBR_METADATA::SetPadPinFunction ( const wxString &  aPadPinFunction,
bool  aUseUTF8,
bool  aEscapeString 
)
inline

Definition at line 236 of file gbr_metadata.h.

References m_NetlistMetadata, GBR_NETLIST_METADATA::m_PadPinFunction, and GBR_DATA_FIELD::SetField().

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile(), and BRDITEMS_PLOTTER::PlotPad().

Member Data Documentation

◆ m_ApertureMetadata

GBR_APERTURE_METADATA GBR_METADATA::m_ApertureMetadata

An item to handle aperture attribute.

Definition at line 257 of file gbr_metadata.h.

Referenced by GERBER_PLOTTER::FlashPadRoundRect(), GetApertureAttrib(), GERBER_PLOTTER::PlotGerberRegion(), and SetApertureAttrib().

◆ m_isCopper

bool GBR_METADATA::m_isCopper
private

If the metadata is relative to a copper layer or not, this flag which can be set/reset when an attribute for a given item depends on whether a copper layer or a non copper layer is plotted.

The initial state i false.

Definition at line 270 of file gbr_metadata.h.

Referenced by IsCopper(), and SetCopper().

◆ m_NetlistMetadata

GBR_NETLIST_METADATA GBR_METADATA::m_NetlistMetadata

An item to handle object attribute.

Definition at line 262 of file gbr_metadata.h.

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile(), GERBER_PLOTTER::FilledCircle(), GERBER_PLOTTER::FlashPadChamferRoundRect(), GERBER_PLOTTER::FlashPadCircle(), GERBER_PLOTTER::FlashPadCustom(), GERBER_PLOTTER::FlashPadOval(), GERBER_PLOTTER::FlashPadRect(), GERBER_PLOTTER::FlashPadRoundRect(), GERBER_PLOTTER::FlashPadTrapez(), GERBER_PLOTTER::FlashRegularPolygon(), GetNetAttribType(), BRDITEMS_PLOTTER::PlotPad(), GERBER_PLOTTER::PlotPoly(), PlotStandardLayer(), GERBER_PLOTTER::PlotText(), SetCmpReference(), SetNetAttribType(), SetNetName(), SetPadName(), SetPadPinFunction(), GERBER_PLOTTER::Text(), GERBER_PLOTTER::ThickArc(), GERBER_PLOTTER::ThickCircle(), GERBER_PLOTTER::ThickRect(), and GERBER_PLOTTER::ThickSegment().

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