pycatia.funct_system_interfaces.functional_variants

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.funct_system_interfaces.functional_variants.FunctionalVariants(com_object, child_object=<class 'pycatia.funct_system_interfaces.functional_variant.FunctionalVariant'>)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
FunctionalVariants

The interface to access a collection of FunctionalVariants.
create(i_name: str) FunctionalVariant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Create(CATBSTR iName) As FunctionalVariant

Create a FunctionalVariant.
Parameters:

i_name (str) –

Return type:

FunctionalVariant

delete(i_variant: FunctionalVariant) None

Note

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

Delete a FunctionalVariant.
Parameters:

i_variant (FunctionalVariant) –

Return type:

None

elem(i_index: cat_variant) FunctionalVariant

Note

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

Returns a Variant using its index or its name from the Variants
collection.

Parameters:

iIndex
The index or the name of the Variant to retrieve from the
collection of Variants. As a numerics, this index is the rank of the Variant in
the collection. The index of the first Variant in the collection is 1, and the
index of the last Variant is Count. As a string, it is the name you assigned to
the Variant using the

AnyObject.Name property.
Returns:
The retrieved Variant
Example:
This example retrieves in Act1 the fifth Variant in the collection and
in Act2 the Variant named Moves.

Dim Act1 As FunctionalVariant
Set Act1 = Desc.Variant(5)
Dim Act2 As FunctionalVariant
Set Act2 = Desc.Variant(“Adding new substance”)
Parameters:

i_index (cat_variant) –

Return type:

FunctionalVariant