KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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};
66
68
69
81wxString GbrMakeProjectGUIDfromString( const wxString& aText );
82
83
84// this class handle info which can be added in a gerber file as attribute
85// of an aperture, by the %TA.AperFunction command
86// This attribute is added when creating a new aperture (command %ADDxx)
87// Only one aperture attribute can be added to a given aperture
88//
90{
91public:
93 {
96
100
104
107
110
113
116
119
124
127
130
133
136
139
143
146
149
152
155
158
161
164
167
170
174 };
175
177 {}
178
182 static std::string GetAttributeName( GBR_APERTURE_ATTRIB aAttribute );
183 std::string GetAttributeName()
184 {
186 }
187
195 static std::string FormatAttribute( GBR_APERTURE_ATTRIB aAttribute,
196 bool aUseX1StructuredComment,
197 const std::string& aCustomAttribute );
198
199 std::string FormatAttribute( bool aUseX1StructuredComment )
200 {
201 return FormatAttribute( m_ApertAttribute, aUseX1StructuredComment, m_CustomAttribute );
202 }
203
204 // The id of the aperture attribute
206
207 std::string m_CustomAttribute;
208};
209
210
215{
216public:
218
220 {
221 m_ApertureMetadata.m_ApertAttribute = aApertAttribute;
222 }
223
224 void SetApertureAttrib( std::string aCustomAttribute )
225 {
227 m_ApertureMetadata.m_CustomAttribute = aCustomAttribute;
228 }
229
231 {
233 }
234
236
237 void SetNetAttribType( int aNetAttribType )
238 {
239 m_NetlistMetadata.m_NetAttribType = aNetAttribType;
240 }
241
243 {
245 }
246
247 void SetNetName( const wxString& aNetname ) { m_NetlistMetadata.m_Netname = aNetname; }
248
249 void SetPadName( const wxString& aPadname, bool aUseUTF8 = false, bool aEscapeString = false )
250 {
251 m_NetlistMetadata.m_Padname.SetField( aPadname, aUseUTF8, aEscapeString );
252 }
253
254 void SetPadPinFunction( const wxString& aPadPinFunction, bool aUseUTF8, bool aEscapeString )
255 {
256 m_NetlistMetadata.m_PadPinFunction.SetField( aPadPinFunction, aUseUTF8, aEscapeString );
257 }
258
259 void SetCmpReference( const wxString& aComponentRef )
260 {
261 m_NetlistMetadata.m_Cmpref = aComponentRef;
262 }
263
269 bool IsCopper() { return m_isCopper; }
270 void SetCopper( bool aValue ) { m_isCopper = aValue; }
271
276
281
282private:
289};
290
291
301std::string FormatStringToGerber( const wxString& aString );
302
303
315wxString ConvertNotAllowedCharsInGerber( const wxString& aString, bool aAllowUtf8Chars,
316 bool aQuoteString );
317
324wxString FormatStringFromGerber( const wxString& aString );
325
342bool FormatNetAttribute( std::string& aPrintedText, std::string& aLastNetAttributes,
343 const GBR_NETLIST_METADATA* aData, bool& aClearPreviousAttributes,
344 bool aUseX1StructuredComment );
345
346#endif // GBR_METADATA_H
GBR_APERTURE_ATTRIB m_ApertAttribute
Definition: gbr_metadata.h:205
@ GBR_APERTURE_ATTRIB_CMP_DRILL
Aperture used for pad holes in drill files.
Definition: gbr_metadata.h:145
@ GBR_APERTURE_ATTRIB_CONDUCTOR
Aperture used for connected items like tracks (not vias).
Definition: gbr_metadata.h:98
@ GBR_APERTURE_ATTRIB_VIAPAD
Aperture used for vias.
Definition: gbr_metadata.h:103
@ GBR_APERTURE_ATTRIB_ETCHEDCMP
Aperture used for etched components.
Definition: gbr_metadata.h:95
@ GBR_APERTURE_ATTRIB_BGAPAD_CUDEF
Aperture used for BGA pad with a solder mask defined by the solder mask.
Definition: gbr_metadata.h:118
@ GBR_APERTURE_ATTRIB_PRESSFITDRILL
Aperture used for pressfit pads in drill files.
Definition: gbr_metadata.h:142
@ GBR_APERTURE_ATTRIB_PAD1_POS
Aperture used for flashed pin 1 (or A1 or AA1) position in placement files.
Definition: gbr_metadata.h:154
@ GBR_APERTURE_ATTRIB_HEATSINKPAD
Aperture used for heat sink pad (typically for SMDs).
Definition: gbr_metadata.h:132
@ GBR_APERTURE_ATTRIB_CMP_OBLONG_DRILL
Aperture used for pads oblong holes in drill files.
Definition: gbr_metadata.h:148
@ GBR_APERTURE_ATTRIB_CMP_COURTYARD
Aperture used to draw component outline courtyard in placement files.
Definition: gbr_metadata.h:169
@ GBR_APERTURE_ATTRIB_TESTPOINT
Aperture used for test point pad (outer layers).
Definition: gbr_metadata.h:123
@ GBR_APERTURE_ATTRIB_SMDPAD_SMDEF
Aperture used for SMD pad. Excluded BGA pads which have their own type.
Definition: gbr_metadata.h:109
@ GBR_APERTURE_ATTRIB_SMDPAD_CUDEF
Aperture used for SMD pad with a solder mask defined by the solder mask.
Definition: gbr_metadata.h:112
@ GBR_APERTURE_ATTRIB_NONE
uninitialized attribute.
Definition: gbr_metadata.h:94
@ GBR_APERTURE_ATTRIB_CONNECTORPAD
Aperture used for edge connector pad (outer layers).
Definition: gbr_metadata.h:121
@ GBR_APERTURE_ATTRIB_CASTELLATEDDRILL
Aperture used for castellated pads in drill files.
Definition: gbr_metadata.h:138
@ GBR_APERTURE_ATTRIB_NONCONDUCTOR
Aperture used for not connected items (texts, outlines on copper).
Definition: gbr_metadata.h:102
@ GBR_APERTURE_ATTRIB_END
sentinel: max value
Definition: gbr_metadata.h:173
@ GBR_APERTURE_ATTRIB_CMP_POSITION
Aperture used for flashed cmp position in placement files.
Definition: gbr_metadata.h:151
@ GBR_APERTURE_ATTRIB_CMP_BODY
Aperture used to draw component physical body outline without pins in placement files.
Definition: gbr_metadata.h:160
@ GBR_APERTURE_ATTRIB_BGAPAD_SMDEF
Aperture used for BGA pads with a solder mask defined by the copper shape.
Definition: gbr_metadata.h:115
@ GBR_APERTURE_ATTRIB_WASHERPAD
Aperture used for mechanical pads (NPTH).
Definition: gbr_metadata.h:122
@ GBR_APERTURE_ATTRIB_PADOTHER_POS
Aperture used for flashed pads position in placement files.
Definition: gbr_metadata.h:157
@ GBR_APERTURE_ATTRIB_COMPONENTPAD
Aperture used for through hole component on outer layer.
Definition: gbr_metadata.h:106
@ GBR_APERTURE_ATTRIB_VIADRILL
Aperture used for via holes in drill files.
Definition: gbr_metadata.h:144
@ GBR_APERTURE_ATTRIB_CMP_FOOTPRINT
Aperture used to draw component footprint bounding box in placement files.
Definition: gbr_metadata.h:166
@ GBR_APERTURE_ATTRIB_CMP_LEAD2LEAD
Aperture used to draw component physical body outline with pins in placement files.
Definition: gbr_metadata.h:163
@ GBR_APERTURE_ATTRIB_FIDUCIAL_GLBL
Aperture used for fiducial pad (outer layers), at board level.
Definition: gbr_metadata.h:126
@ GBR_APERTURE_ATTRIB_CASTELLATEDPAD
Aperture used for castellated pads in copper layer files.
Definition: gbr_metadata.h:135
@ GBR_APERTURE_ATTRIB_FIDUCIAL_LOCAL
Aperture used for fiducial pad (outer layers), at footprint level.
Definition: gbr_metadata.h:129
@ GBR_APERTURE_ATTRIB_EDGECUT
Aperture used for board cutout,.
Definition: gbr_metadata.h:99
static std::string FormatAttribute(GBR_APERTURE_ATTRIB aAttribute, bool aUseX1StructuredComment, const std::string &aCustomAttribute)
std::string m_CustomAttribute
Definition: gbr_metadata.h:207
static std::string GetAttributeName(GBR_APERTURE_ATTRIB aAttribute)
std::string GetAttributeName()
Definition: gbr_metadata.h:183
std::string FormatAttribute(bool aUseX1StructuredComment)
Definition: gbr_metadata.h:199
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:215
void SetCopper(bool aValue)
Definition: gbr_metadata.h:270
void SetCmpReference(const wxString &aComponentRef)
Definition: gbr_metadata.h:259
void SetNetName(const wxString &aNetname)
Definition: gbr_metadata.h:247
std::string GetCustomAttribute()
Definition: gbr_metadata.h:235
void SetPadPinFunction(const wxString &aPadPinFunction, bool aUseUTF8, bool aEscapeString)
Definition: gbr_metadata.h:254
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:230
bool IsCopper()
Allowed attributes are not the same on board copper layers and on other layers.
Definition: gbr_metadata.h:269
void SetApertureAttrib(GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
Definition: gbr_metadata.h:219
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:280
int GetNetAttribType() const
Definition: gbr_metadata.h:242
void SetNetAttribType(int aNetAttribType)
Definition: gbr_metadata.h:237
GBR_APERTURE_METADATA m_ApertureMetadata
An item to handle aperture attribute.
Definition: gbr_metadata.h:275
void SetApertureAttrib(std::string aCustomAttribute)
Definition: gbr_metadata.h:224
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:288
void SetPadName(const wxString &aPadname, bool aUseUTF8=false, bool aEscapeString=false)
Definition: gbr_metadata.h:249
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.