KiCad PCB EDA Suite
AM_PARAM Class Reference

AM_PARAM holds a parameter value for an "aperture macro" as defined within standard RS274X. More...

#include <am_param.h>

Public Member Functions

 AM_PARAM ()
 
void PushOperator (parm_item_type aType, double aValue)
 function PushOperator add an operator/operand to the current stack More...
 
void PushOperator (parm_item_type aType, int aValue=0)
 
double GetValue (const D_CODE *aDcode) const
 
bool IsImmediate () const
 Function IsImmediate tests if this AM_PARAM holds an immediate parameter or is a pointer into a parameter held by an owning D_CODE. More...
 
unsigned GetIndex () const
 
void SetIndex (int aIndex)
 
bool ReadParam (char *&aText)
 Function ReadParam Read one aperture macro parameter a parameter can be: a number a reference to an aperture definition parameter value: $1 ot $3 ... More...
 

Private Attributes

int m_index
 
std::vector< AM_PARAM_ITEMm_paramStack
 

Detailed Description

AM_PARAM holds a parameter value for an "aperture macro" as defined within standard RS274X.

The parameter can be a constant, i.e. "immediate" parameter, or depend on some defered values, defined in a D_CODE, by the ADD command. Note the actual value could need an evaluation from an arithmetical expression items in the expression are stored in . A simple definition is just a value stored in one item in m_paramStack

Definition at line 286 of file am_param.h.

Constructor & Destructor Documentation

◆ AM_PARAM()

AM_PARAM::AM_PARAM ( )

Definition at line 49 of file am_param.cpp.

50 {
51  m_index = -1;
52 }
int m_index
Definition: am_param.h:289

References m_index.

Member Function Documentation

◆ GetIndex()

unsigned AM_PARAM::GetIndex ( ) const
inline

Definition at line 316 of file am_param.h.

317  {
318  return (unsigned) m_index;
319  }
int m_index
Definition: am_param.h:289

References m_index.

◆ GetValue()

double AM_PARAM::GetValue ( const D_CODE aDcode) const

Definition at line 74 of file am_param.cpp.

75 {
76  // In macros, actual values are sometimes given by an expression like:
77  // 0-$2/2-$4
78  // Because arithmetic predence is used, the parameters (values (double) and operators)
79  // are stored in a stack, with all numeric values converted to the actual values
80  // when they are defered parameters
81  // Each item is stored in a AM_PARAM_EVAL (a value or an operator)
82  //
83  // Then the stack with all values resolved is parsed and numeric values
84  // calculated according to the precedence of operators
85  double curr_value = 0.0;
86  parm_item_type op_code;
87 
89 
90  for( unsigned ii = 0; ii < m_paramStack.size(); ii++ )
91  {
92  AM_PARAM_ITEM item = m_paramStack[ii];
93 
94  switch( item.GetType() )
95  {
96  case ADD:
97  case SUB:
98  case MUL:
99  case DIV: // just an operator for next parameter value
100  case OPEN_PAR:
101  case CLOSE_PAR: // Priority modifiers: store in stack
102  op_code = item.GetType();
103  ops.push_back( AM_PARAM_EVAL( op_code ) );
104  break;
105 
106  case PUSHPARM:
107  // a defered value: get the actual parameter from the aDcode
108  if( aDcode ) // should be always true here
109  {
110  if( item.GetIndex() <= aDcode->GetParamCount() )
111  {
112  curr_value = aDcode->GetParam( item.GetIndex() );
113  }
114  else // Get parameter from local param definition
115  {
116  const APERTURE_MACRO * am_parent = aDcode->GetMacro();
117  curr_value = am_parent->GetLocalParam( aDcode, item.GetIndex() );
118  }
119  }
120  else
121  {
122  wxFAIL_MSG( "AM_PARAM::GetValue(): NULL param aDcode" );
123  }
124 
125  ops.push_back( AM_PARAM_EVAL( curr_value ) );
126  break;
127 
128  case PUSHVALUE: // a value is on the stack:
129  curr_value = item.GetValue();
130  ops.push_back( AM_PARAM_EVAL( curr_value ) );
131  break;
132 
133  default:
134  wxFAIL_MSG( wxString::Format( "AM_PARAM::GetValue(): dcode %d prm %d/%d: "
135  "unexpected type %d",
136  aDcode ? aDcode->m_Num_Dcode : -1, ii,
137  m_paramStack.size(), item.GetType() ) );
138  break;
139  }
140  }
141 
142  double result = Evaluate( ops );
143 
144  return result;
145 }
std::vector< AM_PARAM_ITEM > m_paramStack
Definition: am_param.h:290
unsigned GetParamCount() const
GetParamCount() Returns the number of parameters stored in parameter list.
Definition: dcode.h:131
unsigned GetIndex() const
Definition: am_param.h:257
parm_item_type GetType() const
Definition: am_param.h:252
AM_PARAM holds an operand for an AM_PARAM as defined within standard RS274X.
Definition: am_param.h:220
double Evaluate(AM_PARAM_EVAL_STACK &aExp)
Evaluate an basic arithmetic expression (infix notation) with precedence The expression is a sequence...
Definition: evaluate.cpp:102
double GetLocalParam(const D_CODE *aDcode, unsigned aParamId) const
function GetLocalParam Usually, parameters are defined inside the aperture primitive using immediate ...
parm_item_type
Definition: am_param.h:148
int m_Num_Dcode
D code value ( >= 10 )
Definition: dcode.h:96
double GetParam(unsigned aIdx) const
GetParam() Returns a parameter stored in parameter list.
Definition: dcode.h:141
std::vector< AM_PARAM_EVAL > AM_PARAM_EVAL_STACK
Definition: am_param.h:210
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
This helper class hold a value or an arithmetic operator to calculate the final value of a aperture m...
Definition: am_param.h:160
double GetValue() const
Definition: am_param.h:247
APERTURE_MACRO * GetMacro() const
Definition: dcode.h:157
Struct APERTURE_MACRO helps support the "aperture macro" defined within standard RS274X.
Definition: am_primitive.h:162

