pycatia.kinematics_interfaces.mechanisms

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.kinematics_interfaces.mechanisms.Mechanisms(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
Mechanisms

A collection of all Mechanism entities currently managed by the
application.
add() → Mechanism

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Add() As Mechanism

Creates a new Mechanism and adds it to the Mechanisms
collection.

Returns:
The created Mechanism
Example:
This example creates a new Mechanism in the TheMechanisms
collection.

Dim NewMechanism As Mechanism
Set NewMechanism = TheMechanisms.Add()
Return type:

Mechanism

item(i_index: cat_variant) → Mechanism

Note

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

Returns a Mechanism using its index or its name from the Mechanisms
collection.

Parameters:

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

AnyObject.Name property.
Returns:
The retrieved Mechanism
Example:
This example returns in ThisMechanism the third Mechanism in the
collection, and in ThatMechanism the Mechanism named
MyMechanism.

Dim ThisMechanism As Mechanism
Set ThisMechanism = TheMechanisms.Item(3)
Dim ThatMechanism As Mechanism
Set ThatMechanism = CATIA.Mechanisms.Item(“MyMechanism”)
Parameters:

i_index (cat_variant) –

Return type:

Mechanism

remove(i_index: cat_variant) → None

Note

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

Removes a Mechanism from the Mechanisms collection.

Parameters:

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

Returns:
Nothing
Example:
The following example removes the tenth Mechanism and the Mechanism
named MechanismTwo from the TheMechanisms collection.

TheMechanisms.Remove(10)
TheMechanisms.Remove(“MechanismTwo”)
Parameters:

i_index (cat_variant) –

Return type:

None