pycatia.manufacturing_interfaces.manufacturing_machine

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_machine.ManufacturingMachine(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

ManufacturingMachine

Machine in machining domain.

property comment: str

Note

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

o Property Comment() As CATBSTR (Read Only)

Return the Comment of a Machine.

Example:

The following example return the comment MachineComment of to the

manufacturing Machine CurrentMachine

MachineComment = CurrentMachine.Comment

Return type:

str

default_name() → str

Note

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

o Func DefaultName() As CATBSTR

Return the string the Type of a Machine.

Example:

The following example return the type MachineType of to the

manufacturing Machine CurrentMachine

MachineType = CurrentMachine.Type

Return type:

str

get_attribute(i_attribute: str) → Parameter

Note

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

o Func GetAttribute(CATBSTR iAttribut) As Parameter

Retrieve the Attribute of a Manufacturing Machine.

Example:

The following example retreives in HomePosX the attribute

MFG_HOME_POS_X of Manufacturing Machine MyMachine

Set HomePosX = MyMachine.GetAttribute(MFG_HOME_POS_X)

Parameters:

i_attribute (str) –

Return type:

Parameter

get_attribute_nls_name(i_attribute_name: str) → str

Note

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

o Func GetAttributeNLSName(CATBSTR iAttributName) As CATBSTR

Retrieve the NLS name from the attribute name of a Manufacturing

Machine.

Parameters:

i_attribute_name (str) –

Return type:

str

get_list_of_attribute_units(o_list_of_attribute_units: tuple) → None

Note

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

o Sub GetListOfAttributeUnits(CATSafeArrayVariant

oListOfAttributeUnits)

Retrieve the list of attribute units of a

ManufacturingMachine.

The number of items in the output array is equal to the number of

attributes of the machine.

When an attribute has no unit definition, the corresponding unit item in

the output array is a blank string.

Example:

The following example retrieves in TabAttributeUnits the list of

attribute units of the ManufacturingMachine

CurrentMachine

call CurrentMachine.GetListOfAttributeUnits(TabAttributeUnits)

Parameters:

o_list_of_attribute_units (tuple) –

Return type:

None

get_list_of_attributes(o_list_of_attributes: tuple) → None

Note

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

o Sub GetListOfAttributes(CATSafeArrayVariant

oListOfAttributes)

Retrieve the list of all attributes of a

ManufacturingMachine.

Each attribute is returned as the name of a CKE object.

Example:

The following example retrieves in TabAttributes the list of attributes

of the ManufacturingMachine CurrentMachine

call

CurrentMachine.GetListOfAttributes(TabAttributes)

Parameters:

o_list_of_attributes (tuple) –

Return type:

None

get_list_of_numerical_control_attributes(o_list_of_attributes: tuple) → None

Note

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

o Sub GetListOfNumericalControlAttributes(CATSafeArrayVariant

oListOfAttributes)

Retrieve the list of Numerical Control attributes of a Manufacturing

Machine.

Each attribute is returned as the name of a CKE object.

Example:

The following example retrieves in oListOfAttributes the list of

Numerical Control attributes of the Manufacturing Machine

myMachine

call myMachine.GetListOfNumericalControlAttributes(oListOfAttributes)

Parameters:

o_list_of_attributes (tuple) –

Return type:

None

get_list_of_rotary_table_attributes(o_list_of_attributes: tuple) → None

Note

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

o Sub GetListOfRotaryTableAttributes(CATSafeArrayVariant

oListOfAttributes)

Retrieve the list of Rotary table attributes of a Manufacturing

Machine.

Each attribute is returned as the name of a CKE object.

Example:

The following example retrieves in oListOfAttributes the list of Tool

Change attributes of the Manufacturing Machine

myMachine

call myMachine.GetListOfRotaryTableAttributes(oListOfAttributes)

Parameters:

o_list_of_attributes (tuple) –

Return type:

None

get_list_of_spindle_attributes(o_list_of_attributes: tuple) → None

Note

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

o Sub GetListOfSpindleAttributes(CATSafeArrayVariant

oListOfAttributes)

Retrieve the list of Spindle attributes of a Manufacturing

Machine.

Each attribute is returned as the name of a CKE object.

Example:

The following example retrieves in oListOfAttributes the list of

Spindle attributes of the Manufacturing Machine

myMachine

call myMachine.GetListOfSpindleAttributes(oListOfAttributes)

Parameters:

o_list_of_attributes (tuple) –

Return type:

None

get_list_of_tool_change_attributes(o_list_of_attributes: tuple) → None

Note

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

o Sub GetListOfToolChangeAttributes(CATSafeArrayVariant

oListOfAttributes)

Retrieve the list of Tool Change attributes of a Manufacturing

Machine.

Each attribute is returned as the name of a CKE object.

Example:

The following example retrieves in oListOfAttributes the list of Tool

Change attributes of the Manufacturing Machine

myMachine

call myMachine.GetListOfToolChangeAttributes(oListOfAttributes)

Parameters:

o_list_of_attributes (tuple) –

Return type:

None

property machine_type: str

Note

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

o Property MachineType() As CATBSTR (Read Only)

Return the Type of a Machine.

Example:

The following example return the type MachineType of to the

manufacturing Machine CurrentMachine

MachineType = CurrentMachine.Type

Return type:

str

property number_of_attributes: int

Note

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

o Property NumberOfAttributes() As short (Read Only)

Gives the number of attributes of a ManufacturingMachine.

Example:

The following example returns the Number of attributes of the

ManufacturingMachine CurrentMachine

Number = CurrentMachine.NumberOfAttributes

Return type:

int

property number_of_numerical_control_attributes: int

Note

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

o Property NumberOfNumericalControlAttributes() As short (Read

Only)

This property returns the number of Numerical Control attributes of a

Manufacturing Machine.

Return type:

int

property number_of_rotary_table_attributes: int

Note

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

o Property NumberOfRotaryTableAttributes() As short (Read

Only)

This property returns the number of rotary table attributes of a

Manufacturing Machine. The machine is upposed to accept Rotary table (type is

Mfg3AxisWithTableRotationMachine).

Return type:

int

property number_of_spindle_attributes: int

Note

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

o Property NumberOfSpindleAttributes() As short (Read Only)

This property returns the number of Spindle attributes of a Manufacturing

Machine.

Return type:

int

property number_of_tool_change_attributes: int

Note

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

o Property NumberOfToolChangeAttributes() As short (Read

Only)

This property returns the number of Tool change attributes of a

Manufacturing Machine.

Return type:

int

property post_processor_file: str

Note

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

o Property PostProcessorFile() As CATBSTR

This property returns the post processor file of a Manufacturing Machine

Machine.PostProcessorFile

Return type:

str

property pp_table_name: str

Note

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

o Property PPTableName() As CATBSTR

Give the PPTableName linked to a Manufacturing Machine.

Example:

The following example returns the PPTableName ThisPPTable linked to the

Manufacturing Machine CurrentMachine

Set ThisPPTable = CurrentMachine.PPTableName

Return type:

str

property preferred_tool_catalog_name: str

Note

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

o Property PreferedToolCatalogName() As CATBSTR

Give the PreferedToolCatalogName linked to a Manufacturing

Machine.

Example:

The following example returns the PreferedToolCatalogName ThisCatalog

linked to the Manufacturing Machine CurrentMachine

Set ThisCatalog = CurrentMachine.PreferedToolCatalogName

Return type:

str

property rotary_axis: str

Note

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

o Property RotaryAxis() As CATBSTR

Give the MfgRotaryAxis linked to a Manufacturing Machine.

Example:

The following example returns the MfgRotaryAxis ThisAxis linked to the

Manufacturing Machine CurrentMachine

Set ThisAxis = CurrentMachine.RotaryAxis

Return type:

str

set_default_values() → None

Note

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

o Sub set_DefaultValues()

Initialise the Manufacturing Machine parameters.

Example:

The following example make the init of the parameter of the Machine

ThisMachine .

call ThisMachine.set_DefaultValues

Return type:

None