KiCad PCB EDA Suite
GBR_METADATA Class Reference

#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)
 
void SetCmpReference (const wxString &aComponentRef)
 
bool IsCopper ()
 Allowed attributes are not the same on board copper layers and on other layers Therefore a flag can be set or reset when attributes can be depending on layers. More...
 
void SetCopper (bool aValue)
 

Public Attributes

GBR_APERTURE_METADATA m_ApertureMetadata
 a item to handle aperture attribute: More...
 
GBR_NETLIST_METADATA m_NetlistMetadata
 a item to handle object attribute: More...
 

Private Attributes

bool m_isCopper
 if the metadata is relative to a copper layer or not. More...
 

Detailed Description

Definition at line 148 of file gbr_metadata.h.

Constructor & Destructor Documentation

◆ GBR_METADATA()

GBR_METADATA::GBR_METADATA ( )
inline

Definition at line 151 of file gbr_metadata.h.

151 : m_isCopper( false) {}
bool m_isCopper
if the metadata is relative to a copper layer or not.
Definition: gbr_metadata.h:201

Member Function Documentation

◆ GetApertureAttrib()

GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GBR_METADATA::GetApertureAttrib ( )
inline

◆ GetNetAttribType()

int GBR_METADATA::GetNetAttribType ( ) const
inline

Definition at line 168 of file gbr_metadata.h.

169  {
171  }
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:192
int m_NetAttribType
the type of net info (used to define the gerber string to create)

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 Therefore a flag can be set or reset when attributes can be depending on layers.

Definition at line 181 of file gbr_metadata.h.

181 { return m_isCopper; }
bool m_isCopper
if the metadata is relative to a copper layer or not.
Definition: gbr_metadata.h:201

References m_isCopper.

◆ SetApertureAttrib()

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

◆ SetCmpReference()

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

Definition at line 175 of file gbr_metadata.h.

175 { m_NetlistMetadata.m_Cmpref = aComponentRef; }
wxString m_Cmpref
the component reference parent of the data
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:192

References GBR_NETLIST_METADATA::m_Cmpref, and m_NetlistMetadata.

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

◆ SetCopper()

void GBR_METADATA::SetCopper ( bool  aValue)
inline

Definition at line 182 of file gbr_metadata.h.

182 { m_isCopper = aValue; }
bool m_isCopper
if the metadata is relative to a copper layer or not.
Definition: gbr_metadata.h:201

References m_isCopper.

Referenced by BRDITEMS_PLOTTER::PlotFilledAreas(), and BRDITEMS_PLOTTER::PlotPad().

◆ SetNetAttribType()

void GBR_METADATA::SetNetAttribType ( int  aNetAttribType)
inline

Definition at line 163 of file gbr_metadata.h.

164  {
165  m_NetlistMetadata.m_NetAttribType = aNetAttribType;
166  }
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:192
int m_NetAttribType
the type of net info (used to define the gerber string to create)

References GBR_NETLIST_METADATA::m_NetAttribType, and m_NetlistMetadata.

Referenced by GERBER_WRITER::createDrillFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotPad(), PlotStandardLayer(), and BRDITEMS_PLOTTER::PlotTextModule().

◆ SetNetName()

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

Definition at line 173 of file gbr_metadata.h.

173 { m_NetlistMetadata.m_Netname = aNetname; }
wxString m_Netname
for items associated to a net: the netname
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:192

References m_NetlistMetadata, and GBR_NETLIST_METADATA::m_Netname.

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

◆ SetPadName()

void GBR_METADATA::SetPadName ( const wxString &  aPadname)
inline

Definition at line 174 of file gbr_metadata.h.

174 { m_NetlistMetadata.m_Padname = aPadname; }
wxString m_Padname
for a flashed pad: the pad name ((TO.P attribute)
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:192

References m_NetlistMetadata, and GBR_NETLIST_METADATA::m_Padname.

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

Member Data Documentation

◆ m_ApertureMetadata

GBR_APERTURE_METADATA GBR_METADATA::m_ApertureMetadata

a item to handle aperture attribute:

Definition at line 187 of file gbr_metadata.h.

Referenced by 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 is a flag which can be set/reset when an attribute for a given item depends on the fact a copper layer or a non copper layer is plotted. The initial state in false.

Definition at line 201 of file gbr_metadata.h.

Referenced by IsCopper(), and SetCopper().

◆ m_NetlistMetadata


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