StrToNumber

Now reading version 20. For the latest, read: StrToNumber for version 21

Parent page: PCB Query Functions - Parameters

Summary

Converts the nominated Parameter Value string to a number, using the stipulated unit type.

Syntax

StrToNumber(Value : String , Unit : String) : Number

Example Usage

StrToNumber(ParameterValue('VoltageRating'),V)  >  50
Converts the Value string returned by the VoltageRating Parameter to a number, using Voltage (V) as the unit, then returns all objects with a Value greater than 50V.

StrToNumber(ParameterValue('Resistance'),Ohms) Between 1000 And 10000
Converts the Value string returned by the Resistance Parameter to a number, using Ohms as the unit, then returns all objects with a Value between 1kΩ and 10kΩ.

StrToNumber(ParameterValue('CapacitanceValue'),F) < 2e-9
Converts the Value string returned by the CapacitanceValue Parameter to a number, using Capacitance (F) as the unit, then returns all objects with a Value less than 2nF (2e-9 in scientific notation).

TIPS

A scripting error will be thrown if the Value string cannot be converted to a number. To allow for this situation, use the StrToNumberDef function, which returns a nominated default number if the conversion fails.

The unit-aware string-to-number converter function accepts a large range of Unit type definitions, including:

  • V – Voltage
  • A – Current
  • Ohm – Resistance
  • Z – Impedance
  • F – Capacitance
  • H – Inductance
  • G – Conductance
  • W – Power
  • Hz – Frequency
  • Q – Charge
  • C – Temperature
  • dB – Decibels
  • % – Percent
  • m – Length
  • Kg – Mass
  • s – Time

The converter accepts standard value scaling factors (micro, kilo, mega etc) and therefore Parameter strings containing prefix abbreviations such as mV, uA, kHz etc.

Several value constructs are also supported. For example, the same resistance value can be represented as:

  • 2k2
  • 2.2k
  • 2200
  • 2,200
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Note

The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.