pycatia.arrangement_interfaces.arrangement_runs

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_runs.ArrangementRuns(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
ArrangementRuns

A collection object of ArrangementRun objects.
Role: Use this collection object to manage ArrangementRun
objects.
add_run(i_rel_axis: Move, i_listof_math_points: tuple, i_math_direction: tuple) → ArrangementRun

Note

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

Creates an ArrangementRun 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 ArrangementRun object and adds it to the
collection.
Parameters:

  • i_rel_axis (Move) –

  • i_listof_math_points (tuple) –

  • i_math_direction (tuple) –

Return type:

ArrangementRun

item(i_index: cat_variant) → ArrangementRun

Note

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

Returns the specified ArrangementRun item of the collection
object.

Parameters:

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

To retrieve a specific object by number, use the rank of the
ArrangementRun 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
ArrangementRun by name, use name that you assigned using the


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

i_index (cat_variant) –

Return type:

ArrangementRun

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

Parameters:

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

To remove a specific object by number, use the rank of the
ArrangementRun 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
ArrangementRun by name, use name that you assigned using the


AnyObject.Name property.
Parameters:

i_index (cat_variant) –

Return type:

None