pycatia.arrangement_interfaces.arr_workbench

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.arr_workbench.ArrWorkbench(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
InfInterfaces.Workbench
ArrWorkbench

Returns the Arrangement Workbench.
Role: Use this interface to manage the ArrNomenclatureTree object, create
Arrangement objects (such as ArrangementArea, ArrangementRun
etc).
add_nomenclature_tree() → ArrNomenclatureTree

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddNomenclatureTree() As ArrNomenclatureTree

This method allows the user to add a nomenclature tree if the
get_ArrNomenclatureTree returns a Return code of E_FAIL. Basically, the
workbench could not locate the startup instance to generate the necessary
NomenclatureTree information.
Return type:

ArrNomenclatureTree

property arr_nomenclature_tree: ArrNomenclatureTree

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ArrNomenclatureTree() As ArrNomenclatureTree (Read
Only)

Returns the ArrNomenclatureTree.
Return type:

ArrNomenclatureTree

convert_arrangement_product_to_product(i_arr_product: ArrangementProduct) → Product

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ConvertArrangementProductToProduct(ArrangementProduct iArrProduct) As
Product

This method converts an ArrangementProduct back to a
Product.

Parameters:

iArrProduct
Input ArrangementProduct to be converted.

Returns:
oProduct As CATIAProduct Converted Product.
See also:
Product
Parameters:

i_arr_product (ArrangementProduct) –

Return type:

Product

convert_product_to_arrangement_product(i_product: Product) → ArrangementProduct

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ConvertProductToArrangementProduct(Product iProduct) As
ArrangementProduct

This method converts a Product to an ArrangementProduct.

Parameters:

iProduct
Input Product to be converted.

Returns:
oArrProduct Converted ArrangementProduct.
See also:
Product
Parameters:

i_product (Product) –

Return type:

ArrangementProduct

find_interface(i_interface_name: str, i_object: AnyObject) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func FindInterface(CATBSTR iInterfaceName,
CATBaseDispatch iObject) As CATBaseDispatch

This method returns a interface handle as specified by the input interface
name and the input interface handle.

Dim interfaceFound As AnyObject
Set interfaceFound = CATIAArrWorkbench.FindInterface(“InterfaceNameToFind”,CATIAProduct_iObject)


Parameters:

iInterfaceName
interface name to search for (“CATIAxxxx”)
iObject
The object to search for the required interface.

Returns:
oInterfaceFound interface handle found
Parameters:

  • i_interface_name (str) –

  • i_object (AnyObject) –

Return type:

AnyObject