References ADD, CLOSE_PAR, DIV, Evaluate(), Format(), AM_PARAM_ITEM::GetIndex(), APERTURE_MACRO::GetLocalParam(), D_CODE::GetMacro(), D_CODE::GetParam(), D_CODE::GetParamCount(), AM_PARAM_ITEM::GetType(), AM_PARAM_ITEM::GetValue(), D_CODE::m_Num_Dcode, m_paramStack, MUL, OPEN_PAR, PUSHPARM, PUSHVALUE, and SUB.

Referenced by APERTURE_MACRO::GetLocalParam().

◆ IsImmediate()

bool AM_PARAM::IsImmediate ( ) const

Function IsImmediate tests if this AM_PARAM holds an immediate parameter or is a pointer into a parameter held by an owning D_CODE.

Function IsImmediate tests if this AM_PARAM holds an immediate parameter or has parameter held by an owning D_CODE.

Returns
true if the value is immediate, i.e. no defered value in operands used in its definition

Definition at line 59 of file am_param.cpp.

60 {
61  bool is_immediate = true;
62  for( unsigned ii = 0; ii < m_paramStack.size(); ii++ )
63  {
64  if( m_paramStack[ii].IsDefered() )
65  { // a defered value is found in operand list,
66  // so the parameter is not immediate
67  is_immediate = false;
68  break;
69  }
70  }
71  return is_immediate;
72 }
std::vector< AM_PARAM_ITEM > m_paramStack
Definition: am_param.h:290

References m_paramStack.

◆ PushOperator() [1/2]

void AM_PARAM::PushOperator ( parm_item_type  aType,
double  aValue 
)

function PushOperator add an operator/operand to the current stack

add an operator/operand to the current stack aType = NOP, PUSHVALUE, PUSHPARM, ADD, SUB, MUL, DIV, EQUATE aValue required only for PUSHVALUE (double) or PUSHPARM (int) aType.

Parameters
aType= the type of item (NOP, PUSHVALUE, PUSHPARM, ADD, SUB, MUL, DIV, EQUATE)
aValue= the item value, double for PUSHVALUE or int for PUSHPARM type.

Definition at line 152 of file am_param.cpp.

153 {
154  AM_PARAM_ITEM item( aType, aValue);
155  m_paramStack.push_back( item );
156 }
std::vector< AM_PARAM_ITEM > m_paramStack
Definition: am_param.h:290
AM_PARAM holds an operand for an AM_PARAM as defined within standard RS274X.
Definition: am_param.h:220

References m_paramStack.

Referenced by ReadParam().

◆ PushOperator() [2/2]

void AM_PARAM::PushOperator ( parm_item_type  aType,
int  aValue = 0 
)

Definition at line 158 of file am_param.cpp.

159 {
160  AM_PARAM_ITEM item( aType, aValue);
161  m_paramStack.push_back( item );
162 }
std::vector< AM_PARAM_ITEM > m_paramStack
Definition: am_param.h:290
AM_PARAM holds an operand for an AM_PARAM as defined within standard RS274X.
Definition: am_param.h:220

References m_paramStack.

◆ ReadParam()

bool AM_PARAM::ReadParam ( char *&  aText)

