pycatia.manufacturing_interfaces.manufacturing_setup

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.manufacturing_interfaces.manufacturing_setup.ManufacturingSetup(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
DMAPSInterfaces.Activity
ManufacturingInterfaces.ManufacturingActivity
ManufacturingSetup

A ManufacturingSetup for a Manufacturing Document.
property comment: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Comment() As CATBSTR

Return the Default Comment of a Manufacturing Setup.

Example:
The following example return the comment SetupComment of to the
manufacturing setup CurrentSetup

Set CurrentSetup.Comment
Return type:

str

create_machine(i_type_machine: str) → ManufacturingMachine

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateMachine(CATBSTR iTypeMachine) As
ManufacturingMachine

Initialise the Manufacturing Machine linked to a Manufacturing
Setup.

Example:
The following example initialise the machine
Mfg3AxisWithTableRotationMachine as Manufacturing Machine in the manufacturing
setup CurrentSetup

call CurrentSetup.CreateMachine(Mfg3AxisWithTableRotationMachine)
Parameters:

i_type_machine (str) –

Return type:

ManufacturingMachine

design_geometries_count() → int

Note

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

Returns the number of design geometries from a Manufacturing
Setup.

Parameters:

oDesignGeometriesListSize
The number of design geometries of this setup

Example:
The following example retrieves the number of design geometries of the
setup CurrentSetup in DesignGeometriesListSize.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim DesignGeometriesListSize As Long
DesignGeometriesListSize = CurrentSetup.DesignGeometriesCount
Return type:

int

export_cat_setting(dir_path: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ExportCATSetting(CATBSTR dirPath)

ExportCATSetting. Export All Machining CATSetting file to a location in xml format.
dirPath = Absolute path to the location where all settings should be exported.
eg, “D:/dir/” Call on Current Manufacturngsetup
Parameters:

dir_path (str) –

Return type:

None

fixture_geometries_count() → int

Note

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

Returns the number of fixture geometries from a Manufacturing
Setup.

Parameters:

oFixtureGeometriesListSize
The number of fixture geometries of this setup

Example:
The following example retrieves the number of fixture geometries of the
setup CurrentSetup in FixtureGeometriesListSize.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim FixtureGeometriesListSize As Long
FixtureGeometriesListSize = CurrentSetup.FixtureGeometriesCount
Return type:

int

get_machining_axis_system_name() → str

Note

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

Retrieves the Name of the Machining Axis system from a Manufacturing
Setup.

Example:
The following example retrieves the Name of the Machining Axis
systemoMachiningAxisSystemName from the manufacturing setup
CurrentSetup

Set oMachiningAxisSystemName = CurrentSetup.GetMachiningAxisSystemName
Return type:

str

get_manufacturing_view() → ManufacturingView

Note

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

Retrieves the Manufacturing View from a Manufacturing
Setup.

Example:
The following example retrievec the Manufacturing View MfgView from the
manufacturing setup CurrentSetup

Set MfgView = CurrentSetup.GetManufacturingView
Return type:

ManufacturingView

get_part_name() → str

Note

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

Retrieves the Name of the Design Part from a Manufacturing
Setup.

Example:
The following example retrieves the Name of the Design PartoPartName
from the manufacturing setup CurrentSetup

Set oPartName = CurrentSetup.GetPartName
Return type:

str

get_product_instance() → Product

Note

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

Give the Product of the ProductList linked to a Manufacturing
Setup.

Example:
The following example returns the Product linked to the manufacturing
setup CurrentSetup

Set Product = CurrentSetup.GetProductInstance
Return type:

Product

get_safety_plane() → tuple

Note

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

Retrieves the Safety Plane from a Manufacturing Setup.

Example:
The following example retrieves the Safety Plane oMathPLane from the
manufacturing setup CurrentSetup The size of oMathPlane is 9 (origin, first
direction, second direction)

Set oMathPlane= CurrentSetup.GetSafetyPlane
Return type:

tuple

get_stock_from_setup() → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetStockFromSetup(CATBSTR oStockPath)

Retrieves the path of the Stock file from a Manufacturing
Setup.

Example:
The following example retrieves the the path of the Stock
fileoStockPath from the manufacturing setup
CurrentSetup

call CurrentSetup.GetStockFromSetup(oStockPath)
Return type:

str

get_tool_change_point() → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetToolChangePoint(double oX,
double oY,
double oZ)

Get the ToolChange point of the machine linked to a Manufacturing
Setup.

Example:
The following example gets the point with coordinates X,Y,Z as
ToolChangePoint in the manufacturing setup
CurrentSetup

call CurrentSetup.GetToolChangePoint(X,Y,Z)
Return type:

tuple

import_cat_setting(xml_file_path: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ImportCATSetting(CATBSTR XMLFilePath)

ImportCATSetting. Import the CATSetting in xml format from a specified location.
XMLFilePath = Path to the xml file.
eg, “D:/dirs/settings.xml” Call on Current Manufacturngsetup
Parameters:

xml_file_path (str) –

Return type:

None

in_process_model_bodies_count() → int

Note

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

Returns the number of In Process Model Bodies from a Manufacturing
Setup.

Parameters:

oIPMBodiesListSize
The number of In Process Model Bodies of this setup


Example:
The following example retrieves the number of In Process Model Bodies
of the setup CurrentSetup in IPMBodiesListSize.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim IPMBodiesListSize As Long
IPMBodiesListSize = CurrentSetup.InProcessModelBodiesCount
Return type:

int

list_design_geometries(o_list_of_design_geometries: tuple) → cat_variant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListDesignGeometries(CATSafeArrayVariant
oListOfDesignGeometries)

Retrieves the design geometries list from a Manufacturing Setup. Each of
these geometries may be either a Product or a Body.

Parameters:

oListOfDesignGeometries
The retrieved list.
The array must be previously initialized using the


DesignGeometriesCount method.

Example:
The following example retrieves the design geometries list of the
manufacturing setup CurrentSetup in
ListOfDesignGeometries.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim DesignGeometriesListSize As Long
DesignGeometriesListSize = CurrentSetup.DesignGeometriesCount
If DesignGeometriesListSize > 0 Then
Dim ListOfDesignGeometries() As Variant
Redim
ListOfDesignGeometries(DesignGeometriesListSize-1)
CurrentSetup.ListDesignGeometries(ListOfDesignGeometries)
End If
Parameters:

o_list_of_design_geometries (tuple) –

Return type:

cat_variant

list_design_geometries_products(o_list_of_design_geometries_products: tuple) → cat_variant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListDesignGeometriesProducts(CATSafeArrayVariant
oListOfDesignGeometriesProducts)

Retrieves the design geometries products list from a Manufacturing Setup.
Each of these geometries may be either a Product or a
Body.

Parameters:

oListOfDesignGeometriesProducts
The retrieved list.
The array must be previously initialized using the

DesignGeometriesCount method.

Example:
The following example retrieves the design geometries list of the
manufacturing setup CurrentSetup in
ListOfDesignGeometriesProducts.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim DesignGeometriesListSize As Long
DesignGeometriesListSize = CurrentSetup.DesignGeometriesCount
If DesignGeometriesListSize > 0 Then
Dim ListOfDesignGeometries() As Variant
Redim
ListOfDesignGeometries(DesignGeometriesListSize-1)
CurrentSetup.ListDesignGeometriesProducts(ListOfDesignGeometriesProducts)
End If
Parameters:

o_list_of_design_geometries_products (tuple) –

Return type:

cat_variant

list_fixture_geometries(o_list_of_fixture_geometries: tuple) → cat_variant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListFixtureGeometries(CATSafeArrayVariant
oListOfFixtureGeometries)

Retrieves the fixture geometries list from a Manufacturing Setup. Each of
these geometries may be either a Product or a Body.

Parameters:

oListOfFixtureGeometries
The retrieved list.
The array must be previously initialized using the


FixtureGeometriesCount method.

Example:
The following example retrieves the fixture geometries list of the
manufacturing setup CurrentSetup in
ListOfFixtureGeometries.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim FixtureGeometriesListSize As Long
FixtureGeometriesListSize = CurrentSetup.FixtureGeometriesCount
If FixtureGeometriesListSize > 0 Then
Dim ListOfFixtureGeometries() As Variant
Redim
ListOfFixtureGeometries(FixtureGeometriesListSize-1)
CurrentSetup.ListFixtureGeometries(ListOfFixtureGeometries)
End If
Parameters:

o_list_of_fixture_geometries (tuple) –

Return type:

cat_variant

list_fixture_geometries_products(o_list_of_fixture_geometries_products: tuple) → cat_variant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListFixtureGeometriesProducts(CATSafeArrayVariant
oListOfFixtureGeometriesProducts)

Retrieves the Fixture geometries products list from a Manufacturing Setup.
Each of these geometries may be either a Product or a
Body.

Parameters:

oListOfFixtureGeometriesProducts
The retrieved list.
The array must be previously initialized using the

FixtureGeometriesCount method.

Example:
The following example retrieves the Fixture geometries list of the
manufacturing setup CurrentSetup in
ListOfFixtureGeometriesProducts.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim FixtureGeometriesListSize As Long
FixtureGeometriesListSize = CurrentSetup.FixtureGeometriesCount
If FixtureGeometriesListSize > 0 Then
Dim ListOfFixtureGeometries() As Variant
Redim
ListOfFixtureGeometries(FixtureGeometriesListSize-1)
CurrentSetup.ListFixtureGeometriesProducts(ListOfFixtureGeometriesProducts)
End If
Parameters:

o_list_of_fixture_geometries_products (tuple) –

Return type:

cat_variant

list_in_process_model_bodies(o_list_of_ipm_bodies: tuple) → cat_variant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListInProcessModelBodies(CATSafeArrayVariant
oListOfIPMBodies)

Retrieves the In Process Model Bodies list from a Manufacturing
Setup.

Parameters:

oListOfIPMBodies
The retrieved list.
The array must be previously initialized using the

InProcessModelBodiesCount method.

Example:
The following example retrieves the In Process Model Bodies list of the
manufacturing setup CurrentSetup in ListOfIPMBodies.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim IPMBodiesListSize As Long
IPMBodiesListSize = CurrentSetup.InProcessModelBodiesCount
If IPMBodiesListSize > 0 Then
Dim ListOfIPMBodies() As Variant
Redim ListOfIPMBodies(IPMBodiesListSize-1)
CurrentSetup.ListInProcessModelBodies(ListOfIPMBodies)
End If
Parameters:

o_list_of_ipm_bodies (tuple) –

Return type:

cat_variant

list_stock_geometries(o_list_of_stock_geometries: tuple) → cat_variant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListStockGeometries(CATSafeArrayVariant
oListOfStockGeometries)

Retrieves the stock geometries list from a Manufacturing Setup. Each of
these geometries may be either a Product or a Body.

Parameters:

oListOfStockGeometries
The retrieved list.
The array must be previously initialized using the


StockGeometriesCount method.

Example:
The following example retrieves the stock geometries list of the
manufacturing setup CurrentSetup in ListOfStockGeometries.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim StockGeometriesListSize As Long
StockGeometriesListSize = CurrentSetup.StockGeometriesCount
If StockGeometriesListSize > 0 Then
Dim ListOfStockGeometries() As Variant
Redim ListOfStockGeometries(StockGeometriesListSize-1)
CurrentSetup.ListStockGeometries(ListOfStockGeometries)
End If
Parameters:

o_list_of_stock_geometries (tuple) –

Return type:

cat_variant

list_stock_geometries_products(o_list_of_stock_geometries_products: tuple) → cat_variant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListStockGeometriesProducts(CATSafeArrayVariant
oListOfStockGeometriesProducts)

Retrieves the Stock geometries products list from a Manufacturing Setup.
Each of these geometries may be either a Product or a
Body.

Parameters:

oListOfStockGeometriesProducts
The retrieved list.
The array must be previously initialized using the

StockGeometriesCount method.

Example:
The following example retrieves the Stock geometries list of the
manufacturing setup CurrentSetup in
ListOfStockGeometriesProducts.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim StockGeometriesListSize As Long
StockGeometriesListSize = CurrentSetup.StockGeometriesCount
If StockGeometriesListSize > 0 Then
Dim ListOfStockGeometries() As Variant
Redim ListOfStockGeometries(StockGeometriesListSize-1)
CurrentSetup.ListStockGeometriesProducts(ListOfStockGeometriesProducts)
End If
Parameters:

o_list_of_stock_geometries_products (tuple) –

Return type:

cat_variant

property machine: ManufacturingMachine

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Machine() As ManufacturingMachine

Give the Machine linked to a Manufacturing Setup.

Example:
The following example returns the Machine linked to the manufacturing
setup CurrentSetup

Set Machine = CurrentSetup.Machine
Return type:

ManufacturingMachine

property machining_axis_system: ManufacturingMachiningAxis

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property MachiningAxisSystem() As
ManufacturingMachiningAxis

Retrieves the Machining Axis system from a Manufacturing
Setup.

Example:
The following example retrieves the Machining Axis system
oMachiningAxis from the manufacturing setup
CurrentSetup

Set oMachiningAxis = CurrentSetup.MachiningAxisSystem
Return type:

ManufacturingMachiningAxis

property product: None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Product(Product iProduct)

Associate the Product to a Manufacturing Setup.

Example:
The following example associates the Product iProduct to the
manufacturing setup CurrentSetup

CurrentSetup.Product = iProduct
Return type:

None

property programs: ManufacturingActivities

Note

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

Give the List of Programs linked to a Manufacturing Setup.

Example:
The following example returns the list of Programs ProgramsList linked
to the manufacturing Setup CurrentSetup

Set ProgramsList = CurrentSetup.Programs
Return type:

ManufacturingActivities

read_mfg_data(i_file_name: str, i_ncmillset: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ReadMfgData(CATBSTR iFileName,
CATSafeArrayVariant iNCMILLSET)

ReadMfgData. Read Manufacturing V4 data.
iFileName = Path for V4 product
iNCMILLSET = NC sets Acts Same as command “Read Manufacturing data from V4 model” | in NC Manufacturing Review workbench Call on Current Manufacturngsetup
Parameters:

  • i_file_name (str) –

  • i_ncmillset (tuple) –

Return type:

None

set_design_part(i_part: AnyObject, i_product: Product) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDesignPart(AnyObject iPart,
Product iProduct)

Associates the design part to a Manufacturing Setup.
The part must be a Body feature (Geometrical Set, Ordered Geometrical Set,
PartBody, Body.n)

Example:
The following example associates the part iPart belonging to the
Product iProduct to the manufacturing setup
CurrentSetup

call CurrentSetup.SetPart(iPart,iProduct)
Parameters:
Return type:

None

set_product_and_reconciliate(i_product: Product) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetProductAndReconciliate(Product iProduct)

Associate the Product to a Manufacturing Setup and reconciliate
links.

Example:
The following example associates the Product iProduct to the
manufacturing setup CurrentSetup

call CurrentSetup.SetProductAndReconciliate(iProduct)
Parameters:

i_product (Product) –

Return type:

None

set_safety_plane(i_safety_plane: AnyObject, i_product: Product) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSafetyPlane(AnyObject iSafetyPlane,
Product iProduct)

Associates a Safety Plane to a Manufacturing Setup.

Example:
The following example associates the Safety Plane iSafetyPlane
belonging to the Product iProduct to the manufacturing setup
CurrentSetup

call
CurrentSetup.SetSafetyPlane(iSafetyPlane,iProduct)
Parameters:
Return type:

None

set_stock(i_stock: AnyObject, i_product: Product) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetStock(AnyObject iStock,
Product iProduct)

Associates a stock to a Manufacturing Setup.
The stock must be either a Body feature (Geometrical Set, Ordered
Geometrical Set, PartBody, Body.n) either a CGR product.

Example:
The following example associates the stock iStock belonging to the
Product iProduct to the manufacturing setup
CurrentSetup

call CurrentSetup.SetStock(iStock,iProduct)
Parameters:
Return type:

None

set_tool_change_point(i_x: float, i_y: float, i_z: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetToolChangePoint(double iX,
double iY,
double iZ)

Initialise the ToolChange point of the machine linked to a Manufacturing
Setup.

Example:
The following example initialise the point with coordinates X,Y,Z as
ToolChangePoint in the manufacturing setup
CurrentSetup

call CurrentSetup.SetToolChangePoint(X,Y,Z)
Parameters:

  • i_x (float) –

  • i_y (float) –

  • i_z (float) –

Return type:

None

set_tool_change_point_by_name(i_point_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetToolChangePointByName(CATBSTR iPointName)

Initialise the ToolChange point of the machine linked to a Manufacturing
Setup.

Example:
The following example initialise the point PT23 as ToolChangePoint in
the manufacturing setup CurrentSetup

call CurrentSetup.SetToolChangePointByName(PT23)
Parameters:

i_point_name (str) –

Return type:

None

stock_geometries_count() → int

Note

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

Returns the number of stock geometries from a Manufacturing
Setup.

Parameters:

oStockGeometriesListSize
The number of stock geometries of this setup

Example:
The following example retrieves the number of stock geometries of the
setup CurrentSetup in StockGeometriesListSize.

Dim CurrentSetup As ManufacturingSetup
Set CurrentSetup = …
Dim StockGeometriesListSize As Long
StockGeometriesListSize = CurrentSetup.StockGeometriesCount
Return type:

int