to

Surface.to(target_unit: str, inplace: bool = False) → Surface

It converts actual value to a new value computed using target_unit as the reference unit of measurement.

If inplace is True, it overrides actual value and unit, otherwise it returns a new instance with the converted value and the target_unit as unit.

Parameters

target_unitstr

Target unit to which convert the current value.

inplacebool, optional

Whether to override the current instance value. Default is False, so it does not override the current value.

Returns

Surface

Converted surface.

Raises

TypeError

• If target_unit is not a str,

• if inplace is not a bool.

KeyError

If the target_unit is not among available ones.

Examples

Surface instantiation.

>>> from gearpy.units import Surface
>>> s = Surface(1, 'm^2')
>>> s
1 m^2

Conversion from square meter to square millimeter with inplace=False by default, so it does not override the current value.

>>> s.to('mm^2')
1000000.0 mm^2
>>> s
1 m^2

Conversion from square meter to square millimeter with inplace=True, in order to override the current value.

>>> s.to('mm^2', inplace=True)
1000000.0 mm^2
>>> s
1000000.0 mm^2