All Frameworks  Object Hierarchy  This Framework  Indexes

Mechanisms (Collection)

A collection of all Mechanism entities currently managed by the application.

Method Index

Add
Creates a new Mechanism and adds it to the Mechanisms collection.
Item
Returns a Mechanism using its index or its name from the Mechanisms collection.
Remove
Removes a Mechanism from the Mechanisms collection.

Methods


o Func Add() As
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()
o Func Item( iIndex) As
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")
o Sub Remove( 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")

Copyright © 2003, Dassault Systèmes. All rights reserved.