KiCad PCB EDA Suite
X2_ATTRIBUTE_FILEFUNCTION Class Reference

X2_ATTRIBUTE_FILEFUNCTION ( from TF.FileFunction in Gerber file) Example file function: TF.FileFunction,Copper,L1,Top*%. More...

#include <X2_gerber_attributes.h>

Inheritance diagram for X2_ATTRIBUTE_FILEFUNCTION:
X2_ATTRIBUTE

Public Member Functions

 X2_ATTRIBUTE_FILEFUNCTION (X2_ATTRIBUTE &aAttributeBase)
 
bool IsCopper ()
 return true if the filefunction type is "Copper" More...
 
bool IsDrillFile ()
 
const wxString & GetFileType ()
 the type of layer (Copper, Soldermask ... ) More...
 
const wxString & GetBrdLayerId ()
 the brd layer identifier: Ln, only for Copper type or Top, Bot for other types More...
 
const wxString GetDrillLayerPair ()
 
const wxString & GetLPType ()
 
const wxString & GetRouteType ()
 
const wxString & GetBrdLayerSide ()
 the brd layer Pos: Top, Bot, Inr same as GetBrdLayerId() for non copper type More...
 
const wxString & GetLabel ()
 the filefunction label, if any More...
 
int GetZOrder ()
 the Order of the board layer, from front (Top) side to back (Bot) side More...
 
int GetZSubOrder ()
 the Order of the bdr copper layer, from front (Top) side to back (Bot) side More...
 
wxArrayString & GetPrms ()
 
const wxString & GetPrm (int aIdx)
 
const wxString & GetAttribute ()
 
int GetPrmCount ()
 
bool ParseAttribCmd (FILE *aFile, char *aBuffer, int aBuffSize, char *&aText, int &aLineNum)
 parse a TF command terminated with a % and fill m_Prms by the parameters found. More...
 
void DbgListPrms ()
 Debug function: pring using wxLogMessage le list of parameters. More...
 
bool IsFileFunction ()
 return true if the attribute is .FileFunction More...
 
bool IsFileMD5 ()
 return true if the attribute is .MD5 More...
 
bool IsFilePart ()
 return true if the attribute is .Part More...
 

Protected Attributes

wxArrayString m_Prms
 the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '. More...
 

Private Member Functions

void set_Z_Order ()
 Initialize the z order priority of the current file, from its attributes. More...
 

Private Attributes

int m_z_order
 
int m_z_sub_order
 

Detailed Description

X2_ATTRIBUTE_FILEFUNCTION ( from TF.FileFunction in Gerber file) Example file function: TF.FileFunction,Copper,L1,Top*%.

  • Type. Such as copper, solder mask etc.
  • Position. Specifies where the file appears in the PCB layer structure. Corresponding position substring: Copper layer: L1, L2, L3...to indicate the layer position followed by Top, Inr or Bot. L1 is always the top copper layer. E.g. L2,Inr. Extra layer, e.g. solder mask: Top or Bot - defines the attachment of the layer. Drill/rout layer: E.g. 1,4 - where 1 is the start and 4 is the end copper layer. The pair 1,4 defines the span of the drill/rout file Optional index. This can be used in instances where for example there are two solder masks on the same side. The index counts from the PCB surface outwards.

Definition at line 150 of file X2_gerber_attributes.h.

Constructor & Destructor Documentation

◆ X2_ATTRIBUTE_FILEFUNCTION()

X2_ATTRIBUTE_FILEFUNCTION::X2_ATTRIBUTE_FILEFUNCTION ( X2_ATTRIBUTE aAttributeBase)

Definition at line 171 of file X2_gerber_attributes.cpp.

172  : X2_ATTRIBUTE()
173 {
174  m_Prms = aAttributeBase.GetPrms();
175  m_z_order = 0;
176 
177  // ensure at least 7 parameters exist.
178  while( GetPrmCount() < 7 )
179  m_Prms.Add( wxEmptyString );
180 
181  set_Z_Order();
182 }
wxArrayString & GetPrms()
void set_Z_Order()
Initialize the z order priority of the current file, from its attributes.
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References X2_ATTRIBUTE::GetPrmCount(), X2_ATTRIBUTE::GetPrms(), X2_ATTRIBUTE::m_Prms, m_z_order, and set_Z_Order().

Member Function Documentation

◆ DbgListPrms()

void X2_ATTRIBUTE::DbgListPrms ( )
inherited

Debug function: pring using wxLogMessage le list of parameters.

Definition at line 85 of file X2_gerber_attributes.cpp.

