pycatia.manufacturing_interfaces.manufacturing_tool

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_tool.ManufacturingTool(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

ManufacturingTool

A ManufacturingTool for a Manufacturing Document.

add_corrector() → ManufacturingToolCorrector

Note

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

o Func AddCorrector() As ManufacturingToolCorrector

Adds a corrector to a Manufacturing tool.

Example:

The following example adds in Corr the tool corrector of Tool

CurrentTool

Set Corr = CurrentTool.AddCorrector

Return type:

ManufacturingToolCorrector

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 Default Comment of a Manufacturing Setup.

Example:

The following example return the comment ToolComment of to the

manufacturing tool CurrentTool

ToolComment=CurrentTool.Comment

Return type:

str

property corrector_count: int

Note

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

o Property CorrectorCount() As short (Read Only)

Retreive the number of correctors of a Manufacturing tool.

Example:

The following example retreives in CorrCount the number of tool

correctors of tool CurrentTool

Set NbCorr = CurrentTool.CorrectorCount

Return type:

int

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 by is name the attribute of a Manufacturing Tool.

Each attribute is a CKE object.

Example:

The following example retreives in Diameter the attribute MfgDiameter

of the Manufacturing Tool firstTool

Set Diameter = firstTool.GetAttribute(MfgDiameter)

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

Tool.

Parameters:

i_attribute_name (str) –

Return type:

str

get_corrector(index: int) → ManufacturingToolCorrector

Note

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

o Func GetCorrector(short index) As

ManufacturingToolCorrector

Retreive the corrector (index) of a Manufacturing tool.

Example:

The following example retreives in Corr the tool corrector of Tool

CurrentTool

Set Corr = CurrentTool.GetCorrector(index)

Parameters:

index (int) –

Return type:

ManufacturingToolCorrector

get_list_of_apt_parameters(o_list_of_apt_parameters: tuple) → None

Note

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

o Sub GetListOfAptParameters(CATSafeArrayVariant

oListOfAptParameters)

Retrieve the list of apt definition parameters of a Manufacturing

Tool.

Parameters are returned in an array of real values.

Parameters:

o_list_of_apt_parameters (tuple) –

Return type:

None

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 Manufacturing

Tool.

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

attributes of the tool.

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 Manufacturing Tool firstTool

call

firstTool.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 attributes of a Manufacturing Tool.

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

Example:

The following example retrieves in TabAttributes the list of attributes

of the Manufacturing Tool firstTool

call firstTool.GetListOfAttributes(TabAttributes)

Parameters:

o_list_of_attributes (tuple) –

Return type:

None

get_list_of_geom_attributes(o_list_of_attributes: tuple) → None

Note

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

o Sub GetListOfGeomAttributes(CATSafeArrayVariant

oListOfAttributes)

Retrieve the list of geometry attributes of a Manufacturing

Tool.

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

Example:

The following example retrieves in TabGeomAttributes the list of

geometry attributes of the Manufacturing Tool

firstTool

call firstTool.GetListOfGeomAttributes(TabAttributes)

Parameters:

o_list_of_attributes (tuple) –

Return type:

None

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)

Give the Number og attributes of a Manufacturing Tool.

Example:

The following example returns the Number of attributes of the

manufacturing Tool CurrentTool

Number = CurrentTool.NumberOfAttributes

Return type:

int

property picture: str

Note

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

o Property Picture() As CATBSTR (Read Only)

Return the path where a picture of the parametrized tool is

stored.

Example:

The following example return the path PicturePath where can be found

the picture of the tool CurrentTool

PicturePath=CurrentTool.Picture

Return type:

str

property tool_number: int

Note

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

o Property ToolNumber() As long (Read Only)

Give the Number linked to a Manufacturing Tool.

Example:

The following example returns the Number linked to the manufacturing

Tool CurrentTool

Number = CurrentTool.ToolNumber

Return type:

int

property tool_type: str

Note

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

o Property ToolType() As CATBSTR (Read Only)

Return the technological type of a the tool.

Example:

The following example return the tool type ToolType of to the

manufacturing tool CurrentTool

Set ToolType=CurrentTool.ToolType

Return type:

str