KiCad PCB EDA Suite
X2_ATTRIBUTE Class Reference

class X2_ATTRIBUTE The attribute value consists of a number of substrings separated by a comma More...

#include <X2_gerber_attributes.h>

Inheritance diagram for X2_ATTRIBUTE:
X2_ATTRIBUTE_FILEFUNCTION

Public Member Functions

 X2_ATTRIBUTE ()
 
 ~X2_ATTRIBUTE ()
 
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...
 

Detailed Description

class X2_ATTRIBUTE The attribute value consists of a number of substrings separated by a comma

Definition at line 54 of file X2_gerber_attributes.h.

Constructor & Destructor Documentation

◆ X2_ATTRIBUTE()

X2_ATTRIBUTE::X2_ATTRIBUTE ( )

Definition at line 53 of file X2_gerber_attributes.cpp.

54 {
55 }

◆ ~X2_ATTRIBUTE()

X2_ATTRIBUTE::~X2_ATTRIBUTE ( )

Definition at line 57 of file X2_gerber_attributes.cpp.

58 {
59 }

Member Function Documentation

◆ DbgListPrms()

void X2_ATTRIBUTE::DbgListPrms ( )

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 GetPrmCount(), and m_Prms.

◆ GetAttribute()

const wxString & X2_ATTRIBUTE::GetAttribute ( )
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 m_Prms.

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

◆ GetPrm()

const wxString & X2_ATTRIBUTE::GetPrm ( int  aIdx)
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(), GetPrmCount(), and m_Prms.

Referenced by GERBER_FILE_IMAGE::RemoveAttribute().

◆ GetPrmCount()

int X2_ATTRIBUTE::GetPrmCount ( )
inline
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 m_Prms.

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

◆ GetPrms()

wxArrayString& X2_ATTRIBUTE::GetPrms ( )
inline
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 m_Prms.

Referenced by X2_ATTRIBUTE_FILEFUNCTION::X2_ATTRIBUTE_FILEFUNCTION().

◆ IsFileFunction()

bool X2_ATTRIBUTE::IsFileFunction ( )
inline

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 GetAttribute().

◆ IsFileMD5()

bool X2_ATTRIBUTE::IsFileMD5 ( )
inline

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 GetAttribute().

◆ IsFilePart()

bool X2_ATTRIBUTE::IsFilePart ( )
inline

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 GetAttribute().

◆ ParseAttribCmd()

bool X2_ATTRIBUTE::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.

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:62
wxArrayString m_Prms
the list of parameters (after TF) in gbr file the first one is the attribute name,...

References FROM_UTF8(), and m_Prms.

Member Data Documentation

◆ m_Prms


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