pycatia.arrangement_interfaces.arrangement_item_reservations

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_item_reservations.ArrangementItemReservations(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
ArrangementItemReservations

A collection object for ArrangementItemReservation objects.
Role: Use this collection object to manage (create, retrieve and remove)
ArrangementItemReservation objects.
add_item_reservation(i_rel_axis: Move, i_position: tuple, i_x_min: float, i_y_min: float, i_z_min: float, i_x_max: float, i_y_max: float, i_z_max: float) → ArrangementItemReservation

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddItemReservation(Move iRelAxis,
CATSafeArrayVariant iPosition,
double iXMin,
double iYMin,
double iZMin,
double iXMax,
double iYMax,
double iZMax) As ArrangementItemReservation

Creates an ArrangementItemReservation and adds it to the
collection.

Parameters:

iRelAxis
Relative Axis to be considered.
iPosition
Position information for the ItemReservation (rotation and
location).
iXMin
Minium X Coordinate of the bounding box on the Item Reservation.

iYMin
Minium Y Coordinate of the bounding box on the Item Reservation.

iZMin
Minium Z Coordinate of the bounding box on the Item Reservation.

iXMax
Maximum X Coordinate of the bounding box on the Item Reservation.

iYMax
Maximum Y Coordinate of the bounding box on the Item Reservation.

iZMax
Maximum Z Coordinate of the bounding box on the Item Reservation.


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

  • i_rel_axis (Move) –

  • i_position (tuple) –

  • i_x_min (float) –

  • i_y_min (float) –

  • i_z_min (float) –

  • i_x_max (float) –

  • i_y_max (float) –

  • i_z_max (float) –

Return type:

ArrangementItemReservation

item(i_index: cat_variant) → ArrangementItemReservation

Note

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

Returns the specified ArrangementItemReservation item of the
collection.

Parameters:

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

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


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

i_index (cat_variant) –

Return type:

ArrangementItemReservation

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

Parameters:

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

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


AnyObject.Name property.
Parameters:

i_index (cat_variant) –

Return type:

None