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 volts (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).
Notes
A scripting error will be thrown if the value string cannot be converted to a number. To allow for this situation, use the StrToNumber 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:
