LabRPS: Created page with "{{TOCright}} ==Overview== It is possible to define properties using mathematical expressions. In the GUI, spin boxes or input fields that are bound to properties show a blue icon 16px when activated. Clicking on the icon or typing the equal sign {{KEY|=}} opens the expression editor for that particular property. If the input field shows a {{Button|...}} button instead of an icon, the expression editor can be opened by right-clicking..."

2024-10-28T17:48:00Z

Created page with "{{TOCright}} ==Overview== It is possible to define properties using mathematical expressions. In the GUI, spin boxes or input fields that are bound to properties show a blue icon 16px when activated. Clicking on the icon or typing the equal sign {{KEY|=}} opens the expression editor for that particular property. If the input field shows a {{Button|...}} button instead of an icon, the expression editor can be opened by right-clicking..."

New page

{{TOCright}}

==Overview==

It is possible to define properties using mathematical expressions. In the GUI, spin boxes or input fields that are bound to properties show a blue icon [[Image:Bound-expression.svg|16px]] when activated. Clicking on the icon or typing the equal sign {{KEY|=}} opens the expression editor for that particular property. If the input field shows a {{Button|...}} button instead of an icon, the expression editor can be opened by right-clicking the property and selecting {{MenuCommand|Expression...}} from the context menu.

A LabRPS expression is a mathematical expression using the standard mathematical [[#Supported_operators|operators]], [[#Supported_functions|functions]] and [[#Supported_constants|predefined constants]] as described below. In addition, the expression may reference object properties, and also use [[#Conditional_expressions|conditionals]]. Numbers in an expression may have an optional [[#Units|unit]] attached to them.

Numbers may use either a comma {{incode|,}} or a decimal point {{incode|.}} to separate whole digits from decimals. When the decimal marker is used, it ''must'' be followed by at least one digit. Thus, the expressions {{incode|1. + 2.}} and {{incode|1, + 2,}} are invalid, but {{incode|1.0 + 2.0}} and {{incode|1,0 + 2,0}} are valid.

Operators and functions are unit-aware, and require valid combinations of units, if supplied. For example, {{incode|2mm + 4mm}} is a valid expression, while {{incode|2mm + 4}} is not. This also applies to references to object properties that have units, such as Length properties. Thus {{incode|Pad001.Length + 1}} is invalid since it adds a pure number to a property with length units, it requires {{incode|Pad001.Length + 1mm}}.

Some unit related errors can seem unintuitive, with expressions either being rejected or producing results that do not match the units of the property being set. Here are some examples:

{{incode|1/2mm}} is not interpreted as half a millimeter but as {{incode|1/(2mm)}}, resulting in: {{incode|0.5 mm^-1}}.

{{incode|sqrt(2)mm}} is not valid because the function call is not a number. This has to be entered as {{incode|sqrt(2) * 1mm}}.

===Function arguments===

Multiple arguments to a function may be separated by either a semicolon {{incode|;}} or a comma followed by a space {{incode|, }}. In the latter case, the comma is converted to a semicolon after entry. When a semicolon is used, no trailing space is necessary.

Arguments may include references to cells in a spreadsheet. A cell reference consists of the cell's uppercase row letter followed by its column number, for example {{incode|A1}}. A cell may also be referenced by using the cell's alias instead, for example {{incode|Spreadsheet.NumberOfSample}}.

===Referencing objects===

As already shown above, you can reference an object by its {{PropertyData|Name}}. But you can also use its {{PropertyData|Label}}. In the case of a {{PropertyData|Label}}, it must be enclosed in double {{incode|<<}} and {{incode|>>}} symbols, such as {{incode|<<Label>>}}.

You can reference any property of an object. For example, to reference a Cylinder's height, you may use {{incode|Cylinder.Height}} or {{incode|<<Label_of_cylinder>>.Height}}.

For more information about referencing objects.

{{Top}}

== Supported constants ==

The following constants are supported:

{| class="wikitable"
!style="width: 33%;"|Constant
!style="width: 66%;"|Description
|-
| style="text-align:center;" | '''e'''
| [https://en.wikipedia.org/wiki/E_(mathematical_constant) Euler's number]
|-
| style="text-align:center;" | '''pi'''
| [https://en.wikipedia.org/wiki/Pi Pi]
|}

{{Top}}

== Supported operators ==

The following operators are supported:

{| class="wikitable"
!style="width: 33%;"|Operator
!style="width: 66%;"|Description
|-
| style="text-align:center;" |'''+'''
| [https://en.wikipedia.org/wiki/Addition Addition]
|-
| style="text-align:center;" |'''-'''
| [https://en.wikipedia.org/wiki/Subtraction Subtraction]
|-
| style="text-align:center;" | '''*'''
| [https://en.wikipedia.org/wiki/Multiplication Multiplication]
|-
| style="text-align:center;" | '''/'''
| Floating point [https://en.wikipedia.org/wiki/Division_(mathematics) Division]
|-
| style="text-align:center;" | '''%'''
| [https://en.wikipedia.org/wiki/Remainder Remainder]
|-
| style="text-align:center;" | '''^'''
| [https://en.wikipedia.org/wiki/Exponentiation Exponentiation]
|}

{{Top}}

== Supported functions ==

=== General mathematical functions ===

The following mathematical functions are supported:

==== Trigonometric functions ====

[https://en.wikipedia.org/wiki/Trigonometric_functions Trigonometric functions] use degree as their default unit. For radians add {{incode|rad}} following the first value in an expression. So e.g. {{incode|cos(45)}} is the same as {{incode|cos(pi rad / 4)}}. Expressions in degrees can use either {{incode|deg}} or {{incode|°}}, e.g. {{incode|360deg - atan2(3; 4)}} or {{incode|360° - atan2(3; 4)}}. If an expression is without units and needs to be converted to degrees or radians for compatibility, multiply by {{incode|1deg}}, {{incode|1°}} or {{incode|1rad}} as appropriate, e.g. {{incode|(360 - X) * 1deg}}; {{incode|(360 - X) * 1°}}; {{incode|(0.5 + pi / 2) * 1rad}}.

{| class="wikitable"
!style="width: 15%;"|Function
!style="width: 55%;"|Description
!style="width: 30%;"|Input range
|-
| {{incode|acos(x)}}
| [https://en.wikipedia.org/wiki/Inverse_trigonometric_functions#Basic_properties Arc cosine]
| -1 <= x <= 1
|-
| {{incode|asin(x)}}
| [https://en.wikipedia.org/wiki/Inverse_trigonometric_functions#Basic_properties Arc sine]
| -1 <= x <= 1
|-
| {{incode|atan(x)}}
| [https://en.wikipedia.org/wiki/Inverse_trigonometric_functions#Basic_properties Arc tangent], return value in the range -90° < value < 90°
| all
|-
| {{incode|atan2(y; x)}}
| [https://en.wikipedia.org/wiki/Inverse_trigonometric_functions#Basic_properties Arc tangent] of ''y/x'' accounting for quadrant, return value in the range -180° < value <= 180°
| all, the invalid input x = y = 0 returns 0
|-
| {{incode|cos(x)}}
| [https://en.wikipedia.org/wiki/Trigonometric_functions#Right-angled_triangle_definitions Cosine]
| all
|-
| {{incode|cosh(x)}}
| [https://en.wikipedia.org/wiki/Hyperbolic_function#Trigonometric_definitions Hyperbolic cosine]
| all
|-
| {{incode|sin(x)}}
| [https://en.wikipedia.org/wiki/Trigonometric_functions#Right-angled_triangle_definitions Sine]
| all
|-
| {{incode|sinh(x)}}
| [https://en.wikipedia.org/wiki/Hyperbolic_function#Trigonometric_definitions Hyperbolic sine]
| all
|-
| {{incode|tan(x)}}
| [https://en.wikipedia.org/wiki/Trigonometric_functions#Right-angled_triangle_definitions Tangent]
| all, except x = n*90 with n = odd integer
|-
| {{incode|tanh(x)}}
| [https://en.wikipedia.org/wiki/Hyperbolic_function#Trigonometric_definitions Hyperbolic tangent]
| all
|-
| {{incode|hypot(x; y)}}
| [https://en.wikipedia.org/wiki/Pythagorean_addition Pythagorean addition] ('''hypot'''enuse), e.g. hypot(4; 3) = 5
| x and y >= 0
|-
| {{incode|cath(x; y)}}
| Given hypotenuse, and one side, returns other side of triangle, e.g. cath(5; 3) = 4
| x >= y >= 0
|}

==== Exponential and logarithmic functions ====

{| class="wikitable"
!style="width: 33%;"|Function
!style="width: 33%;"|Description
!style="width: 33%;"|Input range
|-
| {{incode|exp(x)}}
| [https://en.wikipedia.org/wiki/Exponential_function#Formal_definition Exponential function]
| all
|-
| {{incode|log(x)}}
| [https://en.wikipedia.org/wiki/Natural_logarithm Natural logarithm]
| x > 0
|-
| {{incode|log10(x)}}
| [https://en.wikipedia.org/wiki/Common_logarithm Common logarithm]
| x > 0
|-
| {{incode|pow(x; y)}}
| [https://en.wikipedia.org/wiki/Exponentiation Exponentiation]
| all
|-
| {{incode|sqrt(x)}}
| [https://en.wikipedia.org/wiki/Square_root Square root]
| x >= 0
|}

==== Rounding, truncation and remainder functions ====

{| class="wikitable"
!style="width: 20%;"|Function
!style="width: 55%;"|Description
!style="width: 25%;"|Input range
|-
| {{incode|abs(x)}}
| [https://en.wikipedia.org/wiki/Absolute_value Absolute value]
| all
|-
| {{incode|ceil(x)}}
| [https://en.wikipedia.org/wiki/Floor_and_ceiling_functions Ceiling function], smallest integer value greater than or equal to x
| all
|-
| {{incode|floor(x)}}
| [https://en.wikipedia.org/wiki/Floor_and_ceiling_functions Floor function], largest integer value less than or equal to x
| all
|-
| {{incode|mod(x; y)}}
| [https://en.wikipedia.org/wiki/Remainder Remainder] after dividing ''x'' by ''y'', sign of result is that of the dividend.
| all, except y = 0
|-
| {{incode|round(x)}}
| [https://en.wikipedia.org/wiki/Rounding Rounding] to the nearest integer
| all
|-
| {{incode|trunc(x)}}
| [https://en.wikipedia.org/wiki/Truncation Truncation] to the nearest integer in the direction of zero
| all
|}

{{Top}}

=== Statistical / aggregate functions ===

[https://en.wikipedia.org/wiki/Aggregate_function Aggregate functions] take one or more arguments. 

Individual arguments to aggregate functions may consist of ranges of cells. A range of cells is expressed as two cell references separated by a colon {{Incode|:}}, for example {{Incode|average(B1:B8)}} or {{Incode|sum(A1:A4; B1:B4)}}.
The cell references may also use cell aliases, for example {{Incode|average(StartTemp:EndTemp)}}.

The following aggregate functions are supported:

{| class="wikitable"
!style="width: 20%;"|Function
!style="width: 55%;"|Description
!style="width: 25%;"|Input range
|-
| {{incode|average(a; b; c; ...)}}
| [https://en.wikipedia.org/wiki/Arithmetic_mean Average] value of the arguments, same as sum(a; b; c; ...) / count(a; b; c; ...)
| all
|-
| {{incode|count(a; b; c; ...)}}
| [https://en.wikipedia.org/wiki/Counting Count] of the arguments, typically used for cell ranges
| all
|-
| {{incode|max(a; b; c; ...)}}
| [https://en.wikipedia.org/wiki/Maxima_and_minima Maximum] value of the arguments
| all
|-
| {{incode|min(a; b; c; ...)}}
| [https://en.wikipedia.org/wiki/Maxima_and_minima Minimum] value of the arguments
| all
|-
| {{incode|stddev(a; b; c; ...)}}
| [https://en.wikipedia.org/wiki/standard_deviation Standard deviation] of the values of the arguments
| all
|-
| {{incode|sum(a; b; c; ...)}}
| [https://en.wikipedia.org/wiki/Summation Sum] of the values of the arguments, typically used for cell ranges
| all
|}

{{Top}}

=== String manipulation ===

==== String identification ====

Strings are identified in expressions by surrounding them with opening/closing double chevrons (as are labels).

In following example, "TEXT" is recognized as a string : {{incode|<<TEXT>>}}

==== String concatenation ====

Strings can be concatenated using the '+' sign.

Following example {{incode|<<MY>> + <<TEXT>>}} will be concatenated to "MYTEXT".

==== String conversion ====

Numerical values can be converted to strings with the {{incode|str}} function:

{{incode|str(SimulationPoint.Z.Value)}}

==== String formatting ====

String formatting is supported using the (old) %-style Python way.

All %-specifiers as defined in [https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting Python documentation].

{{Top}}

== Conditional expressions ==

Conditional expressions are of the form {{incode|condition ? resultTrue : resultFalse}}. The condition is defined as an expression that evaluates to either {{incode|0}} (false) or non-zero (true).

Note that to use a boolean property as the condition this syntax must be used: {{incode|VarSet.MyBool == 1 ? 10 mm : 15 mm}}.

The following [https://en.wikipedia.org/wiki/Relational_operator#Standard_relational_operators relational operators] are defined:
{| class="wikitable"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| style="text-align:center;" | '''=='''
| equal to
|-
| style="text-align:center;" | '''!='''
| not equal to
|-
| style="text-align:center;" | '''>'''
| greater than
|-
| style="text-align:center;" | '''<'''
| less than
|-
| style="text-align:center;" | '''>='''
| greater than or equal to
|-
| style="text-align:center;" | '''<='''
| less than or equal to
|}

{{Top}}

== Units ==

Units can be used directly in expressions. The parser connects them to the previous value. So {{incode|2mm}} or {{incode|2 mm}} is valid while {{incode|mm}} is invalid because there is no preceding value.

All values must have a unit. Therefore you must in general use a unit for values in spreadsheets. 
In some cases it works even without a unit, for example if you have e.g. in spreadsheet cell B1 just the number {{incode|1.5}} and refer to it for a pad height. This only works because the pad height predefines the unit {{incode|mm}} that is used if no unit is given. It will nevertheless fail if you use for the pad height e.g. {{incode|Sketch1.Constraints.Width - Spreadsheet.B1}} because {{incode|Sketch1.Constraints.Width}} has a unit and {{incode|Spreadsheet.B1}} has not.

Units with exponents can directly be entered. So e.g. {{incode|mm^3}} will be recognized as mm³ and {{incode|m^3}} will be recognized as m³.

If you have a variable whose name is that of a unit you must put the variable between {{incode|<< >>}} to prevent it from being recognized as a unit. For example if you have the dimension {{incode|Sketch.Constraints.A}} it would be recognized as the unit ampere. Therefore you must write it in the expression as {{incode|Sketch.Constraints.<<A>>}}.

The following units are recognized by the expression parser:

=== Amount of substance ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| mmol
| Milli[https://en.wikipedia.org/wiki/Mole_(unit) mole]
|-
| mol
| [https://en.wikipedia.org/wiki/Mole_(unit) Mole]
|}

=== Angle ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| °
| [https://en.wikipedia.org/wiki/Degree_(angle) Degree]; alternative to the unit deg
|-
| deg
| [https://en.wikipedia.org/wiki/Degree_(angle) Degree]; alternative to the unit °
|-
| rad
| [https://en.wikipedia.org/wiki/Radian Radian]
|-
| gon
| [https://en.wikipedia.org/wiki/Gon_(unit) Gradian]
|-
| S
| [https://en.wikipedia.org/wiki/Minute_and_second_of_arc Second of arc]; alternative to the unit ″
|-
| ″
| [https://en.wikipedia.org/wiki/Minute_and_second_of_arc Second of arc]; alternative to the unit S
|-
| M
| [https://en.wikipedia.org/wiki/Minute_and_second_of_arc Minute of arc]; alternative to the unit ′
|-
| ′
| [https://en.wikipedia.org/wiki/Minute_and_second_of_arc Minute of arc]; alternative to the unit M
|}

=== Current ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| mA
| Milli[https://en.wikipedia.org/wiki/Ampere ampere]
|-
| A
| [https://en.wikipedia.org/wiki/Ampere Ampere]
|-
| kA
| Kilo[https://en.wikipedia.org/wiki/Ampere ampere]
|-
| MA
| Mega[https://en.wikipedia.org/wiki/Ampere ampere]
|}

=== Electric capacitance ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| pF
| Pico[https://en.wikipedia.org/wiki/Farad farad]
|-
| nF
| Nano[https://en.wikipedia.org/wiki/Farad farad]
|-
| uF
| Micro[https://en.wikipedia.org/wiki/Farad farad]; alternative to the unit µF
|-
| µF
| Micro[https://en.wikipedia.org/wiki/Farad farad]; alternative to the unit uF
|-
| mF
| Milli[https://en.wikipedia.org/wiki/Farad farad]
|-
| F
| [https://en.wikipedia.org/wiki/Farad Farad]; 1 F = 1 s^4·A^2/m^2/kg
|}

=== Electric charge ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| C
| [https://en.wikipedia.org/wiki/Coulomb Coulomb]; 1 C = 1 A*s
|}

=== Electric conductivity ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| uS
| Micro[https://en.wikipedia.org/wiki/Siemens_(unit) siemens]; alternative to the unit µS
|-
| µS
| Micro[https://en.wikipedia.org/wiki/Siemens_(unit) siemens]; alternative to the unit uS
|-
| mS
| Milli[https://en.wikipedia.org/wiki/Siemens_(unit) siemens]
|-
| S
| [https://en.wikipedia.org/wiki/Siemens_(unit) Siemens]; 1 S = 1 s^3·A^2/kg/m^2
|-
| kS
| Kilo[https://en.wikipedia.org/wiki/Siemens_(unit) Siemens]
|-
| MS
| Mega[https://en.wikipedia.org/wiki/Siemens_(unit) Siemens]
|}

=== Electric inductance ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| nH
| Nano[https://en.wikipedia.org/wiki/Henry_(unit) henry]
|-
| uH
| Micro[https://en.wikipedia.org/wiki/Henry_(unit) henry]; alternative to the unit µH
|-
| µH
| Micro[https://en.wikipedia.org/wiki/Henry_(unit) henry]; alternative to the unit uH
|-
| mH
| Milli[https://en.wikipedia.org/wiki/Henry_(unit) henry]
|-
| H
| [https://en.wikipedia.org/wiki/Henry_(unit) Henry]; 1 H = 1 kg·m^2/s^2/A^2
|}

=== Electric potential ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| mV
| Milli[https://en.wikipedia.org/wiki/Volt volt]
|-
| V
| [https://en.wikipedia.org/wiki/Volt Volt]
|-
| kV
| Kilo[https://en.wikipedia.org/wiki/Volt volt]
|}

=== Electric resistance ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| Ohm
| [https://en.wikipedia.org/wiki/Ohm Ohm]; 1 Ohm = 1 kg·m^2/s^3/A^2
|-
| kOhm
| Kilo[https://en.wikipedia.org/wiki/Ohm ohm]
|-
| MOhm
| Mega[https://en.wikipedia.org/wiki/Ohm ohm]
|}

=== Energy/work ===

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| mJ
| Milli[https://en.wikipedia.org/wiki/Joule joule]
|-
| J
| [https://en.wikipedia.org/wiki/Joule Joule]
|-
| kJ
| Kilo[https://en.wikipedia.org/wiki/Joule joule]
|-
| eV
| [https://en.wikipedia.org/wiki/Electronvolt Electronvolt]; 1 eV = 1.602176634e-19 J
|-
| keV
| Kilo[https://en.wikipedia.org/wiki/Electronvolt electronvolt]
|-
| MeV
| Mega[https://en.wikipedia.org/wiki/Electronvolt electronvolt]
|-
| kWh
| [https://en.wikipedia.org/wiki/Kilowatt_hour Kilowatt hour]; 1 kWh = 3.6e6 J
|-
| Ws
| [https://en.wikipedia.org/wiki/Joule#Watt_second Watt second]; alternative to the unit Joule
|-
| VAs
| [https://en.wikipedia.org/wiki/Joule Volt-ampere-second]; alternative to the unit Joule
|-
| CV
| [https://en.wikipedia.org/wiki/Joule Coulomb-volt]; alternative to the unit Joule
|-
| cal
| [https://en.wikipedia.org/wiki/Calorie Calorie]; 1 cal = 4.184 J
|-
| kcal
| Kilo[https://en.wikipedia.org/wiki/Calorie calorie]
|}

=== Force ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| mN
| Milli[https://en.wikipedia.org/wiki/Newton_(unit) newton]
|-
| N
| [https://en.wikipedia.org/wiki/Newton_(unit) Newton]
|-
| kN
| Kilo[https://en.wikipedia.org/wiki/Newton_(unit) newton]
|-
| MN
| Mega[https://en.wikipedia.org/wiki/Newton_(unit) newton]
|-
| lbf
| [https://en.wikipedia.org/wiki/Pound_(force) Pound of force]
|}

=== Length ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| nm
| Nano[https://en.wikipedia.org/wiki/Metre meter]
|-
| um
| Micro[https://en.wikipedia.org/wiki/Metre meter]; alternative to the unit µm
|-
| µm
| Micro[https://en.wikipedia.org/wiki/Metre meter]; alternative to the unit um
|-
| mm
| Milli[https://en.wikipedia.org/wiki/Metre meter]
|-
| cm
| Centi[https://en.wikipedia.org/wiki/Metre meter]
|-
| dm
| Deci[https://en.wikipedia.org/wiki/Metre meter]
|-
| m
| [https://en.wikipedia.org/wiki/Metre Meter]
|-
| km
| Kilo[https://en.wikipedia.org/wiki/Metre meter]
|-
| mil
| [https://en.wikipedia.org/wiki/Thousandth_of_an_inch Thousandth of an inch]; alternative to the unit thou
|-
| thou
| [https://en.wikipedia.org/wiki/Thousandth_of_an_inch Thousandth of an inch]; alternative to the unit mil
|-
| in
| [https://en.wikipedia.org/wiki/Inch Inch]; alternative to the unit "
|-
| "
| [https://en.wikipedia.org/wiki/Inch Inch]; alternative to the unit in
|-
| ft
| [https://en.wikipedia.org/wiki/Foot_(unit) Foot]; alternative to the unit '
|-
| '
| [https://en.wikipedia.org/wiki/Foot_(unit) Foot]; alternative to the unit ft
|-
| yd
| [https://en.wikipedia.org/wiki/Yard Yard]
|-
| mi
| [https://en.wikipedia.org/wiki/Mile Mile]
|}

=== Luminous intensity ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| cd
| [https://en.wikipedia.org/wiki/Candela Candela]
|}

=== Magnetic flux ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| Wb
| [https://en.wikipedia.org/wiki/Weber_(unit) Weber]; 1 Wb = 1 kg*m^2/s^2/A
|}

=== Magnetic flux density ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| G
| [https://en.wikipedia.org/wiki/Gauss_(unit) Gauss]; 1 G = 1 e-4 T
|-
| T
| [https://en.wikipedia.org/wiki/Tesla_(unit) Tesla]; 1 T = 1 kg/s^2/A
|}

=== Mass ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| ug
| Micro[https://en.wikipedia.org/wiki/Gram gram]; alternative to the unit µg
|-
| µg
| Micro[https://en.wikipedia.org/wiki/Gram gram]; alternative to the unit ug
|-
| mg
| Milli[https://en.wikipedia.org/wiki/Gram gram]
|-
| g
| [https://en.wikipedia.org/wiki/Gram Gram]
|-
| kg
| Kilo[https://en.wikipedia.org/wiki/Gram gram]
|-
| t
| [https://en.wikipedia.org/wiki/Tonne Tonne]
|-
| oz
| [https://en.wikipedia.org/wiki/Ounce Ounce]
|-
| lb
| [https://en.wikipedia.org/wiki/Pound_(mass) Pound]; alternative to the unit lbm
|-
| lbm
| [https://en.wikipedia.org/wiki/Pound_(mass) Pound]; alternative to the unit lb
|-
| st
| [https://en.wikipedia.org/wiki/Stone_(weight) Stone]
|-
| cwt
| [https://en.wikipedia.org/wiki/Hundredweight Hundredweight]
|}

=== Power ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| W
| [https://en.wikipedia.org/wiki/Watt Watt]
|-
| kW
| Kilo[https://en.wikipedia.org/wiki/Watt watt]
|}

=== Pressure ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| Pa
| [https://en.wikipedia.org/wiki/Pascal_(unit) Pascal]
|-
| kPa
| Kilo[https://en.wikipedia.org/wiki/Pascal_(unit) pascal]
|-
| MPa
| Mega[https://en.wikipedia.org/wiki/Pascal_(unit) pascal]
|-
| GPa
| Giga[https://en.wikipedia.org/wiki/Pascal_(unit) pascal]
|-
| uTorr
| Micro[https://en.wikipedia.org/wiki/Torr torr]; alternative to the unit µTorr
|-
| µTorr
| Micro[https://en.wikipedia.org/wiki/Torr torr]; alternative to the unit uTorr
|-
| mTorr
| Milli[https://en.wikipedia.org/wiki/Torr torr]
|-
| Torr
| [https://en.wikipedia.org/wiki/Torr Torr]; 1 Torr = 133.32 Pa
|-
| psi
| [https://en.wikipedia.org/wiki/Pounds_per_square_inch Pound-force per square inch]; 1 psi = 6.895 kPa
|-
| ksi
| Kilo[https://en.wikipedia.org/wiki/Pounds_per_square_inch pound-force per square inch]
|}

=== Temperature ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| uK
| Micro[https://en.wikipedia.org/wiki/Kelvin kelvin]; alternative to the unit µK
|-
| µK
| Micro[https://en.wikipedia.org/wiki/Kelvin kelvin]; alternative to the unit uK
|-
| mK
| Milli[https://en.wikipedia.org/wiki/Kelvin kelvin]
|-
| K
| [https://en.wikipedia.org/wiki/Kelvin Kelvin]
|}

=== Time ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| s
| [https://en.wikipedia.org/wiki/Second Second]
|-
| min
| [https://en.wikipedia.org/wiki/Minute Minute]
|-
| h
| [https://en.wikipedia.org/wiki/Hour Hour]
|-
| Hz (1/s)
| [https://en.wikipedia.org/wiki/Hertz Hertz]
|-
| kHz
| Kilo[https://en.wikipedia.org/wiki/Hertz hertz],
|-
| MHz
| Mega[https://en.wikipedia.org/wiki/Hertz hertz]
|-
| GHz
| Giga[https://en.wikipedia.org/wiki/Hertz hertz]
|-
| THz
| Tera[https://en.wikipedia.org/wiki/Hertz hertz]
|}

=== Volume ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| ml
| Milli[https://en.wikipedia.org/wiki/Litre liter]
|-
| l
| [https://en.wikipedia.org/wiki/Litre Liter]
|-
| cft
| Cubic[https://en.wikipedia.org/wiki/Foot_(unit) foot]
|}

=== Special imperial units ===

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Unit
!style="width: 66%;"|Description
|-
| mph
| [https://en.wikipedia.org/wiki/Miles_per_hour Miles per hour]
|-
| sqft
| [https://en.wikipedia.org/wiki/Square_foot Square foot]
|}

=== Unsupported units ===

The following commonly used units are not yet supported, for some an alternative is provided:

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 25%;"|Unit
!style="width: 50%;"|Description
!style="width: 25%;"|Alternative
|-
| °C
| [https://en.wikipedia.org/wiki/Celsius Celsius ]
| [°C] + 273.15 K
|-
| °F
| [https://en.wikipedia.org/wiki/Fahrenheit Fahrenheit];
| ([°F] + 459.67) × 5/9
|-
| u
| [https://en.wikipedia.org/wiki/Unified_atomic_mass_unit Atomic mass unit]; alternative to the unit Da
| 1.66053906660e-27 kg
|-
| Da
| [https://en.wikipedia.org/wiki/Unified_atomic_mass_unit Dalton]; alternative to the unit u
| 1.66053906660e-27 kg
|-
| sr
| [https://en.wikipedia.org/wiki/Steradian Steradian]
| not directly
|-
| lm
| [https://en.wikipedia.org/wiki/Lumen_(unit) Lumen]
| not directly
|-
| lx
| [https://en.wikipedia.org/wiki/Lux Lux]
| not directly
|-
| px
| [https://en.wikipedia.org/wiki/Pixel Pixel]
| not directly
|}

{{Top}}

==Invalid characters and names==

The expression feature is very powerful but to achieve this power it has some limitations concerning some characters. To overcome this, LabRPS offers to use labels and reference them instead of the object names. In labels you can use almost all special characters.

In cases where you cannot use a label, such as the name of a sketch's constraints, you must be aware what characters are not allowed.

===Labels===
For [[Object_name#Label|labels]] there are no invalid characters, however some characters need to be escaped:
{| class="wikitable"
!style="width: 33%;"|Characters
!style="width: 66%;"|Description
|-
| {{incode|'}}, {{incode|\}}, {{incode|"}}
| Need to be escaped by adding {{incode|\}} in front of them.
|}

For example, the label {{incode|Sketch\002}} must be referenced as {{incode|<<Sketch\\002>>}}.

===Names===

[[Object_name#Name|Names]] of objects like dimensions, sketches, etc. may not have the characters or character sequences listed below, otherwise the name is invalid:

{| class="wikitable"
!style="width: 33%;"|Characters / Character sequences
!style="width: 66%;"|Description
|-
| '''+''', '''-''', '''*''', '''/''', '''^''', '''_''', '''<''', '''>''', '''(''', ''')''', '''{''', '''}''', '''[''', ''']''', '''.''', ''',''', '''='''
| Characters that are math operators or part of mathematical constructs
|-
| '''A''', '''kA''', '''mA''', '''MA''', '''J''', '''K''', ''' ' ''', ''' ft ''', '''°''', and many more!
| Characters and character sequences that are units (see the [[#Units|Units]] paragraph)
|-
| '''#''', '''!''', '''?''', '''§''', '''$''', '''%''', '''&''', ''':''', ''';''', '''\''', '''<nowiki>|</nowiki>''', '''~''', '''∆''', '''¿''', and many more!
| Characters used as placeholder or to trigger special operations
|-
| '''pi''', '''e'''
| Mathematical constants
|-
| '''´''', '''`''', ''' ' ''', '''"'''
| Characters used for accents
|-
| space
| A space defines the end of a name and can therefore not be used
|}

For example, the following name is valid: {{incode|<<Sketch>>.Constraints.T2üßµ@}}. While these are invalid names: {{incode|<<Sketch>>.Constraints.test\result_2}} (\r means "carriage return") or {{incode|<<Sketch>>.Constraints.mol}} (mol is a unit).

Since shorter names (especially if they have only one or two characters) can easily result in invalid names, consider using longer names and/or establishing a suitable naming convention.

===Cell aliases===

{{Top}}

=== Cyclic dependencies ===

LabRPS checks dependencies based on the relationship between document objects, not properties. This means that you cannot provide data to an object and query that same object for results. For example, even though there are no cyclic dependencies when the properties themselves are considered, you may not have an object which gets its dimensions from a spreadsheet and then display the volume of that object in the same spreadsheet. You have to use two spreadsheets, one to drive your model and the other for reporting.

As a workaround it is possible to display a cell range from the second spreadsheet in the first (or vice versa) by creating a [[Spreadsheet_Workbench#Cell_binding|cell binding]] with the {{MenuCommand|Hide dependency of binding}} option.

Another way to workaround cyclic dependencies is to hide the reference by using the {{incode|href}} or {{incode|hiddenref}} function for individual expressions, for example: {{incode|href(Sim.ModulationFunction)}}.

Please note that both mentioned workarounds should be used with caution, and that they do not work if the properties that are reported depend on dimensions that are driven from the same spreadsheet.

{{Top}}

== Document-wide global variables ==

There is no concept of global variables in LabRPS at the moment. Instead, arbitrary variables can be defined as cells in a spreadsheet using the [[Spreadsheet Workbench|Spreadsheet workbench]], and then be given a name using the alias property for the cell (right-click on cell). Then they can be accessed from any expression just as any other object property.

{{Top}}

== Cross-document linking ==

It is possible (with limitations) to define a Property of an object in your current document (".RPSstd" file) by using an Expression to reference a Property of an object contained in a different document (".RPSstd" file). For example, a cell in a spreadsheet etc. in one document can be defined by an Expression that references the X Placement value or another Property of an object contained in a different document.

A document's name is used to reference it from other documents. When saving a document the first time, you choose a file name; this is usually different from the initial default "Unnamed1" (or its translated equivalent). To prevent links being lost when the master document is renamed upon saving, it is recommended that you first create the master document, create a spreadsheet inside it, and save it. Subsequently, you can still make changes to the file and its spreadsheet but you should not rename it.

Once the master document with the spreadsheet is created and saved (named), it is safe to create dependent documents. For example, assuming you name the master document {{incode|master}}, the spreadsheet {{incode|modelConstants}}, and give a cell an alias-name {{incode|Length}}, you can then access the value as:

{{incode|master#modelConstants.Length}}

Note that the master document must be loaded for the values in the master to be available to the dependent document.

Of course, it's up to you to load the corresponding documents later when you want to change anything.

{{Top}}

== Scripting ==

{{Code|code=
import LabRPS as App

doc = App.ActiveDocument
point1 = doc.addObject("WindLabAPI::WindLabFeatureSimulationLocation", "Point1")
point2 = doc.addObject("WindLabAPI::WindLabFeatureSimulationLocation", "Point2")

point1.setExpression("Height", f"{point2}.Z / 2")

doc.recompute()

# Expressions are stored in the ExpressionEngine property:
for prop, exp in point1.ExpressionEngine:
val = getattr(point1, prop)
print(f"Property: '{prop}' -- Expression: '{exp}' -- Current value: {val}")
}}

{{Top}}

{{Powerdocnavi}}
[[Category:Spreadsheet]]

← Older revision		Revision as of 04:20, 28 December 2024
Line 937:		Line 937:
	== Cross-document linking ==		== Cross-document linking ==

	It is possible (with limitations) to define a Property of an object in your current document (".~~RPSstd~~" file) by using an Expression to reference a Property of an object contained in a different document (".~~RPSstd~~" file). For example, a cell in a spreadsheet etc. in one document can be defined by an Expression that references the X Placement value or another Property of an object contained in a different document.		It is possible (with limitations) to define a Property of an object in your current document (".rps" file) by using an Expression to reference a Property of an object contained in a different document (".rps" file). For example, a cell in a spreadsheet etc. in one document can be defined by an Expression that references the X Placement value or another Property of an object contained in a different document.

	A document's name is used to reference it from other documents. When saving a document the first time, you choose a file name; this is usually different from the initial default "Unnamed1" (or its translated equivalent). To prevent links being lost when the master document is renamed upon saving, it is recommended that you first create the master document, create a spreadsheet inside it, and save it. Subsequently, you can still make changes to the file and its spreadsheet but you should not rename it.		A document's name is used to reference it from other documents. When saving a document the first time, you choose a file name; this is usually different from the initial default "Unnamed1" (or its translated equivalent). To prevent links being lost when the master document is renamed upon saving, it is recommended that you first create the master document, create a spreadsheet inside it, and save it. Subsequently, you can still make changes to the file and its spreadsheet but you should not rename it.

Expressions - Revision history

LabRPS at 11:20, 28 December 2024