All Frameworks  Object Hierarchy  This Framework  Indexes

ArrangementItemReservation (Object)

Use this object to access the ArrangementItemReservation properties and methods.
Role: Use this object to control the visualization mode, dimensions of the ArrangementItemReservation.

Property Index

Height
Returns or sets the height of the ArrangementItemReservation.
VisuMode
Returns or set the Visualization Mode for the ArrangementItemReservation.
XLength
Returns or sets the XLength of the ArrangementItemReservation.
YLength
Returns or sets the YLength of the ArrangementItemReservation.

Method Index

GetDimension
Returns the Dimensions of the ArrangementItemReservation.
GetTechnologicalObject
Returns the applicative data whose type is the given parameter.
SetDimension
Sets the Dimensions of the ArrangementItemReservation.

Properties


o Property Height() As
Returns or sets the height of the ArrangementItemReservation.
Example:
This example retrieves the Height of the objItemRes1 object. 
 Dim dblHeight   As Double
 dblHeight  = objItemRes1.Height
o Property VisuMode() As
Returns or set the Visualization Mode for the ArrangementItemReservation.
Example:
This example Sets the Visualization Mode of the objItemRes1 object to CatArrangementItemReservationVisuModeBox . 
 objItemRes1.VisuMode = CatArrangementItemReservationVisuModeBox
o Property XLength() As
Returns or sets the XLength of the ArrangementItemReservation.
Example:
This example retrieves the XLength of the objItemRes1 object. 
 Dim dblXLength   As Double
 dblXLength  = objItemRes1.XLength
o Property YLength() As
Returns or sets the YLength of the ArrangementItemReservation.
Example:
This example retrieves the YLength of the objItemRes1 object. 
 Dim dblYLength   As Double
 dblYLength  = objItemRes1.YLength

Methods


o Sub GetDimension( ioItemResDimensions)
Returns the Dimensions of the ArrangementItemReservation.
Parameters:
ioItemResDimensions
The output array initialized with the dimensions that make up the ArrangementItemReservation. The first three components represent the Minimum XCoord, YCoord and Z Coord while the remaining three components represent the Maximum XCoord, YCoord and Z Coord respectively.
Example:
This example retrieves the coordinate dimensions of the objItemRes1 object. 
 Dim dblDimension(6)   As Double
 objItemRes1.GetDimension(dblDimension)
o Func GetTechnologicalObject( iApplicationType) As
Returns the applicative data whose type is the given parameter.
Parameters:
iApplicationType
The type of applicative data searched.
oApplicativeObj
The matched applicative object.
Example:
This example retrieves the desired applicative object from the objItemRes1 object. 
 Dim objProd   As Product
 objProd  = objItemRes1.GetTechnologicalObject("Product")
o Sub SetDimension( iItemResDimensions)
Sets the Dimensions of the ArrangementItemReservation.
Parameters:
iItemResDimensions
The input array initialized with the dimensions that make up the ArrangementItemReservation. The first three components represent the Minimum XCoord, YCoord and Z Coord while the remaining three components represent the Maximum XCoord, YCoord and Z Coord respectively.
Example:
This example sets the coordinate dimensions of the objItemRes1 object. 
 Dim dblDimension(6)   As Double
 dblDimension(0)       = 300.0 '//XMin
 dblDimension(1)       = 500.0 '//YMin
 dblDimension(2)       = 300.0 '//ZMin
 dblDimension(3)       = 500.0 '//XMax
 dblDimension(4)       = 0.0   '//YMax
 dblDimension(5)       = 300.0 '//ZMax
 objItemRes1.SetDimension(dblDimension)

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