All Frameworks  Object Hierarchy  This Framework  Indexes

ArrangementItemReservations (Collection)

A collection object for ArrangementItemReservation objects.
Role: Use this collection object to manage (create, retrieve and remove) ArrangementItemReservation objects.

Method Index

AddItemReservation
Creates an ArrangementItemReservation and adds it to the collection.
Item
Returns the specified ArrangementItemReservation item of the collection.
Remove
Removes the specified ArrangementItemReservation object from the collection.

Methods


o Func AddItemReservation( iRelAxis,
iPosition,
iXMin,
iYMin,
iZMin,
iXMax,
iYMax,
iZMax) As
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.
o Func Item( iIndex) As
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.
o Sub Remove( 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.

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