86 {
87  wxLogMessage( wxT("prms count %d"), GetPrmCount() );
88 
89  for( int ii = 0; ii < GetPrmCount(); ii++ )
90  wxLogMessage( m_Prms.Item( ii ) );
91 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References X2_ATTRIBUTE::GetPrmCount(), and X2_ATTRIBUTE::m_Prms.

◆ GetAttribute()

const wxString & X2_ATTRIBUTE::GetAttribute ( )
inherited
Returns
the attribute name (for instance .FileFunction) which is given by TF command (i.e. the first parameter read).

Definition at line 64 of file X2_gerber_attributes.cpp.

65 {
66  return m_Prms.Item( 0 );
67 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References X2_ATTRIBUTE::m_Prms.

Referenced by X2_ATTRIBUTE::IsFileFunction(), X2_ATTRIBUTE::IsFileMD5(), and X2_ATTRIBUTE::IsFilePart().

◆ GetBrdLayerId()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetBrdLayerId ( )

the brd layer identifier: Ln, only for Copper type or Top, Bot for other types

Definition at line 190 of file X2_gerber_attributes.cpp.

191 {
192  // the brd layer identifier: Ln (for Copper type) or Top, Bot
193  return m_Prms.Item( 2 );
194 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References X2_ATTRIBUTE::m_Prms.

Referenced by LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), and set_Z_Order().

◆ GetBrdLayerSide()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetBrdLayerSide ( )

the brd layer Pos: Top, Bot, Inr same as GetBrdLayerId() for non copper type

Definition at line 204 of file X2_gerber_attributes.cpp.

205 {
206  if( IsCopper() )
207  // the brd layer identifier: Top, Bot, Inr
208  return m_Prms.Item( 3 );
209  else
210  // the brd layer identifier: Top, Bot ( same as GetBrdLayerId() )
211  return m_Prms.Item( 2 );
212 }
bool IsCopper()
return true if the filefunction type is "Copper"
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References IsCopper(), and X2_ATTRIBUTE::m_Prms.

Referenced by LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), and GERBER_FILE_IMAGE_LIST::GetDisplayName().

◆ GetDrillLayerPair()

const wxString X2_ATTRIBUTE_FILEFUNCTION::GetDrillLayerPair ( )
Returns
the brd layer pair identifier: n,m for drill files (files with m_Prms.Item( 1 ) = "Plated" or "NotPlated")

Definition at line 196 of file X2_gerber_attributes.cpp.

197 {
198  // the layer pair identifiers, for drill files, i.e.
199  // with m_Prms.Item( 1 ) = "Plated" or "NonPlated"
200  wxString lpair = m_Prms.Item( 2 ) + ',' + m_Prms.Item( 3 );
201  return lpair;
202 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

◆ GetFileType()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetFileType ( )

the type of layer (Copper, Soldermask ... )

Definition at line 184 of file X2_gerber_attributes.cpp.

185 {
186  // the type of layer (Copper, Soldermask ... )
187  return m_Prms.Item( 1 );
188 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References X2_ATTRIBUTE::m_Prms.

Referenced by LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), IsCopper(), IsDrillFile(), and set_Z_Order().

◆ GetLabel()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetLabel ( )

the filefunction label, if any

Definition at line 215 of file X2_gerber_attributes.cpp.

216 {
217  if( IsCopper() )
218  return m_Prms.Item( 4 );
219  else
220  return m_Prms.Item( 3 );
221 }
bool IsCopper()
return true if the filefunction type is "Copper"
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References IsCopper(), and X2_ATTRIBUTE::m_Prms.

◆ GetLPType()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetLPType ( )
Returns
the Layer Pair type for drill files (PTH, NPTH, Blind or Buried)

Definition at line 224 of file X2_gerber_attributes.cpp.

225 {
226  // Only for drill files: the Layer Pair type (PTH, NPTH, Blind or Buried)
227  return m_Prms.Item( 4 );
228 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

◆ GetPrm()

const wxString & X2_ATTRIBUTE::GetPrm ( int  aIdx)
inherited
Returns
a parameter read in TF command.
Parameters
aIdx= the index of the parameter aIdx = 0 is the parameter read after the TF function (the same as GetAttribute())

Definition at line 74 of file X2_gerber_attributes.cpp.

75 {
76  static const wxString dummy;
77 
78  if( GetPrmCount() > aIdx && aIdx >= 0 )
79  return m_Prms.Item( aIdx );
80 
81  return dummy;
82 }
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References dummy(), X2_ATTRIBUTE::GetPrmCount(), and X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE::RemoveAttribute().

◆ GetPrmCount()

int X2_ATTRIBUTE::GetPrmCount ( )
inlineinherited
Returns
the number of parameters read in TF (or similar like TA TO ...) command.

Definition at line 88 of file X2_gerber_attributes.h.

88 { return int( m_Prms.GetCount() ); }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References X2_ATTRIBUTE::m_Prms.

Referenced by X2_ATTRIBUTE::DbgListPrms(), X2_ATTRIBUTE::GetPrm(), and X2_ATTRIBUTE_FILEFUNCTION().

◆ GetPrms()

wxArrayString& X2_ATTRIBUTE::GetPrms ( )
inlineinherited
Returns
the parameters list read in TF command.

Definition at line 68 of file X2_gerber_attributes.h.

68 { return m_Prms; }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References X2_ATTRIBUTE::m_Prms.

Referenced by X2_ATTRIBUTE_FILEFUNCTION().

◆ GetRouteType()

const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetRouteType ( )
Returns
the drill/routing type for drill files (Drill, Route, Mixed)

Definition at line 231 of file X2_gerber_attributes.cpp.

232 {
233  // Only for drill files: the drill/routing type(Drill, Route, Mixed)
234  return m_Prms.Item( 5 );
235 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

◆ GetZOrder()

int X2_ATTRIBUTE_FILEFUNCTION::GetZOrder ( )
inline

the Order of the board layer, from front (Top) side to back (Bot) side

Definition at line 191 of file X2_gerber_attributes.h.

References m_z_order.

Referenced by sortZorder().

◆ GetZSubOrder()

int X2_ATTRIBUTE_FILEFUNCTION::GetZSubOrder ( )
inline

the Order of the bdr copper layer, from front (Top) side to back (Bot) side

Definition at line 193 of file X2_gerber_attributes.h.

Referenced by sortZorder().

◆ IsCopper()

bool X2_ATTRIBUTE_FILEFUNCTION::IsCopper ( )

return true if the filefunction type is "Copper"

Definition at line 238 of file X2_gerber_attributes.cpp.

239 {
240  // the filefunction label, if any
241  return GetFileType().IsSameAs( wxT( "Copper" ), false );
242 }
const wxString & GetFileType()
the type of layer (Copper, Soldermask ... )

References GetFileType().

Referenced by LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), GetBrdLayerSide(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), GetLabel(), and set_Z_Order().

◆ IsDrillFile()

bool X2_ATTRIBUTE_FILEFUNCTION::IsDrillFile ( )
Returns
true if the filefunction type is "Plated" or "NotPlated" therefore a drill file

Definition at line 245 of file X2_gerber_attributes.cpp.

246 {
247  // the filefunction label, if any
248  return GetFileType().IsSameAs( wxT( "Plated" ), false )
249  || GetFileType().IsSameAs( wxT( "NonPlated" ), false );
250 }
const wxString & GetFileType()
the type of layer (Copper, Soldermask ... )

References GetFileType().

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

◆ IsFileFunction()

bool X2_ATTRIBUTE::IsFileFunction ( )
inlineinherited

return true if the attribute is .FileFunction

Definition at line 112 of file X2_gerber_attributes.h.

113  {
114  return GetAttribute().IsSameAs( wxT(".FileFunction"), false );
115  }
const wxString & GetAttribute()

References X2_ATTRIBUTE::GetAttribute().

◆ IsFileMD5()

bool X2_ATTRIBUTE::IsFileMD5 ( )
inlineinherited

return true if the attribute is .MD5

Definition at line 120 of file X2_gerber_attributes.h.

121  {
122  return GetAttribute().IsSameAs( wxT(".MD5"), false );
123  }
const wxString & GetAttribute()

References X2_ATTRIBUTE::GetAttribute().

◆ IsFilePart()

bool X2_ATTRIBUTE::IsFilePart ( )
inlineinherited

return true if the attribute is .Part

Definition at line 128 of file X2_gerber_attributes.h.

129  {
130  return GetAttribute().IsSameAs( wxT(".Part"), false );
131  }
const wxString & GetAttribute()

References X2_ATTRIBUTE::GetAttribute().

◆ ParseAttribCmd()

bool X2_ATTRIBUTE::ParseAttribCmd ( FILE *  aFile,
char *  aBuffer,
int  aBuffSize,
char *&  aText,
int &  aLineNum 
)
inherited

parse a TF command terminated with a % and fill m_Prms by the parameters found.

Parameters
aFile= a FILE* ptr to the current Gerber file.
aBuffer= the buffer containing current Gerber data (can be null)
aBuffSize= the size of the buffer
aText= a pointer to the first char to read from Gerber data stored in aBuffer After parsing, text points the last char of the command line ('') (X2 mode) or the end of line if the line does not contain '' or aBuffer == NULL (X1 mode)
aLineNum= a point to the current line number of aFile
Returns
true if no error.

Definition at line 93 of file X2_gerber_attributes.cpp.

95 {
96  // parse a TF, TA, TO ... command and fill m_Prms by the parameters found.
97  // the "%TF" (start of command) is already read by the caller
98 
99  bool ok = true;
100  std::string data;
101 
102  for( ; ; )
103  {
104  while( *aText )
105  {
106  switch( *aText )
107  {
108  case '%': // end of command
109  return ok; // success completion
110 
111  case ' ':
112  case '\r':
113  case '\n':
114  aText++;
115  break;
116 
117  case '*': // End of block
118  m_Prms.Add( FROM_UTF8( data.c_str() ) );
119  data.clear();
120  aText++;
121  break;
122 
123  case ',': // End of parameter (separator)
124  aText++;
125  m_Prms.Add( FROM_UTF8( data.c_str() ) );
126  data.clear();
127  break;
128 
129  default:
130  data += *aText;
131  aText++;
132  break;
133  }
134  }
135 
136  // end of current line, read another one.
137  if( aBuffer && aFile )
138  {
139  if( fgets( aBuffer, aBuffSize, aFile ) == NULL )
140  {
141  // end of file
142  ok = false;
143  break;
144  }
145 
146  aLineNum++;
147  aText = aBuffer;
148  }
149  else
150  return ok;
151  }
152 
153  return ok;
154 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:114
#define NULL
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References FROM_UTF8(), X2_ATTRIBUTE::m_Prms, and NULL.

◆ set_Z_Order()

void X2_ATTRIBUTE_FILEFUNCTION::set_Z_Order ( )
private

Initialize the z order priority of the current file, from its attributes.

Definition at line 258 of file X2_gerber_attributes.cpp.

259 {
260  m_z_order = -100; // low level
261  m_z_sub_order = 0;
262 
263  if( IsCopper() )
264  {
265  // Copper layer: the priority is the layer Id
266  m_z_order = 0;
267  wxString num = GetBrdLayerId().Mid( 1 );
268  long lnum;
269  if( num.ToLong( &lnum ) )
270  m_z_sub_order = -lnum;
271  }
272 
273  if( GetFileType().IsSameAs( wxT( "Paste" ), false ) )
274  {
275  // solder paste layer: the priority is top then bottom
276  m_z_order = 1; // for top
277 
278  if( GetBrdLayerId().IsSameAs( wxT( "Bot" ), false ) )
279  m_z_order = -m_z_order;
280  }
281 
282  if( GetFileType().IsSameAs( wxT( "Soldermask" ), false ) )
283  {
284  // solder mask layer: the priority is top then bottom
285  m_z_order = 2; // for top
286 
287  if( GetBrdLayerId().IsSameAs( wxT( "Bot" ), false ) )
288  m_z_order = -m_z_order;
289  }
290 
291  if( GetFileType().IsSameAs( wxT( "Legend" ), false ) )
292  {
293  // Silk screen layer: the priority is top then bottom
294  m_z_order = 3; // for top
295 
296  if( GetBrdLayerId().IsSameAs( wxT( "Bot" ), false ) )
297  m_z_order = -m_z_order;
298  }
299 
300  if( GetFileType().IsSameAs( wxT( "Glue" ), false ) )
301  {
302  // Glue spots used to fix components to the board prior to soldering:
303  // the priority is top then bottom
304  m_z_order = 4; // for top
305 
306  if( GetBrdLayerId().IsSameAs( wxT( "Bot" ), false ) )
307  m_z_order = -m_z_order;
308  }
309 }
const wxString & GetFileType()
the type of layer (Copper, Soldermask ... )
bool IsCopper()
return true if the filefunction type is "Copper"
const wxString & GetBrdLayerId()
the brd layer identifier: Ln, only for Copper type or Top, Bot for other types

References GetBrdLayerId(), GetFileType(), IsCopper(), m_z_order, and m_z_sub_order.

Referenced by X2_ATTRIBUTE_FILEFUNCTION().

Member Data Documentation

◆ m_Prms

wxArrayString X2_ATTRIBUTE::m_Prms
protectedinherited

◆ m_z_order

int X2_ATTRIBUTE_FILEFUNCTION::m_z_order
private

Definition at line 152 of file X2_gerber_attributes.h.

Referenced by GetZOrder(), set_Z_Order(), and X2_ATTRIBUTE_FILEFUNCTION().

◆ m_z_sub_order

int X2_ATTRIBUTE_FILEFUNCTION::m_z_sub_order
private

Definition at line 153 of file X2_gerber_attributes.h.

Referenced by set_Z_Order().


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