pycatia.knowledge_interfaces.str_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.str_param.StrParam(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
StrParam

Represents the string 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 material As String
Set material = part1.Parameters.CreateString(“material”, “glass”)
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 (aStrParameter.GetEnumerateValuesSize() -
1)
aStrParameter.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

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 StrParam object can
take in the case of multiple values.

Parameters:

The
array of enumerated 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: str

Note

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

Returns or sets the string parameter value.

Example:
This example returns in myValue the value of the string parameter
material:



myValue = material.Value
Return type:

str