Function ReadParam Read one aperture macro parameter a parameter can be: a number a reference to an aperture definition parameter value: $1 ot $3 ...

a parameter definition can be complex and have operators between numbers and/or other parameter like $1+3 or $2x2.. Parameters are separated by a comma ( of finish by *)

Parameters
aText= pointer to the parameter to read. Will be modified to point to the next field
Returns
true if a param is read, or false

a parameter definition can be complex and have operators between numbers and/or other parameter like $1+3 or $2x2.. Note minus sign is not always an operator. It can be the sign of a value. Parameters are separated by a comma ( of finish by *)

Parameters
aText= pointer to the parameter to read. Will be modified to point to the next field
Returns
true if a param is read, or false

Definition at line 177 of file am_param.cpp.

178 {
179  bool found = false;
180  int ivalue;
181  double dvalue;
182  bool end = false;
183 
184  while( !end )
185  {
186  switch( *aText )
187  {
188  case ',':
189  aText++;
190 
191  if( !found ) // happens when a string starts by ',' before any param
192  break; // just skip this separator
193 
195 
196  case '\n':
197  case '\r':
198  case 0: // EOL
199  case '*': // Terminator in a gerber command
200  end = true;
201  break;
202 
203  case ' ':
204  aText++;
205  break;
206 
207  case '$':
208  // defered value defined later, in ADD command which define defered parameters
209  ++aText;
210  ivalue = ReadInt( aText, false );
211  if( m_index < 1 )
212  SetIndex( ivalue );
213  PushOperator( PUSHPARM, ivalue );
214  found = true;
215  break;
216 
217  case '/':
218  PushOperator( DIV );
219  aText++;
220  break;
221 
222  case '(': // Open a block to evaluate an expression between '(' and ')'
224  aText++;
225  break;
226 
227  case ')': // close a block between '(' and ')'
229  aText++;
230  break;
231 
232  case 'x':
233  case 'X':
234  PushOperator( MUL );
235  aText++;
236  break;
237 
238  case '-':
239  case '+':
240  // Test if this is an operator between 2 params, or the sign of a value
241  if( m_paramStack.size() > 0 && !m_paramStack.back().IsOperator() )
242  { // Seems an operator
243  PushOperator( *aText == '+' ? ADD : SUB );
244  aText++;
245  }
246  else
247  { // seems the sign of a value
248  dvalue = ReadDouble( aText, false );
249  PushOperator( PUSHVALUE, dvalue );
250  found = true;
251  }
252  break;
253 
254  case '=': // A local definition found like $4=$3/2
255  // At this point, one defered parameter is expected to be read.
256  // this parameter value (the index) is stored in m_index.
257  // The list of items is cleared
258  aText++;
259  m_paramStack.clear();
260  found = false;
261  break;
262 
263  default:
264  dvalue = ReadDouble( aText, false );
265  PushOperator( PUSHVALUE, dvalue );
266  found = true;
267  break;
268  }
269  }
270 
271  return found;
272 }
std::vector< AM_PARAM_ITEM > m_paramStack
Definition: am_param.h:290
double ReadDouble(char *&text, bool aSkipSeparator=true)
Function ReadDouble reads a double from an ASCII character buffer.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83
void PushOperator(parm_item_type aType, double aValue)
function PushOperator add an operator/operand to the current stack
Definition: am_param.cpp:152
int ReadInt(char *&text, bool aSkipSeparator=true)
Function ReadInt reads an int from an ASCII character buffer.
void SetIndex(int aIndex)
Definition: am_param.h:321
int m_index
Definition: am_param.h:289

References ADD, CLOSE_PAR, DIV, KI_FALLTHROUGH, m_index, m_paramStack, MUL, OPEN_PAR, PushOperator(), PUSHPARM, PUSHVALUE, ReadDouble(), ReadInt(), SetIndex(), and SUB.

Referenced by GERBER_FILE_IMAGE::ReadApertureMacro().

◆ SetIndex()

void AM_PARAM::SetIndex ( int  aIndex)
inline

Definition at line 321 of file am_param.h.

322  {
323  m_index = aIndex;
324  }
int m_index
Definition: am_param.h:289

References m_index.

Referenced by ReadParam().

Member Data Documentation

◆ m_index

int AM_PARAM::m_index
private

Definition at line 289 of file am_param.h.

Referenced by AM_PARAM(), GetIndex(), ReadParam(), and SetIndex().

◆ m_paramStack

std::vector<AM_PARAM_ITEM> AM_PARAM::m_paramStack
private

Definition at line 290 of file am_param.h.

Referenced by GetValue(), IsImmediate(), PushOperator(), and ReadParam().


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