pycatia.arrangement_interfaces.arrangement_product

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_product.ArrangementProduct(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

ArrangementProduct

Use this object as a factory for Arrangement collection

objects.

Role: Use this interface to get access to the Arrangement collections (Areas,

Rectangles, ItemReservations, Runs, Pathways, Boundaries) aggregated a given

Product.

property arrangement_areas: ArrangementAreas

Note

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

o Property ArrangementAreas() As ArrangementAreas (Read Only)

Returns the collection of ArrangementAreas under the current

ArrangementProduct.

Example:

This example retrieves the ArrangementAreas collection, oArrAreas , for

the objArrProd1 ArrangementProduct object.

Dim oArrAreas As ArrangementAreas

Set oArrAreas = objArrProd1.Areas

Return type:

ArrangementAreas

property arrangement_boundaries: ArrangementBoundaries

Note

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

o Property ArrangementBoundaries() As ArrangementBoundaries (Read

Only)

Returns the collection of ArrangementBoundaries under the current

ArrangementProduct.

Example:

This example retrieves the ArrangementBoundaries collection,

oArrBoundaries , for the objArrProd1 ArrangementProduct

object.

Dim oArrBoundaries As ArrangementBoundaries

Set oArrBoundaries = objArrProd1.oArrObjType

Return type:

ArrangementBoundaries

property arrangement_item_reservations: ArrangementItemReservations

Note

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

o Property ArrangementItemReservations() As ArrangementItemReservations (Read

Only)

Returns the collection of ArrangementItemReservations under the current

ArrangementProduct.

Example:

This example retrieves the ArrangementItemReservations collection,

oArrItemReservations , for the objArrProd1 ArrangementProduct

object.

Dim oArrItemReservations As

ArrangementItemReservations

Set oArrItemReservations = objArrProd1.ItemReservations

Return type:

ArrangementItemReservations

property arrangement_pathways: ArrangementPathways

Note

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

o Property ArrangementPathways() As ArrangementPathways (Read

Only)

Returns the collection of ArrangementPathways under the current

ArrangementProduct.

Example:

This example retrieves the ArrangementPathways collection, oArrPathways

, for the objArrProd1 ArrangementProduct object.

Dim oArrPathways As ArrangementPathways

Set oArrPathways = objArrProd1.Pathways

Return type:

ArrangementPathways

property arrangement_rectangles: ArrangementRectangles

Note

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

o Property ArrangementRectangles() As ArrangementRectangles (Read

Only)

Returns the collection of ArrangementRectangles under the current

ArrangementProduct.

Example:

This example retrieves the ArrangementRectangles collection,

oArrRectangles , for the objArrProd1 ArrangementProduct

object.

Dim oArrRectangles As ArrangementRectangles

Set oArrRectangles = objArrProd1.Rectangles

Return type:

ArrangementRectangles

property arrangement_runs: ArrangementRuns

Note

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

o Property ArrangementRuns() As ArrangementRuns (Read Only)

Returns the collection of ArrangementRuns under the current

ArrangementProduct.

Example:

This example retrieves the ArrangementRuns collection, oArrRuns , for

the objArrProd1 ArrangementProduct object.

Dim oArrRuns As ArrangementRuns

Set oArrRuns = objArrProd1.Runs

Return type:

ArrangementRuns

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 product’s applicative data which 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

objArrProd1 object.

Dim objProd As Product

objProd = objArrProd1.GetTechnologicalObject(“Product”)

Parameters:

i_application_type (str) –

Return type:

AnyObject

set_arrangement_nomenclature(i_nomenclature: str) → None

Note

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

o Sub SetArrangementNomenclature(CATBSTR iNomenclature)

Sets the nomenclature of the ArrangementProduct.

Returns:

An HRESULT value.

Legal values:

S_OK

operation is successful

E_FAIL

operation failed

Example:

This example sets the ArrangementNomenclature for objArrProd1

ArrangementProduct object.

objArrProd1.SetArrangementNomenclature = “Building”

Parameters:

i_nomenclature (str) –

Return type:

None

set_auto_name() → None

Note

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

o Sub SetAutoName()

Causes the name of the ArrangementProduct automatically.

Returns:

An HRESULT value.

Legal values:

S_OK

operation is successful

E_FAIL

operation failed

Example:

This example shows how the automatic naming of the objArrProd1

ArrangementProduct object can be done.

objArrProd1.SetAutoName

Return type:

None

property type: str

Note

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

o Property Type() As CATBSTR (Read Only)

Returns the Type of the ArrangementProduct in the form of a

String.

Example:

This example retrieves the type information as a string for the

objArrProd1 ArrangementProduct object.

Dim oArrObjType As String

oArrObjType = objArrProd1.Type

Return type:

str