pycatia.manufacturing_interfaces.manufacturing_tool_assembly

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_assembly.ManufacturingToolAssembly(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

ManufacturingToolAssembly

Represents the tool assembly.

property assembly_type: str

Note

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

o Property AssemblyType() As CATBSTR (Read Only)

Returns the type of the tool assembly.

Legal values: the type of the tool assembly can be either

MfgMillAndDrillToolAssembly or MfgLatheToolAssembly.

Example:

The following example returns the assembly type Type of the assembly

CurrentAssembly:

Set Type=CurrentAssembly.AssemblyType

Return type:

str

property comment: str

Note

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

o Property Comment() As CATBSTR (Read Only)

Returns the default comment of a tool assembly.

Example:

The following example returns the comment Comment of the tool

assembly CurrentAssembly:

Comment=CurrentAssembly.Comment

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 iAttribute) As Parameter

Returns an attribute of a tool assembly.

The attribute is identified using its name, and is retrieved as a Parameter

object.

Parameters:

iAttribute

The attribute name

Returns:

The retrieved attribute

Example:

The following example retrieves in Diameter the attribute

MfgDiameter of the tool assembly CurrentAssembly:

Set Diameter = CurrentAssembly.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 iAttributeName) As

CATBSTR

Returns the NLS value of an attribute.

Parameters:

iAttributeName

The attribute name

Returns:

The attribute NLS value

Example:

The following example gives in NLSresult the NLS value of the

“MFG_COMMENT” attributes

of the tool assembly CurrentAssembly:

NLSresult = CurrentAssembly.GetAttributeNLSName(“MFG_COMMENT”)

Parameters:

i_attribute_name (str) –

Return type:

str

get_list_of_attribute_units(io_list_of_attribute_units: tuple) → None

Note

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

o Sub GetListOfAttributeUnits(CATSafeArrayVariant

ioListOfAttributeUnits)

Retrieves the list of attribute units of a tool assembly.

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

attributes of the assembly. When an attribute has no unit definition, the

corresponding unit item in the output array is a blank

string.

Parameters:

ioListOfAttributeUnits

The retrieved list of attributes units

Example:

The following example retrieves in TabAttributeUnits the list of

attribute units

of the tool assembly CurrentAssembly:

call CurrentAssembly.GetListOfAttributeUnits(TabAttributeUnits)

Parameters:

io_list_of_attribute_units (tuple) –

Return type:

None

get_list_of_attributes(io_list_of_attributes: tuple) → None

Note

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

o Sub GetListOfAttributes(CATSafeArrayVariant

ioListOfAttributes)

Retrieves the list of attributes of a tool assembly.

Each attribute retrieved as a Parameter object.

Parameters:

ioListOfAttributes

The retrieved list of attributes

Example:

The following example retrieves in TabAttributes the list of

attributes

of the tool assembly CurrentAssembly:

call

CurrentAssembly.GetListOfAttributes(TabAttributes)

Parameters:

io_list_of_attributes (tuple) –

Return type:

None

property insert: ManufacturingInsert

Note

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

o Property Insert() As ManufacturingInsert (Read Only)

Returns the insert of an assembly.

Example:

The following example retrieves in Insert the insert

of the assembly CurrentAssembly:

Set Insert = CurrentAssembly.Insert

Return type:

ManufacturingInsert

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)

Returns the number of attributes of a tool assembly.

Example:

The following example returns the Number of attributes of the tool

assembly CurrentAssembly:

Number = CurrentAssembly.NumberOfAttributes

Return type:

int

property tool: ManufacturingTool

Note

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

o Property Tool() As ManufacturingTool (Read Only)

Returns the tool of an assembly.

Example:

The following example retrieves in Tool the manufacturing tool

of the assembly CurrentAssembly:

Set Tool = CurrentAssembly.Tool

Return type:

ManufacturingTool

property tool_number: int

Note

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

o Property ToolNumber() As long (Read Only)

Returns the number linked to a tool assembly.

Example:

The following example returns the Number linked to the tool assembly

CurrentAssembly:

Number = CurrentAssembly.ToolNumber

Return type:

int