pycatia.knowledge_interfaces.int_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.int_param.IntParam(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
IntParam

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

Dim CATDocs As Documents
Set CATDocs = CATIA.Documents
Dim part1 As Dccument
Set part1 = CATDocs.Add(“CATPart”)
Dim year As IntParam
Set year = part1.Part.Parameters.CreateInteger(“year”, 1998)
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 int param can
take in the case of multiple values.

Example:

Dim enumValues () as Variant
ReDim enumValues (anIntegerParameter.GetEnumerateValuesSize() -
1)
anIntegerParameter.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

property range_max: int

Note

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

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:

int

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: int

Note

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

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:

int

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: int

Note

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

Returns or sets the value of the integer parameter. Units are expressed in
the IS unit system.

Example:
This example sets the year value to 0 if its value is equal to
2000:

If (year.Value = 2000) Then
year.Value = 0
End If
Return type:

int