Files
create/src/Base/Unit.pyi
2025-03-01 16:32:22 +00:00

55 lines
1.3 KiB
Python

from Metadata import export
from PyObjectBase import PyObjectBase
from Quantity import Quantity
from Unit import Unit
from typing import Final, Tuple, overload
@export(
NumberProtocol=True,
RichCompare=True,
Constructor=True,
Delete=True,
)
class Unit(PyObjectBase):
"""
Unit
defines a unit type, calculate and compare.
The following constructors are supported:
Unit() -- empty constructor
Unit(i1,i2,i3,i4,i5,i6,i7,i8) -- unit signature
Unit(Quantity) -- copy unit from Quantity
Unit(Unit) -- copy constructor
Unit(string) -- parse the string for units
Author: Juergen Riegel (FreeCAD@juergen-riegel.net)
Licence: LGPL
"""
@overload
def __init__(self) -> None: ...
@overload
def __init__(
self,
i1: float,
i2: float,
i3: float,
i4: float,
i5: float,
i6: float,
i7: float,
i8: float,
) -> None: ...
@overload
def __init__(self, quantity: Quantity) -> None: ...
@overload
def __init__(self, unit: Unit) -> None: ...
@overload
def __init__(self, string: str) -> None: ...
Type: Final[str] = ...
"""holds the unit type as a string, e.g. 'Area'."""
Signature: Final[Tuple] = ...
"""Returns the signature."""