pycatia.cat_str_functional_interfaces.sfm_references

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

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.cat_str_functional_interfaces.sfm_references.SFMReferences(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
SfmReferences

A Collection of U and V Reference elements for Standard
Opening.
add(i_reference: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Add(Reference iReference)

Adds a reference in the collection.

Parameters:

iReference
[in] Reference.

Returns:
S_OK if everything ran ok.
This example Adds one U Reference to the list of
SfmReferences.

Dim Uref1 As Reference
Set Uref1 = Part1.FindObjectByName(“CROSS.95”)
‘Add one U Reference to the list
Dim UrefList As SfmReferences
UrefList.Add Uref1
Parameters:

i_reference (Reference) –

Return type:

None

clear_list() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ClearList()

Clears the contents of existing list of SfmReferences.

Returns:
Error code

Example:
This example clears the contents of a list.

Dim ListofRef As SfmReferences
Dim Uref1 as Reference
ListofRef.Add Uref1
ListofRef.ClearList
Return type:

None

item(i_index: cat_variant) → Reference

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Item(CATVariant iIndex) As Reference

Retrieves a Reference from the collection of
SfmReferences.

Parameters:

iIndex
[in] The index of the parameter
oParm
[out] The parameter

Returns:
Error code

Example
:
This example retrieves ‘i’th Reference from a list of
References

Dim ListofRef As SfmReferences
Set Ref1 = ListofRef.Item(i)
Parameters:

i_index (cat_variant) –

Return type:

Reference