KiCad PCB EDA Suite
gbr_metadata.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2018-2020 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
34#ifndef GBR_METADATA_H
35#define GBR_METADATA_H
36
38
59enum GBR_NC_STRING_FORMAT // Options for string format in some attribute strings
60{
65};
67
68
80wxString GbrMakeProjectGUIDfromString( const wxString& aText );
81
82
83// this class handle info which can be added in a gerber file as attribute
84// of an aperture, by the %TA.AperFunction command
85// This attribute is added when creating a new aperture (command %ADDxx)
86// Only one aperture attribute can be added to a given aperture
87//
89{
90public:
92 {
95
99
103
106
109
112
115
118
123
126
129
132
135
138
141
144
147
150
153
156
159
162
166 };
167
170 {}
171
175 static std::string GetAttributeName( GBR_APERTURE_ATTRIB aAttribute );
176 std::string GetAttributeName()
177 {
179 }
180
188 static std::string FormatAttribute( GBR_APERTURE_ATTRIB aAttribute,
189 bool aUseX1StructuredComment );
190
191 std::string FormatAttribute( bool aUseX1StructuredComment )
192 {
193 return FormatAttribute( m_ApertAttribute, aUseX1StructuredComment );
194 }
195
196 // The id of the aperture attribute
198};
199
200
205{
206public:
208
210 {
211 m_ApertureMetadata.m_ApertAttribute = aApertAttribute;
212 }
213
215 {
217 }
218
219 void SetNetAttribType( int aNetAttribType )
220 {
221 m_NetlistMetadata.m_NetAttribType = aNetAttribType;
222 }
223
225 {
227 }
228
229 void SetNetName( const wxString& aNetname ) { m_NetlistMetadata.m_Netname = aNetname; }
230
231 void SetPadName( const wxString& aPadname, bool aUseUTF8 = false, bool aEscapeString = false )
232 {
233 m_NetlistMetadata.m_Padname.SetField( aPadname, aUseUTF8, aEscapeString );
234 }
235
236 void SetPadPinFunction( const wxString& aPadPinFunction, bool aUseUTF8, bool aEscapeString )
237 {
238 m_NetlistMetadata.m_PadPinFunction.SetField( aPadPinFunction, aUseUTF8, aEscapeString );
239 }
240
241 void SetCmpReference( const wxString& aComponentRef )
242 {
243 m_NetlistMetadata.m_Cmpref = aComponentRef;
244 }
245
251 bool IsCopper() { return m_isCopper; }
252 void SetCopper( bool aValue ) { m_isCopper = aValue; }
253
258
263
264private:
271};
272
273
283std::string FormatStringToGerber( const wxString& aString );
284
285
297wxString ConvertNotAllowedCharsInGerber( const wxString& aString, bool aAllowUtf8Chars,
298 bool aQuoteString );
299
306wxString FormatStringFromGerber( const wxString& aString );
307
324bool FormatNetAttribute( std::string& aPrintedText, std::string& aLastNetAttributes,
325 const GBR_NETLIST_METADATA* aData, bool& aClearPreviousAttributes,
326 bool aUseX1StructuredComment );
327
328#endif // GBR_METADATA_H
GBR_APERTURE_ATTRIB m_ApertAttribute
Definition: gbr_metadata.h:197
@ GBR_APERTURE_ATTRIB_CMP_DRILL
aperture used for pad holes in drill files.
Definition: gbr_metadata.h:140
@ GBR_APERTURE_ATTRIB_VIAPAD
aperture used for vias.
Definition: gbr_metadata.h:102
@ GBR_APERTURE_ATTRIB_ETCHEDCMP
aperture used for etched components.
Definition: gbr_metadata.h:94
@ GBR_APERTURE_ATTRIB_BGAPAD_CUDEF
aperture used for edge connector pad (outer layers).
Definition: gbr_metadata.h:117
@ GBR_APERTURE_ATTRIB_HEATSINKPAD
aperture used for castellated pads in copper layer files.
Definition: gbr_metadata.h:131
@ GBR_APERTURE_ATTRIB_CMP_OBLONG_DRILL
aperture used for flashed cmp position in placement files.
Definition: gbr_metadata.h:143
@ GBR_APERTURE_ATTRIB_TESTPOINT
aperture used for test point pad (outer layers).
Definition: gbr_metadata.h:122
@ GBR_APERTURE_ATTRIB_SMDPAD_SMDEF
aperture used for SMD pad with a solder mask defined by the solder mask.
Definition: gbr_metadata.h:108
@ GBR_APERTURE_ATTRIB_SMDPAD_CUDEF
aperture used for BGA pads with a solder mask defined by the copper shape.
Definition: gbr_metadata.h:111
@ GBR_APERTURE_ATTRIB_NONE
uninitialized attribute.
Definition: gbr_metadata.h:93
@ GBR_APERTURE_ATTRIB_PAD1_POSITION
aperture used for flashed pads position in placement files.
Definition: gbr_metadata.h:149
@ GBR_APERTURE_ATTRIB_END
sentinel: max value
Definition: gbr_metadata.h:165
@ GBR_APERTURE_ATTRIB_CMP_POSITION
aperture used for flashed pin 1 (or A1 or AA1) position in placement files.
Definition: gbr_metadata.h:146
@ GBR_APERTURE_ATTRIB_CMP_BODY
aperture used to draw component physical body outline with pins in placement files.
Definition: gbr_metadata.h:155
@ GBR_APERTURE_ATTRIB_PADOTHER_POSITION
aperture used to draw component physical body outline without pins in placement files.
Definition: gbr_metadata.h:152
@ GBR_APERTURE_ATTRIB_BGAPAD_SMDEF
aperture used for BGA pad with a solder mask defined by the solder mask.
Definition: gbr_metadata.h:114
@ GBR_APERTURE_ATTRIB_WASHERPAD
aperture used for mechanical pads (NPTH).
Definition: gbr_metadata.h:121
@ GBR_APERTURE_ATTRIB_COMPONENTPAD
aperture used for SMD pad. Excluded BGA pads which have their own type.
Definition: gbr_metadata.h:105
@ GBR_APERTURE_ATTRIB_VIADRILL
aperture used for via holes in drill files.
Definition: gbr_metadata.h:139
@ GBR_APERTURE_ATTRIB_CMP_FOOTPRINT
aperture used to draw component outline courtyard in placement files.
Definition: gbr_metadata.h:161
@ GBR_APERTURE_ATTRIB_CMP_LEAD2LEAD
aperture used to draw component footprint bounding box in placement files.
Definition: gbr_metadata.h:158
@ GBR_APERTURE_ATTRIB_FIDUCIAL_GLBL
aperture used for fiducial pad (outer layers), at footprint level.
Definition: gbr_metadata.h:125
@ GBR_APERTURE_ATTRIB_CASTELLATEDPAD
aperture used for castellated pads in drill files.
Definition: gbr_metadata.h:134
@ GBR_APERTURE_ATTRIB_FIDUCIAL_LOCAL
aperture used for heat sink pad (typically for SMDs).
Definition: gbr_metadata.h:128
@ GBR_APERTURE_ATTRIB_EDGECUT
aperture used for board cutout,
Definition: gbr_metadata.h:98
static std::string FormatAttribute(GBR_APERTURE_ATTRIB aAttribute, bool aUseX1StructuredComment)
static std::string GetAttributeName(GBR_APERTURE_ATTRIB aAttribute)
std::string GetAttributeName()
Definition: gbr_metadata.h:176
std::string FormatAttribute(bool aUseX1StructuredComment)
Definition: gbr_metadata.h:191
void SetField(const wxString &aField, bool aUseUTF8, bool aEscapeString)
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:205
void SetCopper(bool aValue)
Definition: gbr_metadata.h:252
void SetCmpReference(const wxString &aComponentRef)
Definition: gbr_metadata.h:241
void SetNetName(const wxString &aNetname)
Definition: gbr_metadata.h:229
void SetPadPinFunction(const wxString &aPadPinFunction, bool aUseUTF8, bool aEscapeString)
Definition: gbr_metadata.h:236
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:214
bool IsCopper()
Allowed attributes are not the same on board copper layers and on other layers.
Definition: gbr_metadata.h:251
void SetApertureAttrib(GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
Definition: gbr_metadata.h:209
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
int GetNetAttribType() const
Definition: gbr_metadata.h:224
void SetNetAttribType(int aNetAttribType)
Definition: gbr_metadata.h:219
GBR_APERTURE_METADATA m_ApertureMetadata
An item to handle aperture attribute.
Definition: gbr_metadata.h:257
bool m_isCopper
If the metadata is relative to a copper layer or not, this flag which can be set/reset when an attrib...
Definition: gbr_metadata.h:270
void SetPadName(const wxString &aPadname, bool aUseUTF8=false, bool aEscapeString=false)
Definition: gbr_metadata.h:231
Information which can be added in a gerber file as attribute of an object.
int m_NetAttribType
the type of net info (used to define the gerber string to create)
wxString m_Cmpref
the component reference parent of the data
GBR_DATA_FIELD m_PadPinFunction
for a pad: the pin function (defined in schematic)
GBR_DATA_FIELD m_Padname
for a flashed pad: the pad name ((TO.P attribute)
wxString m_Netname
for items associated to a net: the netname
wxString GbrMakeProjectGUIDfromString(const wxString &aText)
Build a project GUID using format RFC4122 Version 1 or 4 from the project name, because a KiCad proje...
wxString GbrMakeCreationDateAttributeString(GBR_NC_STRING_FORMAT aFormat)
std::string FormatStringToGerber(const wxString &aString)
Normalize aString and convert it to a Gerber std::string.
GBR_NC_STRING_FORMAT
Create a gerber TF.CreationDate attribute.
Definition: gbr_metadata.h:60
@ GBR_NC_STRING_FORMAT_X1
Definition: gbr_metadata.h:61
@ GBR_NC_STRING_FORMAT_NCDRILL
Definition: gbr_metadata.h:64
@ GBR_NC_STRING_FORMAT_X2
Definition: gbr_metadata.h:62
@ GBR_NC_STRING_FORMAT_GBRJOB
Definition: gbr_metadata.h:63
wxString ConvertNotAllowedCharsInGerber(const wxString &aString, bool aAllowUtf8Chars, bool aQuoteString)
Normalize aString and convert it to a Gerber compatible wxString.
wxString FormatStringFromGerber(const wxString &aString)
Convert a gerber string into a 16 bit Unicode string.
bool FormatNetAttribute(std::string &aPrintedText, std::string &aLastNetAttributes, const GBR_NETLIST_METADATA *aData, bool &aClearPreviousAttributes, bool aUseX1StructuredComment)
Generate the string to set a net attribute for a graphic object to print to a gerber file.