pycatia.knowledge_interfaces.real_param

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.real_param.RealParam(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
RealParam

Represents the real parameter.
The following example shows how to create it:

Dim CATDocs As Documents
Set CATDocs = CATIA.Documents
Dim part1 As Document
Set part1 = CATDocs.Add(“CATPart”)
Dim density As RealParam
Set density = part1.Part.Parameters.CreateReal(“density”, 2.5)


The real parameter is the base object for dimensions.

See also:
Dimension
get_enumerate_values(o_safe_array: tuple) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub GetEnumerateValues(CATSafeArrayVariant oSafeArray)

Returns an array containing the different values that the real param can
take in the case of multiple values.

Example:

Dim enumValues () as Variant
ReDim enumValues (aRealParameter.GetEnumerateValuesSize() -
1)
aRealParameter.GetEnumerateValues(enumValues)
For i = LBound(enumValues) to UBound(enumValues)
…
Next
Parameters:

o_safe_array (tuple) –

Return type:

None

get_enumerate_values_size() → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetEnumerateValuesSize() As long

Returns the number of enumerate values.
Return type:

int

is_equal_to(i_value_to_compare: float) → bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func IsEqualTo(double iValueToCompare) As boolean

Tests the equality of the parameter value with a given
value.

Parameters:

iValueToCompare
The value to compare the parameter value with

Returns:

True
If the current value of the parameter (the one get by the get_Value
property, for dimensions notice that it is not the MKS value) is equal to the
one given in argument. Notice that two values are considered as equal if their
difference is insignificant faced with the two compared values. This method
allows you to avoid problems due to computation
errors.
False
If the two values are different.
Parameters:

i_value_to_compare (float) –

Return type:

bool

property maximum_tolerance: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property MaximumTolerance() As double

Returns or sets the value of the maximum tolerance of a parameter. Units
are expressed in the IS unit system.

Example:
This example sets the MaximumTolerance value to 0 if its value is
bigger than 0:

If (Length.MaximumTolerance < 0.0) Then
Length.MaximumTolerance = 0.0
End If
Return type:

float

property minimum_tolerance: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property MinimumTolerance() As double

Returns or sets the value of the minimum tolerance of a parameter. Units
are expressed in the IS unit system.

Example:
This example sets the MinumumTolerance value to 0 if its value is
bigger than 0:

If (Length.MinimumTolerance > 0.0) Then
Length.MinimumTolerance = 0.0
End If
Return type:

float

property range_max: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property RangeMax() As double

Returns or sets the value of the upper bound that the parameter object
value can take.

Example:
This example sets the RangeMax value to 0 if its value is smaller than
0:

If (Length.RangeMax < 0.0 and Length.RangeMaxValidity <> 0)
Then
Length.RangeMax = 0.0
End If
Return type:

float

property range_max_validity: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property RangeMaxValidity() As long

Returns or sets the type of the upper bound of the
parameter.

0
the upper bound is meaningless
1
the upper bound can be reached
2
the upper bound cannot be reached
Return type:

int

property range_min: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property RangeMin() As double

Returns or sets the value of the lower bound that the parameter object
value can take.

Example:
This example sets the RangeMin value to 0 if its value is bigger than
0:

If (Length.RangeMin > 0.0 and Length.RangeMinValidity <> 0)
Then
Length.RangeMin = 0.0
End If
Return type:

float

property range_min_validity: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property RangeMinValidity() As long

Returns or sets the type of the lower bound of the
parameter.

0
the lower bound is meaningless
1
the lower bound can be reached
2
the lower bound cannot be reached
Return type:

int

set_enumerate_values(i_safe_array: tuple) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetEnumerateValues(CATSafeArrayVariant iSafeArray)

Sets an array containing the different values that the real param can take
in the case of multiple values.
Parameters:

i_safe_array (tuple) –

Return type:

None

suppress_enumerate_values() → None

Note

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

Resets the status of the object to a single value object.
Return type:

None

property value: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property Value() As double

Returns or sets the value of the real parameter. Units are expressed in the
IS unit system, except for lengths expressed in millimeters, and angles
expressed in decimal degrees.

Example:
This example sets the density value to 1 if its value is greater than
2.5:

If (density.Value > 2.5) Then
density.Value = 1
End If
Return type:

float