pycatia.funct_system_interfaces.funct_actions_group

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.funct_system_interfaces.funct_actions_group.FunctActionsGroup(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

FunctActionsGroup

The interface to access a group of functional actions in a

system.

property actions_count: int

Note

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

o Property ActionsCount() As long (Read Only)

Get the count of actions referenced by the actions’ group.

Return type:

int

add(i_action: FunctionalAction) → None

Note

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

o Sub Add(FunctionalAction iAction)

Adds an action to the actions’ group.

Fails if the action :

is already in a group

has “From” and “To” extremities inconsistent with the existing actions.

In case of an ordered group, the added action will be

appended.

(i.e. for flows sequencing actions)

Parameters:

iAction

The action to be added to the group of actions.

Parameters:

i_action (FunctionalAction) –

Return type:

None

get_extremities(o_input_x: float, o_input_y: float, o_output_x: float, o_output_y: float) → None

Note

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

o Sub GetExtremities(double oInputX,

double oInputY,

double oOutputX,

double oOutputY)

Get coordinates of Input and Output extremities.

Parameters:

• o_input_x (float) –

• o_input_y (float) –

• o_output_x (float) –

• o_output_y (float) –

Return type:

None

remove(i_action: FunctionalAction) → None

Note

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

o Sub Remove(FunctionalAction iAction)

Removes an action from the actions’ group.

Parameters:

iAction

The action to be removed from the group of

actions.

Parameters:

i_action (FunctionalAction) –

Return type:

None

remove_position(i_position: int) → None

Note

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

o Sub RemovePosition(long iPosition)

Removes an action from the actions’ group.

Parameters:

iPosition

The position of the action to be removed from the group of

actions.

Parameters:

i_position (int) –

Return type:

None

retrieve(i_index: cat_variant) → FunctionalAction

Note

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

o Func Retrieve(CATVariant iIndex) As FunctionalAction

Returns an action using its index or its name from the actions

group.

Parameters:

iIndex

The index or the name of the action to retrieve from the group of

actions. As a numerics, this index is the rank of the action in the group. The

index of the first action in the group is 1, and the index of the last action

is Count. As a string, it is the name you assigned to the action using the

AnyObject.Name property.

Returns:

The retrieved action

Example:

This example retrieves in Obj1 the fifth action in the group and in

Obj2 the action named Valve.

Dim Act1 As FunctionalAction

Set Act1 = ActionsGrp.Retrieve(5)

Dim Act2 As FunctionalAction

Set Act2 = ActionsGrp.Retrieve(“Reduces noise”)

Parameters:

i_index (cat_variant) –

Return type:

FunctionalAction

set_extremities(i_input_x: float, i_input_y: float, i_output_x: float, i_output_y: float) → None

Note

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

o Sub SetExtremities(double iInputX,

double iInputY,

double iOutputX,

double iOutputY)

Set coordinates of Input and Output extremities.

Parameters:

• i_input_x (float) –

• i_input_y (float) –

• i_output_x (float) –

• i_output_y (float) –

Return type:

None