pycatia.arrangement_interfaces.arrangement_pathways

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.arrangement_interfaces.arrangement_pathways.ArrangementPathways(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
ArrangementPathways

A collection object for ArrangementPathway objects.
Role: Use this collection object to manage (create, retrieve and remmove)
ArrangementPathway objects.
add_pathway(i_rel_axis: Move, i_listof_math_points: tuple, i_math_direction: tuple) → ArrangementPathway

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddPathway(Move iRelAxis,
CATSafeArrayVariant iListofMathPoints,
CATSafeArrayVariant iMathDirection) As ArrangementPathway

Creates an ArrangementItemReservation and adds it to the
collection.

Parameters:

iRelAxis
Relative Axis to be considered.
iListofMathPoints
List of points through which to route.
iMathDirection
Starting routing direction.

Returns:
Returns the newly created ArrangementPathway object and adds it to the
collection.
Parameters:

  • i_rel_axis (Move) –

  • i_listof_math_points (tuple) –

  • i_math_direction (tuple) –

Return type:

ArrangementPathway

item(i_index: cat_variant) → ArrangementPathway

Note

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

Returns the specified ArrangementPathway item of the collection
object.

Parameters:

iIndex
The index or the name of the ArrangementPathway to retrieve from
this collection.

To retrieve a specific object by number, use the rank of the
ArrangementPathway in that collection.
Note that the index of the first element in the collection is
1, and the index of the last element is Count. To retrieve a specific
ArrangementPathway by name, use name that you assigned using the


AnyObject.Name property.
Returns:
The retrieved ArrangementPathway object.
Parameters:

i_index (cat_variant) –

Return type:

ArrangementPathway

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 the specified ArrangementPathway object from the
collection.

Parameters:

iIndex
The index or the name of the ArrangementPathway to remove from this
collection.

To remove a specific object by number, use the rank of the
ArrangementPathway in that collection.
Note that the index of the first element in the collection is
1, and the index of the last element is Count. To remove a specific
ArrangementPathway by name, use name that you assigned using the


AnyObject.Name property.
Parameters:

i_index (cat_variant) –

Return type:

None