pycatia.knowledge_interfaces.unit

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.knowledge_interfaces.unit.Unit(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Unit

Represents CATIAUnit object.

This interface allows convertion.

convert_from_mks(i_value_in_mks: float) → float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ConvertFromMKS(double iValueInMKS) As double

Convert the initial value (expressed in MKS unit) in its equivalent in the

current unit.

Parameters:

iValueInThisUnit

The initial value in MKS unit.

oValueInMKS

The final value in the current unit.

Parameters:

i_value_in_mks (float) –

Return type:

float

convert_from_storage_unit(i_value_in_storage_unit: float) → float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ConvertFromStorageUnit(double iValueInStorageUnit) As

double

Convert the initial value (expressed in storage unit) in its equivalent in

the current unit.

Parameters:

iValueInStorageUnit

The initial value in storage unit.

oValueInThisUnit

The final value in the current unit.

Parameters:

i_value_in_storage_unit (float) –

Return type:

float

convert_to_mks(i_value_in_this_unit: float) → float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ConvertToMKS(double iValueInThisUnit) As double

Convert the initial value in its equivalent in MKS unit.

Parameters:

iValueInThisUnit

The initial value in the current unit.

oValueInMKS

The final value in the corresponding MKS unit.

Parameters:

i_value_in_this_unit (float) –

Return type:

float

convert_to_storage_unit(i_value_in_this_unit: float) → float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ConvertToStorageUnit(double iValueInThisUnit) As

double

Convert the initial value in its equivalent in storage

unit.

Parameters:

iValueInThisUnit

The initial value in the current unit.

oValueInStorageUnit

The final value in the corresponding storage unit.

Parameters:

i_value_in_this_unit (float) –

Return type:

float

property magnitude: str

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Magnitude() As CATBSTR (Read Only)

Returns the magnitude associated to the unit.

Return type:

str

property symbol: str

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Symbol() As CATBSTR (Read Only)

Returns the symbol associated to the unit.

Return type:

str