pycatia.arrangement_interfaces.arrangement_item_reservation

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_reservation.ArrangementItemReservation(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

ArrangementItemReservation

Use this object to access the ArrangementItemReservation properties and

methods.

Role: Use this object to control the visualization mode, dimensions of the

ArrangementItemReservation.

get_dimension(io_item_res_dimensions: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetDimension(CATSafeArrayVariant 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)

Parameters:

io_item_res_dimensions (tuple) –

Return type:

None

get_technological_object(i_application_type: str) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetTechnologicalObject(CATBSTR iApplicationType) As

CATBaseDispatch

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”)

Parameters:

i_application_type (str) –

Return type:

AnyObject

property height: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Height() As double

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

Return type:

float

set_dimension(i_item_res_dimensions: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetDimension(CATSafeArrayVariant 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)

Parameters:

i_item_res_dimensions (tuple) –

Return type:

None

property visu_mode: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property VisuMode() As CATArrangementItemResVisuMode

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

Returns:

enum cat_arrangement_item_res_visu_mode

Return type:

int

property x_length: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property XLength() As double

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

Return type:

float

property y_length: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property YLength() As double

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

Return type:

float