KiCad PCB EDA Suite
X2_ATTRIBUTE_FILEFUNCTION Class Reference

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

#include <class_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

class 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 class_X2_gerber_attributes.h.

Constructor & Destructor Documentation

X2_ATTRIBUTE_FILEFUNCTION::X2_ATTRIBUTE_FILEFUNCTION ( X2_ATTRIBUTE aAttributeBase)

Definition at line 170 of file class_X2_gerber_attributes.cpp.

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

171  : X2_ATTRIBUTE()
172 {
173  m_Prms = aAttributeBase.GetPrms();
174  m_z_order = 0;
175 
176  // ensure at least 7 parameters exist.
177  while( GetPrmCount() < 7 )
178  m_Prms.Add( wxEmptyString );
179 
180  set_Z_Order();
181 }
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, if starting by '.

Member Function Documentation

void X2_ATTRIBUTE::DbgListPrms ( )
inherited

Debug function: pring using wxLogMessage le list of parameters.

Definition at line 84 of file class_X2_gerber_attributes.cpp.

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

85 {
86  wxLogMessage( wxT("prms count %d"), GetPrmCount() );
87 
88  for( int ii = 0; ii < GetPrmCount(); ii++ )
89  wxLogMessage( m_Prms.Item( ii ) );
90 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.
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 63 of file class_X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

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

64 {
65  return m_Prms.Item( 0 );
66 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.
const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetBrdLayerId ( )

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

Definition at line 189 of file class_X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

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

190 {
191  // the brd layer identifier: Ln (for Copper type) or Top, Bot
192  return m_Prms.Item( 2 );
193 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.
const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetBrdLayerSide ( )

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

Definition at line 203 of file class_X2_gerber_attributes.cpp.

References IsCopper(), and X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

204 {
205  if( IsCopper() )
206  // the brd layer identifier: Top, Bot, Inr
207  return m_Prms.Item( 3 );
208  else
209  // the brd layer identifier: Top, Bot ( same as GetBrdLayerId() )
210  return m_Prms.Item( 2 );
211 }
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, if starting by '.
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 195 of file class_X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

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

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

Definition at line 183 of file class_X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

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

184 {
185  // the type of layer (Copper, Soldermask ... )
186  return m_Prms.Item( 1 );
187 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.
const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetLabel ( )

the filefunction label, if any

Definition at line 214 of file class_X2_gerber_attributes.cpp.

References IsCopper(), and X2_ATTRIBUTE::m_Prms.

215 {
216  if( IsCopper() )
217  return m_Prms.Item( 4 );
218  else
219  return m_Prms.Item( 3 );
220 }
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, if starting by '.
const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetLPType ( )
Returns
the Layer Pair type for drill files (PTH, NPTH, Blind or Buried)

Definition at line 223 of file class_X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

224 {
225  // Only for drill files: the Layer Pair type (PTH, NPTH, Blind or Buried)
226  return m_Prms.Item( 4 );
227 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.
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 73 of file class_X2_gerber_attributes.cpp.

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

Referenced by GERBER_FILE_IMAGE::ExecuteRS274XCommand(), and GERBER_FILE_IMAGE::RemoveAttribute().

74 {
75  static const wxString dummy;
76 
77  if( GetPrmCount() > aIdx && aIdx >= 0 )
78  return m_Prms.Item( aIdx );
79 
80  return dummy;
81 }
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.
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 class_X2_gerber_attributes.h.

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

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, if starting by '.
wxArrayString& X2_ATTRIBUTE::GetPrms ( )
inlineinherited
Returns
the parameters list read in TF command.

Definition at line 68 of file class_X2_gerber_attributes.h.

References X2_ATTRIBUTE::m_Prms.

Referenced by X2_ATTRIBUTE_FILEFUNCTION().

68 { return m_Prms; }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.
const wxString & X2_ATTRIBUTE_FILEFUNCTION::GetRouteType ( )
Returns
the drill/routing type for drill files (Drill, Route, Mixed)

Definition at line 230 of file class_X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

231 {
232  // Only for drill files: the drill/routing type(Drill, Route, Mixed)
233  return m_Prms.Item( 5 );
234 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.
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 class_X2_gerber_attributes.h.

References m_z_order.

Referenced by sortZorder().

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 class_X2_gerber_attributes.h.

Referenced by sortZorder().

bool X2_ATTRIBUTE_FILEFUNCTION::IsCopper ( )

return true if the filefunction type is "Copper"

Definition at line 237 of file class_X2_gerber_attributes.cpp.

References GetFileType().

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

238 {
239  // the filefunction label, if any
240  return GetFileType().IsSameAs( wxT( "Copper" ), false );
241 }
const wxString & GetFileType()
the type of layer (Copper, Soldermask ... )
bool X2_ATTRIBUTE_FILEFUNCTION::IsDrillFile ( )
Returns
true if the filefunction type is "Plated" or "NotPlated" therefore a drill file

Definition at line 244 of file class_X2_gerber_attributes.cpp.

References GetFileType().

Referenced by GERBER_FILE_IMAGE_LIST::GetDisplayName().

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

return true if the attribute is .FileFunction

Definition at line 112 of file class_X2_gerber_attributes.h.

References X2_ATTRIBUTE::GetAttribute().

Referenced by GERBER_FILE_IMAGE::Execute_G_Command(), and GERBER_FILE_IMAGE::ExecuteRS274XCommand().

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

return true if the attribute is .MD5

Definition at line 120 of file class_X2_gerber_attributes.h.

References X2_ATTRIBUTE::GetAttribute().

Referenced by GERBER_FILE_IMAGE::ExecuteRS274XCommand().

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

return true if the attribute is .Part

Definition at line 128 of file class_X2_gerber_attributes.h.

References X2_ATTRIBUTE::GetAttribute().

Referenced by GERBER_FILE_IMAGE::ExecuteRS274XCommand().

129  {
130  return GetAttribute().IsSameAs( wxT(".Part"), false );
131  }
const wxString & GetAttribute()
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 92 of file class_X2_gerber_attributes.cpp.

References X2_ATTRIBUTE::m_Prms.

Referenced by GERBER_FILE_IMAGE::Execute_G_Command(), GERBER_FILE_IMAGE::ExecuteRS274XCommand(), and EXCELLON_IMAGE::LoadFile().

94 {
95  // parse a TF command and fill m_Prms by the parameters found.
96  // the "%TF" (start of command) is already read by the caller
97 
98  bool ok = true;
99  wxString data;
100 
101  for( ; ; )
102  {
103  while( *aText )
104  {
105  switch( *aText )
106  {
107  case '%': // end of command
108  return ok; // success completion
109 
110  case ' ':
111  case '\r':
112  case '\n':
113  aText++;
114  break;
115 
116  case '*': // End of block
117  m_Prms.Add( data );
118  data.Empty();
119  aText++;
120  break;
121 
122  case ',': // End of parameter (separator)
123  aText++;
124  m_Prms.Add( data );
125  data.Empty();
126  break;
127 
128  default:
129  data.Append( *aText );
130  aText++;
131  break;
132  }
133  }
134 
135  // end of current line, read another one.
136  if( aBuffer )
137  {
138  if( fgets( aBuffer, aBuffSize, aFile ) == NULL )
139  {
140  // end of file
141  ok = false;
142  break;
143  }
144 
145  aLineNum++;
146  aText = aBuffer;
147  }
148  else
149  return ok;
150  }
151 
152  return ok;
153 }
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name, if starting by '.
void X2_ATTRIBUTE_FILEFUNCTION::set_Z_Order ( )
private

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

Definition at line 257 of file class_X2_gerber_attributes.cpp.

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

Referenced by X2_ATTRIBUTE_FILEFUNCTION().

258 {
259  m_z_order = -100; // low level
260  m_z_sub_order = 0;
261 
262  if( IsCopper() )
263  {
264  // Copper layer: the priority is the layer Id
265  m_z_order = 0;
266  wxString num = GetBrdLayerId().Mid( 1 );
267  long lnum;
268  if( num.ToLong( &lnum ) )
269  m_z_sub_order = -lnum;
270  }
271 
272  if( GetFileType().IsSameAs( wxT( "Paste" ), false ) )
273  {
274  // solder paste layer: the priority is top then bottom
275  m_z_order = 1; // for top
276 
277  if( GetBrdLayerId().IsSameAs( wxT( "Bot" ), false ) )
278  m_z_order = -m_z_order;
279  }
280 
281  if( GetFileType().IsSameAs( wxT( "Soldermask" ), false ) )
282  {
283  // solder mask layer: the priority is top then bottom
284  m_z_order = 2; // for top
285 
286  if( GetBrdLayerId().IsSameAs( wxT( "Bot" ), false ) )
287  m_z_order = -m_z_order;
288  }
289 
290  if( GetFileType().IsSameAs( wxT( "Legend" ), false ) )
291  {
292  // Silk screen layer: the priority is top then bottom
293  m_z_order = 3; // for top
294 
295  if( GetFileType().IsSameAs( wxT( "Legend" ), false ) )
296 
297  if( GetBrdLayerId().IsSameAs( wxT( "Bot" ), false ) )
298  m_z_order = -m_z_order;
299  }
300 }
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

Member Data Documentation

wxArrayString X2_ATTRIBUTE::m_Prms
protectedinherited
int X2_ATTRIBUTE_FILEFUNCTION::m_z_order
private

Definition at line 152 of file class_X2_gerber_attributes.h.

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

int X2_ATTRIBUTE_FILEFUNCTION::m_z_sub_order
private

Definition at line 153 of file class_X2_gerber_attributes.h.

Referenced by set_Z_Order().


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