pycatia.knowledge_interfaces.dimension

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.dimension.Dimension(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
KnowledgeInterfaces.Parameter
KnowledgeInterfaces.RealParam
Dimension

Represents the dimension parameter.
It is an abstract object which is not intended to be created as such, but from
which the length and angle parameters derive.

See also:
Length, Angle
property unit: Unit

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property Unit() As Unit (Read Only)

Returns the unit used for this dimension object.
Return type:

Unit

value_as_string2(i_nb_decimals: int, i_show_trailing_zeros: bool) → str

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func ValueAsString2(long iNbDecimals,
boolean iShowTrailingZeros) As CATBSTR

Gets the value of the parameter as a string, with a given
precision.

Parameters:

iNbDecimals
the maximum number of decimal places to use to generate the string
(minimum 0, maximum 9)
iShowTrailingZeros
this argument says if trailing zeros have to be shown


Example:
This example gets the value of the existing dimension parameter and
shows it in a message box

Dim str
str = dimension.ValueAsString;
MessageBox str
Parameters:

  • i_nb_decimals (int) –

  • i_show_trailing_zeros (bool) –

Return type:

str