pycatia.kinematics_interfaces.mechanism_commands

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.mechanism_commands.MechanismCommands(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
MechanismCommands

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

Note

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

Creates a new MechanismCommand and adds it to the MechanismCommands
collection.

Returns:
The created MechanismCommand
Example:
This example creates a new MechanismCommand in the TheCommands
collection.

Dim NewCommand As MechanismCommand
Set NewCommand = TheCommands.Add()
Return type:

MechanismCommand

item(i_index: cat_variant) → MechanismCommand

Note

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

Returns a MechanismCommand using its index or its name from the Commands
collection.

Parameters:

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


AnyObject.Name property.
Returns:
The retrieved MechanismCommand
Example:
This example returns in ThisCommand the third MechanismCommand in the
collection, and in ThatCommand the MechanismCommand named
MyCommand.

Dim ThisCommand As MechanismCommand
Set ThisCommand = TheCommands.Item(3)
Dim ThatCommand As MechanismCommand
Set ThatCommand = CATIA.MechanismCommands.Item(“MyCommand”)
Parameters:

i_index (cat_variant) –

Return type:

MechanismCommand

remove(i_index: cat_variant) → None

Note

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

Remove a MechanismCommand from the MechanismCommands
collection.

Parameters:

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


Returns:
Nothing
Example:
The following example removes the tenth MechanismCommand and the
MechanismCommand named CommandTwo from the TheCommands
collection.

TheCommands.Remove(10)
TheCommands.Remove(“CommandTwo”)
Parameters:

i_index (cat_variant) –

Return type:

None