pycatia.manufacturing_interfaces.manufacturing_program

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_program.ManufacturingProgram(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
ManufacturingProgram

A ManufacturingProgram for a Manufacturing Document.
property activities: ManufacturingActivities

Note

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

Give the List of Activities linked to a Manufacturing
Program.

Example:
The following example returns the list of Activities ActivitiesList
linked to the manufacturing Program CurrentProgram

Set ActivitiesList = CurrentProgram.Activities
Return type:

MfgActivities

add_goto_point(i_point_name: str) → ManufacturingActivity

Note

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

Add a Goto Point Operation to a Manufacturing Program.

Example:
The following example create, inserts and sequences in Program
firstProgram a PTP point instruction GOTO1 to the Point wich alias
isMyPoint

Set GOTO1 = firstProgram.AddGotoPoint(MyPoint)
Parameters:

i_point_name (str) –

Return type:

ManufacturingActivity

add_goto_point_from_coordinates(i_x: float, i_y: float, i_z: float) → ManufacturingActivity

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddGotoPointfromCoordinates(double iX,
double iY,
double iZ) As ManufacturingActivity

Add a Goto Point Operation to a Manufacturing Program.

The coordinates you give as input for this method have to be expressed
into
the ‘Absolute Axis System’ not in the ‘Machining Axis System’ of the Part
Operation.

Example:
The following example create, inserts and sequences in Program
firstProgram a PTP point instruction GOTO1 to the Point wich coordinates
areX,Y,Z

Set GOTO1 = firstProgram.AddGotoPointfromCoordinates(X,Y,Z)
Parameters:

  • i_x (float) –

  • i_y (float) –

  • i_z (float) –

Return type:

ManufacturingActivity

add_pp_instruction(i_pp_instruction: str) → ManufacturingActivity

Note

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

Add a PP Instruction to a Manufacturing Program.

Example:
The following example create, inserts and sequences in Program
firstProgram a PP Instruction PPWORD1 with textPPWORD

Set PPWORD1 = firstProgram.AddPPInstruction(PPWORD)
Parameters:

i_pp_instruction (str) –

Return type:

ManufacturingActivity

add_rotabl(i_rotabl: str, i_sens: str, ival: float) → ManufacturingActivity

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddRotabl(CATBSTR iRotabl,
CATBSTR iSens,
double ival) As ManufacturingActivity

Add a Table Head Rotation instruction to a Manufacturing
Program.

Example:
The following example create, inserts and sequences in Program
firstProgram a Rotabl ROTABL1 with argumentMODE and
angleANGLE1

Set ROTABL1 = firstProgram.AddRotabl(MODE,ANGLE1)
Parameters:

  • i_rotabl (str) –

  • i_sens (str) –

  • ival (float) –

Return type:

ManufacturingActivity

add_tool_change(i_tool_name: str, i_tool_type: str, i_tool_catalog: str, i_num_syntaxe: int) → ManufacturingActivity

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddToolChange(CATBSTR iToolName,
CATBSTR iToolType,
CATBSTR iToolCatalog,
short iNumSyntaxe) As ManufacturingActivity

Add a Tool Change Operation to a Manufacturing Program.

Example:
The following example create, inserts and sequences in firstProgram a
Tool Change Instruction with specified toolMyTool of specified type ToolTypein
specified catalogToolCatalog

Set ToolChange1 = firstProgram.AddToolChange(MyTool,ToolType,ToolCatalog,Num)
Parameters:

  • i_tool_name (str) –

  • i_tool_type (str) –

  • i_tool_catalog (str) –

  • i_num_syntaxe (int) –

Return type:

ManufacturingActivity

add_tool_change_multiple_feeds(i_tool_name: str, i_tool_type: str, i_tool_catalog: str, i_num_fs_data: int, i_num_syntax: int) → ManufacturingActivity

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddToolChangeMultipleFeeds(CATBSTR iToolName,
CATBSTR iToolType,
CATBSTR iToolCatalog,
short iNumFSData,
short iNumSyntaxe) As ManufacturingActivity

Add a Tool Change Operation to a Manufacturing Program.

Example:
The following example create, inserts and sequences in firstProgram a
Tool Change Instruction with specified toolMyTool of specified type ToolTypein
specified catalogToolCatalog

Set ToolChange1 = firstProgram.AddToolChangeMultipleFeeds(MyTool,ToolType,ToolCatalog,NumFSData,Num)
Parameters:

  • i_tool_name (str) –

  • i_tool_type (str) –

  • i_tool_catalog (str) –

  • i_num_fs_data (int) –

  • i_num_syntax (int) –

Return type:

ManufacturingActivity

append_operation(type: str, auto_sequence: int) → ManufacturingOperation

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AppendOperation(CATBSTR type,
short AutoSequence) As ManufacturingOperation

Create and Insert a Manufacturing Operation of a specified type to a
Manufacturing Program.
if AutoSequence is set to 1, the new operation will be sequenced in the
Program.

Example:
The following example creates, inserts and sequences in firstProgram the manufacturing operation ManufacturingOperation of type : type

Set ManufacturingOperation = firstProgram.AppendOperation(Type,1)
Parameters:

  • type (str) –

  • auto_sequence (int) –

Return type:

ManufacturingOperation

associate_output_code(i_file_name: str) → None

Note

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

Method is used for associate APT file to V4 program iFileName = path for APT file…. Call on V4 ManufacturingProgram
Parameters:

i_file_name (str) –

Return type:

None

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 Program.

Example:
The following example return the comment ProgramComment of to the
manufacturing Program CurrentProgram

Set CurrentProgram.Comment
Return type:

str

complete_with_polar_strategy(i_liste_mfg_activity: ManufacturingActivities, i_axe_ref: str, i_sens_rotation: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CompletewithPolarStrategy(MfgActivities
iListeMfgActivity,
CATBSTR iAxeRef,
CATBSTR iSensRotation)

Complete a list of Operation in a Manufacturing Program in Polar
Mode.

Example:
The following example complete in Program firstProgram a liste of
Operation ListeMo with Reference Axis A and sens CLW

Call
firstProgram.CompletewithPolarStrategy(ListeMo,A,CLW)
Parameters:

  • i_liste_mfg_activity (MfgActivities) –

  • i_axe_ref (str) –

  • i_sens_rotation (str) –

Return type:

None

create_mo_from_report(i_report_succeed: ExpertReportObjects, i_type_mo: str) → ManufacturingActivities

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateMOfromReport(ExpertReportObjects
iReportSucceed,
CATBSTR iTypeMo) As MfgActivities

Create a list of Operation in a Manufacturing Program, of a specified
type.

Example:
The following example create in Program firstProgram a liste of
Operation ListeMo with type Drilling from a CATIAExpertReportSucceedCollection
ReportSucceed.

Set ListeMO = firstProgram.CreateMOfromReport(ReportSucceed,Drilling)
Parameters:
Return type:

MfgActivities

get_nc_output_file() → str

Note

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

Get the output file (APT or ISO) associated to the program (if associated
during computation).
Return type:

str

get_table_current_absolute_position(i_activity_ref: ManufacturingActivity) → float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetTableCurrentAbsolutePosition(ManufacturingActivity iActivityRef) As
double

Get the current absolute position of the Machine Table.

Example:
The following example gets in Program firstProgram the current Machine
Table absolute position Angle from the Manufacturing activity reference
iActivityRef

Angle = firstProgram.GetTableCurrentAbsolutePosition(iActivityRef)
Parameters:

i_activity_ref (ManufacturingActivity) –

Return type:

float

import_nc_output_on_program(i_type: str, i_nc_output_file: str, i_pp_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ImportNCOutputOnProgram(CATBSTR iType,
CATBSTR iNCOutputFile,
CATBSTR iPPName)

Import an NC File on a program.

Example:
The following example imports in a Program firstProgram an NC File of
type TYPE available in the file path PATH using the PP PPNAME if
required.

Call firstProgram.ImportNCOutputOnProgram(TYPE,PATH,PPNAME)
Parameters:

  • i_type (str) –

  • i_nc_output_file (str) –

  • i_pp_name (str) –

Return type:

None

insert_operation(i_reference_operation: ManufacturingOperation, i_manufacturing_operation: ManufacturingOperation) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub InsertOperation(ManufacturingOperation
iReferenceOperation,
ManufacturingOperation iManufacturingOperation)

Insert an existing Manufacturing Operation to a Manufacturing
Program.

Example:
The following example inserts in firstProgram the manufacturing
operation ExistingOperation after ReferenceOperation:

call firstProgram.InsertOperation(ReferenceOperation,ExistingOperation)
Parameters:
Return type:

None

lock_activities_within_program() → None

Note

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

Method is used for Locking and Unloking all activity in program Call on
ManufacturingProgram on which Lock and Unlock want
Return type:

None

move_operation(i_reference_operation: ManufacturingActivity, i_manufacturing_operation: ManufacturingActivity) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub MoveOperation(ManufacturingActivity
iReferenceOperation,
ManufacturingActivity iManufacturingOperation)

Move an existing Manufacturing Operation to a Manufacturing
Program.

Example:
The following example moves in firstProgram the manufacturing operation
MovedOperation after the manufacturing
operationExistingOperation:

call firstProgram.MoveOperation(ExistingOperation,
MovedOperation)
Parameters:
Return type:

None

order_and_create_mo_from_report(i_report_succeed: ExpertReportObjects, i_type_mo: str, i_axe_rotabl: str, i_sens_rotation: str) → ManufacturingActivities

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func OrderAndCreateMOfromReport(ExpertReportObjects
iReportSucceed,
CATBSTR iTypeMo,
CATBSTR iAxeRotabl,
CATBSTR iSensRotation) As MfgActivities

Create a list of Operation in a Manufacturing Program, of a specified
type.

Example:
The following example create in Program firstProgram a liste of
Operation ListeMo with type Drilling from a CATIAExpertReportSucceedCollection
ReportSucceed with Rotabl of Axis A and sens CLW.

Set ListeMO = firstProgram.OrderAndCreateMOfromReport(ReportSucceed,Drilling)
Parameters:

  • i_report_succeed (ExpertReportObjects) –

  • i_type_mo (str) –

  • i_axe_rotabl (str) –

  • i_sens_rotation (str) –

Return type:

MfgActivities

unlock_activities_within_program() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub UnlockActivitesWithinProgram()
Return type:

None