pycatia.manufacturing_interfaces.manufacturing_activity

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_activity.ManufacturingActivity(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

ManufacturingActivity

ManufacturingActivity defines a set of methods and mainly adds some specific

methods and services in Manufacturing on ProcessPlan

Activities.

Some methods have to be used carefully, they can have no meanly on a specific

Activity. This methods allows to support operation from other domain either

then Manufacturing.

property active: bool

Note

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

o Property Active() As boolean

Returns the activation state of the activity.

Returns:

oActive The activation state of the activity

Example:

The following example returns in bActive the activation state of the

activity firstActivity:

Dim firstActivity As ManufacturingActivity

Set firstActivity = …

Dim bActive As boolean

Set bActive = firstActivity.Active

Return type:

bool

get_attribute(i_attribut: str) → Parameter

Note

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

o Func GetAttribute(CATBSTR iAttribut) As Parameter

Retreive the Attribute of a Manufacturing Activity.

Example:

The following example retreives in RapidFeed the attribute MfgRapidFeed

of Manufacturing Activity firstActivity

Set RapidFeed = firstActivity.GetAttribute(MfgRapidFeed)

Parameters:

i_attribut (str) –

Return type:

Parameter

get_attribute_nls_name(i_attribut_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

Activity.

Parameters:

i_attribut_name (str) –

Return type:

str

get_list_of_feedrate_attributes(o_list_of_attributes: tuple) → None

Note

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

o Sub GetListOfFeedrateAttributes(CATSafeArrayVariant

oListOfAttributes)

Retrieve the list of Feedrate attributes of a Manufacturing

Activity.

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

Example:

The following example retrieves in oListOfAttributes the list of

feedrate attributes of the Manufacturing Activity

myActivity

call myActivity.GetListOfFeedrateAttributes(oListOfAttributes)

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

Activity.

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

Example:

The following example retrieves in oListOfAttributes the list of

Geometry attributes of the Manufacturing Activity

myActivity

call

myActivity.GetListOfGeomAttributes(oListOfAttributes)

Parameters:

o_list_of_attributes (tuple) –

Return type:

None

get_list_of_strategy_attributes(o_list_of_attributes: tuple) → None

Note

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

o Sub GetListOfStrategyAttributes(CATSafeArrayVariant

oListOfAttributes)

Retrieve the list of Strategy attributes of a Manufacturing

Activity.

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

Example:

The following example retrieves in oListOfAttributes the list of

Strategy attributes of the Manufacturing Activity

myActivity

call myActivity.GetListOfStrategyAttributes(oListOfAttributes)

Parameters:

o_list_of_attributes (tuple) –

Return type:

None

get_machining_direction(o_x_axis: float, o_y_axis: float, o_z_axis: float) → None

Note

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

o Sub GetMachiningDirection(double oXAxis,

double oYAxis,

double oZAxis)

Retreives the Machining Direction coordinates of a Manufacturing

Operation.

Parameters:

• o_x_axis (float) –

• o_y_axis (float) –

• o_z_axis (float) –

Return type:

None

get_tool_axis(o_x_axis: float, o_y_axis: float, o_z_axis: float) → None

Note

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

o Sub GetToolAxis(double oXAxis,

double oYAxis,

double oZAxis)

Retreives the ToolAxis coordinates of a Manufacturing

Activity.

Parameters:

• o_x_axis (float) –

• o_y_axis (float) –

• o_z_axis (float) –

Return type:

None

property machinable_feature: ManufacturingMachinableArea

Note

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

o Property MachinableFeature() As ManufacturingMachinableArea

Retrieve the machinable area of a Manufacturing Activity.

Example:

The following example retrieves in theMAF the machinable area of the

activity firstActivity.

Dim firstActivity As ManufacturingActivity

Set firstActivity = …

Dim theMAF As ManufacturingMachinableArea

Set theMAF = firstActivity.MachinableArea

Return type:

ManufacturingMachinableArea

property machining_time: float

Note

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

o Property MachiningTime() As double (Read Only)

Retreive the milling time of a Manufacturing Activity.

Example:

The following example retreives in theMachiningTime the time when the

tool meets the workpiece (in minutes).

theMachiningTime = firstActivity.MachiningTime

Return type:

float

property number_of_feedrate_attributes: int

Note

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

o Property NumberOfFeedrateAttributes() As short (Read Only)

This property returns the number of Feedrate attributes of a Manufacturing

Activity.

Return type:

int

property number_of_geom_attributes: int

Note

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

o Property NumberOfGeomAttributes() As short (Read Only)

This property returns the number of Geometry attributes of a Manufacturing

Activity.

Return type:

int

property number_of_strategy_attributes: int

Note

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

o Property NumberOfStrategyAttributes() As short (Read Only)

This property returns the number of Strategy attributes of a Manufacturing

Activity.

Return type:

int

property precedences: ManufacturingPrecedences

Note

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

o Property Precedences() As ManufacturingPrecedences (Read

Only)

This property returns the interface which manages the precedences on the

operation. These collection defines the list of precedences for a manufacturing

Activity.

Example:

The following example returns in precedences the interface that manage

the precedences for the myActivity Activity :

…

Set myActivity = …

Set precedences = myActivity.Precedences

Return type:

ManufacturingPrecedences

property representation: str

Note

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

o Property Representation() As CATBSTR

This property returns the path of the representation file for a

manufacturing Activity.

Return type:

str

set_machining_direction(i_x_axis: float, i_y_axis: float, i_z_axis: float) → None

Note

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

o Sub SetMachiningDirection(double iXAxis,

double iYAxis,

double iZAxis)

Defines the Machining Direction coordinates of a Manufacturing

Operation.

Parameters:

• i_x_axis (float) –

• i_y_axis (float) –

• i_z_axis (float) –

Return type:

None

set_tool_axis(i_x_axis: float, i_y_axis: float, i_z_axis: float) → None

Note

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

o Sub SetToolAxis(double iXAxis,

double iYAxis,

double iZAxis)

Defines the ToolAxis coordinates of a Manufacturing

Activity.

Parameters:

• i_x_axis (float) –

• i_y_axis (float) –

• i_z_axis (float) –

Return type:

None

property tool: ManufacturingTool

Note

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

o Property Tool() As ManufacturingTool (Read Only)

Retreive the Tool of a Manufacturing Activity.

Example:

The following example retreives in CurTool the manufacturing tool of

Manufacturing Activity firstActivity

Set CurTool = firstActivity.GetTool

Return type:

ManufacturingTool

property tool_assembly: ManufacturingToolAssembly

Note

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

o Property ToolAssembly() As ManufacturingToolAssembly (Read

Only)

Retreive the ToolAssembly of a Manufacturing Activity.

Example:

The following example retrieves in CurrAssembly the manufacturing tool

assembly of the manufacturing activity CurrActivity

Set CurrAssembly = CurrActivity.ToolAssembly

Return type:

ManufacturingToolAssembly

property total_time: float

Note

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

o Property TotalTime() As double (Read Only)

Retreive the total Time of a Manufacturing Activity.

Example:

The following example retreives in theTotalTime the total time of the

activity firstActivity (in minutes).

theTotalTime = firstActivity.TotalTime

Return type:

float

property video_result: str

Note

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

o Property VideoResult() As CATBSTR (Read Only)

Retreive the video result path of a Manufacturing Activity. The path is

empty if no video result.

Example:

The following example retreives in theVideoResult the video result of

the activity firstActivity (in minutes).

theVideoResult = firstActivity.VideoResult

Return type:

str