pycatia.kinematics_interfaces.joints

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.joints.Joints(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
Joints

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

Note

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

Create a new Joint and adds it to the Joints collection.

Returns:
The created Joint
Example:
This example creates a new Joint in the TheJoints
collection.

Dim NewJoint As Joint
Set NewJoint = TheJoints.Add()
Return type:

Joint

item(i_index: cat_variant) → Joint

Note

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

Returns a Joint using its index or its name from the Joints
collection.

Parameters:

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

AnyObject.Name property.
Returns:
The retrieved Joint
Example:
This example returns in ThisJoint the third Joint in the collection,
and in ThatJoint the Joint named MyJoint.

Dim ThisJoint As Joint
Set ThisJoint = TheJoints.Item(3)
Dim ThatJoint As Joint
Set ThatJoint = CATIA.Joints.Item(“MyJoint”)
Parameters:

i_index (cat_variant) –

Return type:

Joint

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 Joint from the Joints collection.

Parameters:

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

Returns:
Nothing
Example:
The following example removes the tenth Joint and the Joint named
JointTwo from the TheJoints collection.

TheJoints.Remove(10)
TheJoints.Remove(“JointTwo”)
Parameters:

i_index (cat_variant) –

Return type:

None